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...
VuoNodeSet *	getNodeSet (void)
	Returns the node set containing this module. More...
void	setNodeSet (VuoNodeSet *nodeSet)
	Sets the node set containing this module. More...
bool	isPro (void)
	Returns true if this is one of the Pro modules distributed with Vuo Pro. More...
void	setPro (bool pro)
	Sets whether this is one of the Pro modules distributed with Vuo Pro. More...

Constructor & Destructor Documentation

VuoModule()

VuoModule::VuoModule

(

string

moduleKey

)

Creates a module.

Parameters

moduleKey

A 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 50 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 66 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 98 of file VuoModule.cc.

getKeywords()

vector< string > VuoModule::getKeywords

(

void

)

Returns a list of the module's keywords.

See also

VuoModuleMetadata

Definition at line 144 of file VuoModule.cc.

getModuleKey()

string VuoModule::getModuleKey

(

void

)

Returns this module's unique name.

Definition at line 28 of file VuoModule.cc.

getNodeSet()

VuoNodeSet * VuoModule::getNodeSet

(

void

)

Returns the node set containing this module.

Definition at line 162 of file VuoModule.cc.

getVersion()

string VuoModule::getVersion

(

void

)

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

See also

VuoModuleMetadata

Definition at line 124 of file VuoModule.cc.

isPro()

bool VuoModule::isPro

(

void

)

Returns true if this is one of the Pro modules distributed with Vuo Pro.

Definition at line 178 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 85 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 114 of file VuoModule.cc.

setKeywords()

void VuoModule::setKeywords

(

vector< string >

keywords

)

Sets the module's keywords.

See also

VuoModuleMetadata

Definition at line 154 of file VuoModule.cc.

setModuleKey()

void VuoModule::setModuleKey

(

string

moduleKey

)

Sets this module's unique name.

Definition at line 36 of file VuoModule.cc.

setNodeSet()

void VuoModule::setNodeSet

(

VuoNodeSet *

nodeSet

)

Sets the node set containing this module.

Definition at line 170 of file VuoModule.cc.

setPro()

void VuoModule::setPro

(

bool

pro

)

Sets whether this is one of the Pro modules distributed with Vuo Pro.

Definition at line 186 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 134 of file VuoModule.cc.

---

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

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