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

Description

This class represents a node set, which is a set of node classes and supporting files grouped together in an archive.

Public Member Functions

string getName (void)
 Returns a name for this node set, based on the node set archive file name.
 
string getDescription (void)
 Returns this node set's description.
 
string getDescriptionForModule (VuoModule *module)
 Returns the description for the module if it's provided in a separate file within the node set.
 
vector< string > getNodeClassNames (void)
 Returns the names of the node classes within this node set, in lexicographic order.
 
vector< string > getHeaderFileNames (void)
 Returns the file names of the header files within this node set.
 
vector< string > getExampleCompositionFileNames (void)
 Returns the file names of the example compositions within this node set, in lexicographic order.
 
string getNodeClassContents (string nodeClassName)
 Returns the contents of a node class source file within this node set.
 
string getHeaderContents (string headerName)
 Returns the contents of a port type header file within this node set.
 
string getExampleCompositionContents (string exampleCompositionFileName)
 Returns the contents of an example composition within this node set.
 
void extractExampleCompositionResources (string destinationDir)
 Extracts the resources (images, etc.) for the example compositions from the node set archive.
 
void extractDocumentationResources (string destinationDir)
 Extracts the resources (images, etc.) for the documentation from the node set archive.
 

Static Public Member Functions

static VuoNodeSetcreateNodeSetForModule (VuoFileUtilities::File *moduleFile)
 Creates a VuoNodeSet for the archive that contains the given file.
 

Member Function Documentation

VuoNodeSet * VuoNodeSet::createNodeSetForModule ( VuoFileUtilities::File moduleFile)
static

Creates a VuoNodeSet for the archive that contains the given file.

If the given file is not contained by an archive, returns null.

void VuoNodeSet::extractDocumentationResources ( string  destinationDir)

Extracts the resources (images, etc.) for the documentation from the node set archive.

void VuoNodeSet::extractExampleCompositionResources ( string  destinationDir)

Extracts the resources (images, etc.) for the example compositions from the node set archive.

string VuoNodeSet::getDescription ( void  )

Returns this node set's description.

If this node set doesn't have a description, returns an empty string.

string VuoNodeSet::getDescriptionForModule ( VuoModule module)

Returns the description for the module if it's provided in a separate file within the node set.

Otherwise, returns an empty string.

string VuoNodeSet::getExampleCompositionContents ( string  exampleCompositionFileName)

Returns the contents of an example composition within this node set.

If the example composition doesn't exist, returns an empty string.

vector< string > VuoNodeSet::getExampleCompositionFileNames ( void  )

Returns the file names of the example compositions within this node set, in lexicographic order.

string VuoNodeSet::getHeaderContents ( string  headerName)

Returns the contents of a port type header file within this node set.

If the file doesn't exist, returns an empty string.

vector< string > VuoNodeSet::getHeaderFileNames ( void  )

Returns the file names of the header files within this node set.

string VuoNodeSet::getName ( void  )

Returns a name for this node set, based on the node set archive file name.

string VuoNodeSet::getNodeClassContents ( string  nodeClassName)

Returns the contents of a node class source file within this node set.

If the file doesn't exist, returns an empty string.

vector< string > VuoNodeSet::getNodeClassNames ( void  )

Returns the names of the node classes within this node set, in lexicographic order.


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