Vuo  0.3
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VuoCompilerNodeArgumentClass Class Reference

Description

A parameter to a node's event and/or init function.

To create an argument to pass for this parameter, instantiate a VuoCompilerNodeArgument.

See Also
VuoPortClass

Public Member Functions

virtual Type * getType (void)
 Returns the type of this argument.
 
bool isInEventFunction (void)
 Returns true if this is known to be one of the parameters in its node class's event function.
 
size_t getIndexInEventFunction (void)
 Returns the index of this port's parameter in its node class's event function.
 
void setIndexInEventFunction (size_t indexInEventFunction)
 Indicates that this is the parameter at index indexInEventFunction in its node class's event function.
 
bool isInInitFunction (void)
 Returns true if this is known to be one of the parameters in its node class's init function.
 
size_t getIndexInInitFunction (void)
 Returns the index of this port's parameter in its node class's init function.
 
void setIndexInInitFunction (size_t indexInInitFunction)
 Indicates that this is the parameter at index indexInInitFunction in its node class's init function.
 
- Public Member Functions inherited from VuoBaseDetail< VuoPortClass >
 VuoBaseDetail (string id, VuoPortClass *base)
 Creates a VuoPortClass detail class.
 
VuoPortClassgetBase (void) const
 Returns the VuoPortClass detail class instance's base class instance.
 
void setBase (VuoPortClass *base)
 Sets the VuoPortClass detail class instance's base class instance.
 

Protected Member Functions

 VuoCompilerNodeArgumentClass (string name, VuoPortClass::PortType portType, Type *type, bool inEventFunction, size_t indexInEventFunction, bool inInitFunction, size_t indexInInitFunction)
 Creates a parameter for calling a node's event or init function, and creates its corresponding base VuoPortClass.
 
virtual ~VuoCompilerNodeArgumentClass (void)
 to make this class dynamic_cast-able
 

Protected Attributes

Type * type
 The parameter's type.
 
bool inEventFunction
 Does this parameter appear in the node's event function?
 
size_t indexInEventFunction
 Where this parameter appears in the node's event function's parameter list.
 
bool inInitFunction
 Does this parameter appear in the node's init function?
 
size_t indexInInitFunction
 Where this parameter appears in the node's init function's parameter list.
 

Member Function Documentation

size_t VuoCompilerNodeArgumentClass::getIndexInEventFunction ( void  )

Returns the index of this port's parameter in its node class's event function.

Assumes this port is known to be one of the parameters in its node class's event function.

size_t VuoCompilerNodeArgumentClass::getIndexInInitFunction ( void  )

Returns the index of this port's parameter in its node class's init function.

Assumes this port is known to be one of the parameters in its node class's init function.


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