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

Description

A modular component (i.e., node class or type) that is an add-on to the core Vuo framework.

Definition at line 17 of file VuoModule.hh.

Public Member Functions

 VuoModule (string moduleKey)
 Creates a module. More...
 
string getModuleKey (void)
 Returns this module's unique name. More...
 
void setModuleKey (string moduleKey)
 Sets this module's unique name. More...
 
string getDefaultTitle (void)
 Returns the default title for instances of this module, as specified by the .vuonode/.bc implementation. More...
 
string getDefaultTitleWithoutSuffix (void)
 Returns the default title, with the optional parenthetical suffix removed. More...
 
void setDefaultTitle (string defaultTitle)
 Sets the default title for instances of this module. More...
 
string getDescription (void)
 Returns the description given in the module's metadata, or if none is given, the description found in a separate file in the module's node set. More...
 
void setDescription (string description)
 Sets the description of this module provided as documentation. More...
 
string getVersion (void)
 Returns the module's version, in Semantic Versioning format. More...
 
void setVersion (string version)
 Sets the module's version, in Semantic Versioning format. More...
 
vector< string > getKeywords (void)
 Returns a list of the module's keywords. More...
 
void setKeywords (vector< string > keywords)
 Sets the module's keywords. More...
 
VuoNodeSetgetNodeSet (void)
 Returns the node set containing this module. More...
 
void setNodeSet (VuoNodeSet *nodeSet)
 Sets the node set containing this module. More...
 

Constructor & Destructor Documentation

◆ VuoModule()

VuoModule::VuoModule ( string  moduleKey)

Creates a module.

Parameters
moduleKeyA unique name for this module.

Definition at line 18 of file VuoModule.cc.

Member Function Documentation

◆ getDefaultTitle()

string VuoModule::getDefaultTitle ( void  )

Returns the default title for instances of this module, as specified by the .vuonode/.bc implementation.

Needn't be unique.

UTF-8.

Example:
Less Than
See also
VuoModuleMetadata

Definition at line 59 of file VuoModule.cc.

◆ getDefaultTitleWithoutSuffix()

string VuoModule::getDefaultTitleWithoutSuffix ( void  )

Returns the default title, with the optional parenthetical suffix removed.

UTF-8.

Example:

If getDefaultTitle() returns Select Event Output (Boolean), getDefaultTitleWithoutSuffix() returns Select Event Output.

See also
VuoModuleMetadata

Definition at line 75 of file VuoModule.cc.

◆ getDescription()

string VuoModule::getDescription ( void  )

Returns the description given in the module's metadata, or if none is given, the description found in a separate file in the module's node set.

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

See also
VuoModuleMetadata

Definition at line 107 of file VuoModule.cc.

◆ getKeywords()

vector< string > VuoModule::getKeywords ( void  )

Returns a list of the module's keywords.

See also
VuoModuleMetadata

Definition at line 153 of file VuoModule.cc.

◆ getModuleKey()

string VuoModule::getModuleKey ( void  )

Returns this module's unique name.

Definition at line 37 of file VuoModule.cc.

◆ getNodeSet()

VuoNodeSet * VuoModule::getNodeSet ( void  )

Returns the node set containing this module.

Definition at line 171 of file VuoModule.cc.

◆ getVersion()

string VuoModule::getVersion ( void  )

Returns the module's version, in Semantic Versioning format.

See also
VuoModuleMetadata

Definition at line 133 of file VuoModule.cc.

◆ setDefaultTitle()

void VuoModule::setDefaultTitle ( string  defaultTitle)

Sets the default title for instances of this module.

Needn't be unique.

UTF-8.

Example:
Less Than
See also
VuoModuleMetadata

Definition at line 94 of file VuoModule.cc.

◆ setDescription()

void VuoModule::setDescription ( string  description)

Sets the description of this module provided as documentation.

See also
VuoModuleMetadata

Definition at line 123 of file VuoModule.cc.

◆ setKeywords()

void VuoModule::setKeywords ( vector< string >  keywords)

Sets the module's keywords.

See also
VuoModuleMetadata

Definition at line 163 of file VuoModule.cc.

◆ setModuleKey()

void VuoModule::setModuleKey ( string  moduleKey)

Sets this module's unique name.

Definition at line 45 of file VuoModule.cc.

◆ setNodeSet()

void VuoModule::setNodeSet ( VuoNodeSet nodeSet)

Sets the node set containing this module.

Definition at line 179 of file VuoModule.cc.

◆ setVersion()

void VuoModule::setVersion ( string  version)

Sets the module's version, in Semantic Versioning format.

See also
VuoModuleMetadata

Definition at line 143 of file VuoModule.cc.


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