Description

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. More...

string	getName (void)
	Returns a name for this node set, based on the node set archive file name. More...

string	getDescription (void)
	Returns this node set's description. More...

string	getDescriptionForModule (VuoModule *module)
	Returns the description for the module if it's provided in a separate file within the node set. More...

vector< string >	getNodeClassNames (void)
	Returns the names of the node classes within this node set, in lexicographic order. More...

vector< string >	getHeaderFileNames (void)
	Returns the file names of the header files within this node set. More...

vector< string >	getExampleCompositionFileNames (void)
	Returns the file names of the example compositions within this node set, in lexicographic order. More...

string	getNodeClassContents (string nodeClassName)
	Returns the contents of a node class source file within this node set. More...

string	getHeaderContents (string headerName)
	Returns the contents of a port type header file within this node set. More...

string	getExampleCompositionContents (string exampleCompositionFileName)
	Returns the contents of an example composition within this node set. More...

void	extractExampleCompositionResources (string destinationDir)
	Extracts the resources (images, etc.) for the example compositions from the node set archive. More...

void	extractDocumentationResources (string destinationDir)
	Extracts the resources (images, etc.) for the documentation from the node set archive. More...

Static Public Member Functions
static VuoNodeSet *	createNodeSetForModule (VuoFileUtilities::File *moduleFile)
	Creates a VuoNodeSet for the archive that contains the given file. More...

Member Function Documentation

◆ createNodeSetForModule()

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.

Definition at line 26 of file VuoNodeSet.cc.

◆ extractDocumentationResources()

void VuoNodeSet::extractDocumentationResources ( string destinationDir )

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

Definition at line 206 of file VuoNodeSet.cc.

◆ extractExampleCompositionResources()

void VuoNodeSet::extractExampleCompositionResources ( string destinationDir )

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

Definition at line 198 of file VuoNodeSet.cc.

◆ getArchivePath()

string VuoNodeSet::getArchivePath ( void )

Returns the POSIX path to this node set's archive file.

Definition at line 37 of file VuoNodeSet.cc.

◆ getDescription()

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.

◆ getDescriptionForModule()

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.

◆ getExampleCompositionContents()

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 190 of file VuoNodeSet.cc.

◆ getExampleCompositionFileNames()

vector< string > VuoNodeSet::getExampleCompositionFileNames ( void )

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

Definition at line 144 of file VuoNodeSet.cc.

◆ getHeaderContents()

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.

Definition at line 180 of file VuoNodeSet.cc.

◆ getHeaderFileNames()

vector< string > VuoNodeSet::getHeaderFileNames ( void )

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

Definition at line 122 of file VuoNodeSet.cc.

◆ getName()

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.

◆ getNodeClassContents()

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.

Definition at line 170 of file VuoNodeSet.cc.

◆ getNodeClassNames()

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.

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

base/VuoNodeSet.hh
base/VuoNodeSet.cc