VuoCompilerGraphvizParser Class Reference

Description

Parses nodes and cables from a .vuo composition file.

Public Member Functions
vector< VuoNode * >	getNodes (void)
	Returns a list of all the nodes in this composition in the order they were listed in the .vuo file, excluding any psuedo-nodes of class vuo.in or vuo.out.
vector< VuoCable * >	getCables (void)
	Returns a list of all the cables in this composition in the order they were listed in the .vuo file, excluding any pseudo-cables connected to pseudo-nodes of class vuo.in or vuo.out.
vector< VuoPublishedPort * >	getPublishedInputPorts (void)
	Returns a consistently-ordered list of all published input ports in this composition.
vector< VuoPublishedPort * >	getPublishedOutputPorts (void)
	Returns a consistently-ordered list of all published output ports in this composition.
string	getName (void)
	Returns the composition's title.
string	getDescription (void)
	Returns the composition's description.
string	getCopyright (void)
	Returns the composition's copyright.

Static Public Member Functions
static VuoCompilerGraphvizParser *	newParserFromCompositionFile (const std::string &path, VuoCompiler *compiler=NULL)
	Parses the .vuo file at path, using the node classes provided by the compiler.
static VuoCompilerGraphvizParser *	newParserFromCompositionString (const string &composition, VuoCompiler *compiler=NULL)
	Parses a .vuo-formatted string, using the node classes provided by the compiler.
static set< std::string >	getNodeClassNamesFromCompositionFile (const string &path, VuoCompiler *compiler)
	Parses just the node class names from the .vuo file at path.

Member Function Documentation

vector< VuoCable * > VuoCompilerGraphvizParser::getCables

(

void

)

Returns a list of all the cables in this composition in the order they were listed in the .vuo file, excluding any pseudo-cables connected to pseudo-nodes of class vuo.in or vuo.out.

string VuoCompilerGraphvizParser::getCopyright

(

void

)

Returns the composition's copyright.

string VuoCompilerGraphvizParser::getDescription

(

void

)

Returns the composition's description.

string VuoCompilerGraphvizParser::getName

(

void

)

Returns the composition's title.

set< string > VuoCompilerGraphvizParser::getNodeClassNamesFromCompositionFile ( const string &  path, VuoCompiler *  compiler  )

static

Parses just the node class names from the .vuo file at path.

Exceptions

std::runtime_error	Couldn't read the composition file.
VuoCompilerException	Couldn't parse the composition.

vector< VuoNode * > VuoCompilerGraphvizParser::getNodes

(

void

)

Returns a list of all the nodes in this composition in the order they were listed in the .vuo file, excluding any psuedo-nodes of class vuo.in or vuo.out.

vector< VuoPublishedPort * > VuoCompilerGraphvizParser::getPublishedInputPorts

(

void

)

Returns a consistently-ordered list of all published input ports in this composition.

vector< VuoPublishedPort * > VuoCompilerGraphvizParser::getPublishedOutputPorts

(

void

)

Returns a consistently-ordered list of all published output ports in this composition.

VuoCompilerGraphvizParser * VuoCompilerGraphvizParser::newParserFromCompositionFile ( const std::string &  path, VuoCompiler *  compiler = NULL  )

static

Parses the .vuo file at path, using the node classes provided by the compiler.

Exceptions

std::runtime_error	Couldn't read the composition file.
VuoCompilerException	Couldn't parse the composition.

VuoCompilerGraphvizParser * VuoCompilerGraphvizParser::newParserFromCompositionString ( const string &  composition, VuoCompiler *  compiler = NULL  )

static

Parses a .vuo-formatted string, using the node classes provided by the compiler.

Exceptions

VuoCompilerException

Couldn't parse the composition.

---

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

• compiler/VuoCompilerGraphvizParser.hh
• compiler/VuoCompilerGraphvizParser.cc