Vuo  0.5.7
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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.

Public Member Functions

 VuoModule (string moduleKey)
 Creates a module.
 
string getModuleKey (void)
 Returns this module's unique name.
 
void setModuleKey (string moduleKey)
 Sets this module's unique name.
 
string getDefaultTitle (void)
 Returns the default title for instances of this module, as specified by the .vuonode/.bc implementation.
 
void setDefaultTitle (string defaultTitle)
 Sets the default title for instances of this module.
 
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.
 
void setDescription (string description)
 Sets the description of this module provided as documentation.
 
string getVersion (void)
 Returns the module's version, in Semantic Versioning format.
 
void setVersion (string version)
 Sets the module's version, in Semantic Versioning format.
 
vector< string > getKeywords (void)
 Returns a list of the module's keywords.
 
void setKeywords (vector< string > keywords)
 Sets the module's keywords.
 
VuoNodeSetgetNodeSet (void)
 Returns the node set containing this module.
 
void setNodeSet (VuoNodeSet *nodeSet)
 Sets the node set containing this module.
 

Constructor & Destructor Documentation

VuoModule::VuoModule ( string  moduleKey)

Creates a module.

Parameters
moduleKeyA unique name for this module.

Member Function Documentation

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
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
vector< string > VuoModule::getKeywords ( void  )

Returns a list of the module's keywords.

See Also
VuoModuleMetadata
string VuoModule::getModuleKey ( void  )

Returns this module's unique name.

VuoNodeSet * VuoModule::getNodeSet ( void  )

Returns the node set containing this module.

string VuoModule::getVersion ( void  )

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

See Also
VuoModuleMetadata
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
void VuoModule::setDescription ( string  description)

Sets the description of this module provided as documentation.

See Also
VuoModuleMetadata
void VuoModule::setKeywords ( vector< string >  keywords)

Sets the module's keywords.

See Also
VuoModuleMetadata
void VuoModule::setModuleKey ( string  moduleKey)

Sets this module's unique name.

void VuoModule::setNodeSet ( VuoNodeSet nodeSet)

Sets the node set containing this module.

void VuoModule::setVersion ( string  version)

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

See Also
VuoModuleMetadata

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