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.
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 of this module provided as documentation.
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.

Constructor & Destructor Documentation

VuoModule::VuoModule

(

string

moduleKey

)

Creates a module.

Parameters

moduleKey

A 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 of this module provided as documentation.

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.

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::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:

• base/VuoModule.hh
• base/VuoModule.cc