This class represents a node set, which is a set of node classes and supporting files grouped together in an archive.
Definition at line 20 of file VuoNodeSet.hh.
Public Member Functions | |
string | getArchivePath (void) |
Returns the POSIX path to this node set's archive file. | |
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 > | getHeaderPaths (void) |
Returns the relative paths 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 | getModuleSourcePath (const string &moduleKey) |
Returns the relative path of a module source file within this node set. | |
string | getFileContents (const string &relativePath) |
Returns the contents of the file at relativePath 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 VuoNodeSet * | createNodeSetForModule (VuoFileUtilities::File *moduleFile) |
Creates a VuoNodeSet for the archive that contains the given file. | |
|
static |
Creates a VuoNodeSet for the archive that contains the given file.
If the given file is not contained by an archive, returns null.
Definition at line 26 of file VuoNodeSet.cc.
void VuoNodeSet::extractDocumentationResources | ( | string | destinationDir | ) |
Extracts the resources (images, etc.) for the documentation from the node set archive.
Definition at line 228 of file VuoNodeSet.cc.
void VuoNodeSet::extractExampleCompositionResources | ( | string | destinationDir | ) |
Extracts the resources (images, etc.) for the example compositions from the node set archive.
Definition at line 220 of file VuoNodeSet.cc.
string VuoNodeSet::getArchivePath | ( | void | ) |
Returns the POSIX path to this node set's archive file.
Definition at line 37 of file VuoNodeSet.cc.
string VuoNodeSet::getDescription | ( | void | ) |
Returns this node set's description.
If this node set doesn't have a description, returns an empty string.
Definition at line 79 of file VuoNodeSet.cc.
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.
Definition at line 89 of file VuoNodeSet.cc.
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.
Definition at line 212 of file VuoNodeSet.cc.
vector< string > VuoNodeSet::getExampleCompositionFileNames | ( | void | ) |
Returns the file names of the example compositions within this node set, in lexicographic order.
Definition at line 142 of file VuoNodeSet.cc.
string VuoNodeSet::getFileContents | ( | const string & | relativePath | ) |
Returns the contents of the file at relativePath within this node set.
If the file doesn't exist, returns an empty string.
Definition at line 202 of file VuoNodeSet.cc.
vector< string > VuoNodeSet::getHeaderPaths | ( | void | ) |
Returns the relative paths of the header files within this node set.
Definition at line 122 of file VuoNodeSet.cc.
string VuoNodeSet::getModuleSourcePath | ( | const string & | moduleKey | ) |
Returns the relative path of a module source file within this node set.
If the file doesn't exist, returns an empty string.
Definition at line 168 of file VuoNodeSet.cc.
string VuoNodeSet::getName | ( | void | ) |
Returns a name for this node set, based on the node set archive file name.
Definition at line 45 of file VuoNodeSet.cc.
vector< string > VuoNodeSet::getNodeClassNames | ( | void | ) |
Returns the names of the node classes within this node set, in lexicographic order.
Definition at line 97 of file VuoNodeSet.cc.