Vuo  1.2.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
VuoType Class Reference

Description

This base class represents the metadata of one type.

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

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

Constructor & Destructor Documentation

VuoType::VuoType ( string  typeName)

Creates a type.

Parameters
typeNameA unique (across all types and node classes) name for this type.
VuoType::~VuoType ( void  )
virtual

to make this class dynamic_cast-able

Member Function Documentation

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.

bool VuoType::isDictionaryTypeName ( string  typeName)
static

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

bool VuoType::isListTypeName ( string  typeName)
static

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

Member Data Documentation

const string VuoType::dictionaryTypeNamePrefix = "VuoDictionary_"
static

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

const string VuoType::listTypeNamePrefix = "VuoList_"
static

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


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