VuoType Class Reference

Description

This base class represents the metadata of one type.

Definition at line 20 of file VuoType.hh.

Public Member Functions
	VuoType (string typeName)
	Creates a type. More...
virtual	~VuoType (void)
	to make this class dynamic_cast-able More...
Public Member Functions inherited from VuoBase< VuoCompilerType, void >
	VuoBase (string id)
	Creates a base class. More...
void	setCompiler (VuoCompilerType *compiler)
	Sets the base class instance's compiler detail class instance. More...
VuoCompilerType *	getCompiler (void) const
	Returns the base class instance's compiler detail class instance. More...
bool	hasCompiler (void) const
	Returns true if this base class instance has a compiler detail. More...
void	setRenderer (void *renderer)
	Sets the base class instance's renderer detail class instance. More...
void *	getRenderer (void) const
	Returns the base class instance's renderer detail class instance. More...
bool	hasRenderer (void) const
	Returns true if this base class instance has a renderer detail. More...
Public Member Functions inherited from VuoModule
	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...

Static Public Member Functions
static bool	isListTypeName (string typeName)
	Returns true if the type name is for a list type. More...
static bool	isDictionaryTypeName (string typeName)
	Returns true if the type name is for a dictionary type. More...
static string	extractInnermostTypeName (string typeName)
	If the type name is a list (or list of lists, etc.), returns the innermost item type name. More...

Static Public Attributes
static const string	listTypeNamePrefix = "VuoList_"
	The common beginning of all VuoList type names (before the item type name). More...
static const string	dictionaryTypeNamePrefix = "VuoDictionary_"
	The common beginning of all VuoDictionary type names (before the key and value type names). More...

Constructor & Destructor Documentation

VuoType()

VuoType::VuoType

(

string

typeName

)

Creates a type.

Parameters

typeName

A unique (across all types and node classes) name for this type.

Definition at line 26 of file VuoType.cc.

~VuoType()

VuoType::~VuoType ( void  )

virtual

to make this class dynamic_cast-able

Definition at line 32 of file VuoType.cc.

Member Function Documentation

extractInnermostTypeName()

string VuoType::extractInnermostTypeName ( string  typeName )

static

If the type name is a list (or list of lists, etc.), returns the innermost item type name.

Otherwise, returns the type name itself.

Definition at line 56 of file VuoType.cc.

isDictionaryTypeName()

bool VuoType::isDictionaryTypeName ( string  typeName )

static

Returns true if the type name is for a dictionary type.

Definition at line 47 of file VuoType.cc.

isListTypeName()

bool VuoType::isListTypeName ( string  typeName )

static

Returns true if the type name is for a list type.

Definition at line 39 of file VuoType.cc.

Member Data Documentation

dictionaryTypeNamePrefix

const string VuoType::dictionaryTypeNamePrefix = "VuoDictionary_"

static

The common beginning of all VuoDictionary type names (before the key and value type names).

Definition at line 27 of file VuoType.hh.

listTypeNamePrefix

const string VuoType::listTypeNamePrefix = "VuoList_"

static

The common beginning of all VuoList type names (before the item type name).

Definition at line 26 of file VuoType.hh.

---

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

• base/VuoType.hh
• base/VuoType.cc