Vuo  2.3.2
Public Member Functions | Static Public Member Functions | List of all members
VuoCompilerGraphvizParser Class Reference

Description

Parses nodes and cables from a .vuo composition file.

Definition at line 35 of file VuoCompilerGraphvizParser.hh.

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. More...
 
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. More...
 
vector< VuoComment * > getComments (void)
 Returns a list of all the comments in this composition in the order they were listed in the .vuo file. More...
 
vector< VuoPublishedPort * > getPublishedInputPorts (void)
 Returns a consistently-ordered list of all published input ports in this composition. More...
 
vector< VuoPublishedPort * > getPublishedOutputPorts (void)
 Returns a consistently-ordered list of all published output ports in this composition. More...
 
VuoNodegetManuallyFirableInputNode (void)
 Returns the node containing the manually-firable input port, or null if none was specified in the .vuo file. More...
 
VuoPortgetManuallyFirableInputPort (void)
 Returns the manually-firable input port, or null if none was specified in the .vuo file. More...
 
VuoCompositionMetadatagetMetadata (void)
 Returns the composition metadata. More...
 

Static Public Member Functions

static VuoCompilerGraphvizParsernewParserFromCompositionFile (const string &path, VuoCompiler *compiler)
 Parses the .vuo file at path, using the node classes provided by the compiler. More...
 
static VuoCompilerGraphvizParsernewParserFromCompositionString (const string &composition, VuoCompiler *compiler)
 Parses a .vuo-formatted string, using the node classes provided by the compiler. More...
 
static set< string > getNodeClassNamesFromCompositionFile (const string &path)
 Parses just the node class names from the .vuo file at path. More...
 

Member Function Documentation

◆ getCables()

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.

Definition at line 1101 of file VuoCompilerGraphvizParser.cc.

◆ getComments()

vector< VuoComment * > VuoCompilerGraphvizParser::getComments ( void  )

Returns a list of all the comments in this composition in the order they were listed in the .vuo file.

Definition at line 1109 of file VuoCompilerGraphvizParser.cc.

◆ getManuallyFirableInputNode()

VuoNode * VuoCompilerGraphvizParser::getManuallyFirableInputNode ( void  )

Returns the node containing the manually-firable input port, or null if none was specified in the .vuo file.

Definition at line 1134 of file VuoCompilerGraphvizParser.cc.

◆ getManuallyFirableInputPort()

VuoPort * VuoCompilerGraphvizParser::getManuallyFirableInputPort ( void  )

Returns the manually-firable input port, or null if none was specified in the .vuo file.

Definition at line 1142 of file VuoCompilerGraphvizParser.cc.

◆ getMetadata()

VuoCompositionMetadata * VuoCompilerGraphvizParser::getMetadata ( void  )

Returns the composition metadata.

Definition at line 1150 of file VuoCompilerGraphvizParser.cc.

◆ getNodeClassNamesFromCompositionFile()

set< string > VuoCompilerGraphvizParser::getNodeClassNamesFromCompositionFile ( const string &  path)
static

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

Exceptions
VuoCompilerExceptionCouldn't read the composition file or couldn't parse the composition.

Definition at line 144 of file VuoCompilerGraphvizParser.cc.

◆ getNodes()

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.

Definition at line 1092 of file VuoCompilerGraphvizParser.cc.

◆ getPublishedInputPorts()

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

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

Definition at line 1118 of file VuoCompilerGraphvizParser.cc.

◆ getPublishedOutputPorts()

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

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

Definition at line 1126 of file VuoCompilerGraphvizParser.cc.

◆ newParserFromCompositionFile()

VuoCompilerGraphvizParser * VuoCompilerGraphvizParser::newParserFromCompositionFile ( const string &  path,
VuoCompiler compiler 
)
static

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

Exceptions
VuoCompilerExceptionCouldn't read the composition file or couldn't parse the composition.

Definition at line 57 of file VuoCompilerGraphvizParser.cc.

◆ newParserFromCompositionString()

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

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

Exceptions
VuoCompilerExceptionCouldn't parse the composition.

Definition at line 82 of file VuoCompilerGraphvizParser.cc.


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