Public Member Functions
	BlockDescriptionParser (void)
	Create an empty block description parser. More...

void	feedStream (std::istream &is)

void	feedFilePath (const std::string &filePath)

std::vector< std::string >	listFactories (void) const

std::string	getJSONArray (const size_t indent=0) const

std::string	getJSONObject (const std::string &factoryPath, const size_t indent=0) const

Detailed Description

Parse multiple sources for block description markup and manages the resulting JSON descriptions.

Constructor & Destructor Documentation

Pothos::Util::BlockDescriptionParser::BlockDescriptionParser ( void )

Create an empty block description parser.

void Pothos::Util::BlockDescriptionParser::feedFilePath ( const std::string & filePath )

Feed the parser a source file with embedded markup.

Parameters

filePath the path to a source file

Exceptions

SyntaxException	if the parsing failed
FileException	for file access errors

void Pothos::Util::BlockDescriptionParser::feedStream ( std::istream & is )

Feed the parser a source file with embedded markup.

Parameters

is	an input stream like an open file

Exceptions

SyntaxException if the parsing failed

std::string Pothos::Util::BlockDescriptionParser::getJSONArray ( const size_t indent = 0 ) const

Get a JSON array containing all block descriptions.

std::string Pothos::Util::BlockDescriptionParser::getJSONObject	(	const std::string &	factoryPath,
		const size_t	indent = `0`
	)		const

Get a JSON object for a single block description.

Parameters

factoryPath	a discovered factory path
indent	indentation level for formatting

std::vector<std::string> Pothos::Util::BlockDescriptionParser::listFactories ( void ) const

Get all factories that were discovered when parsing.

The documentation for this class was generated from the following file: