Vuo  0.6.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
VuoCompilerGraphvizParser Class Reference

Description

Parses nodes and edges 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
< VuoCompilerPublishedPort * > 
getPublishedInputPorts (void)
 Returns a consistently-ordered list of all published input ports in this composition.
 
vector
< VuoCompilerPublishedPort * > 
getPublishedOutputPorts (void)
 Returns a consistently-ordered list of all published output ports in this composition.
 
VuoNodegetPublishedInputNode (void)
 Returns the pseudo-node of class "vuo.in" in the composition, or null if the composition does not have one.
 
VuoNodegetPublishedOutputNode (void)
 Returns the pseudo-node of class "vuo.out" in the composition, or null if the composition does not have one.
 
vector< VuoCable * > getPublishedInputCables (void)
 Returns the pseudo-cables attached to the output ports of the published input psuedo-node, if any.
 
vector< VuoCable * > getPublishedOutputCables (void)
 Returns the pseudo-cables attached to the input ports of the published output psuedo-node, if any.
 
string getDescription (void)
 Returns the composition's description.
 

Static Public Member Functions

static VuoCompilerGraphvizParsernewParserFromCompositionFile (string path, VuoCompiler *compiler=NULL, set< VuoCompilerNodeClass * > extraNodeClasses=set< VuoCompilerNodeClass * >())
 Parse the .vuo file at path, using the node classes provided by the compiler.
 
static VuoCompilerGraphvizParsernewParserFromCompositionString (const string &composition, VuoCompiler *compiler=NULL, set< VuoCompilerNodeClass * > extraNodeClasses=set< VuoCompilerNodeClass * >())
 Parse a .vuo file, using the node classes provided by the compiler.
 
static string parseDescription (const string &compositionAsString)
 Parses the composition's description from the string.
 

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::getDescription ( void  )

Returns the composition's description.

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< VuoCable * > VuoCompilerGraphvizParser::getPublishedInputCables ( void  )

Returns the pseudo-cables attached to the output ports of the published input psuedo-node, if any.

VuoNode * VuoCompilerGraphvizParser::getPublishedInputNode ( void  )

Returns the pseudo-node of class "vuo.in" in the composition, or null if the composition does not have one.

vector< VuoCompilerPublishedPort * > VuoCompilerGraphvizParser::getPublishedInputPorts ( void  )

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

vector< VuoCable * > VuoCompilerGraphvizParser::getPublishedOutputCables ( void  )

Returns the pseudo-cables attached to the input ports of the published output psuedo-node, if any.

VuoNode * VuoCompilerGraphvizParser::getPublishedOutputNode ( void  )

Returns the pseudo-node of class "vuo.out" in the composition, or null if the composition does not have one.

vector< VuoCompilerPublishedPort * > VuoCompilerGraphvizParser::getPublishedOutputPorts ( void  )

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

VuoCompilerGraphvizParser * VuoCompilerGraphvizParser::newParserFromCompositionFile ( string  path,
VuoCompiler compiler = NULL,
set< VuoCompilerNodeClass * >  extraNodeClasses = set<VuoCompilerNodeClass *>() 
)
static

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

VuoCompilerGraphvizParser * VuoCompilerGraphvizParser::newParserFromCompositionString ( const string &  composition,
VuoCompiler compiler = NULL,
set< VuoCompilerNodeClass * >  extraNodeClasses = set<VuoCompilerNodeClass *>() 
)
static

Parse a .vuo file, using the node classes provided by the compiler.

string VuoCompilerGraphvizParser::parseDescription ( const string &  compositionAsString)
static

Parses the composition's description from the string.

The description is assumed to be in the 3rd line starting at the 3rd character, or at the 4th character if the line has a leading space.


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