A parameter to a node's event and/or init function.
To create an argument to pass for this parameter, instantiate a VuoCompilerNodeArgument
.
Definition at line 21 of file VuoCompilerNodeArgumentClass.hh.
Public Member Functions | |
virtual | ~VuoCompilerNodeArgumentClass (void) |
to make this class dynamic_cast-able More... | |
virtual Type * | getType (void) |
Returns the type of this argument. More... | |
bool | isInEventFunction (void) |
Returns true if this is known to be one of the parameters in its node class's event function. More... | |
size_t | getIndexInEventFunction (void) |
Returns the index of this port's parameter in its node class's event function. More... | |
void | setIndexInEventFunction (size_t indexInEventFunction) |
Indicates that this is the parameter at index indexInEventFunction in its node class's event function. More... | |
bool | isInInitFunction (void) |
Returns true if this is known to be one of the parameters in its node class's init function. More... | |
size_t | getIndexInInitFunction (void) |
Returns the index of this port's parameter in its node class's init function. More... | |
void | setIndexInInitFunction (size_t indexInInitFunction) |
Indicates that this is the parameter at index indexInInitFunction in its node class's init function. More... | |
bool | isInCallbackStartFunction (void) |
Returns true if this is known to be one of the parameters in its node class's callback start function. More... | |
size_t | getIndexInCallbackStartFunction (void) |
Returns the index of this port's parameter in its node class's callback start function. More... | |
void | setIndexInCallbackStartFunction (size_t indexInCallbackStartFunction) |
Indicates that this is the parameter at index indexInCallbackStartFunction in its node class's callback start function. More... | |
bool | isInCallbackUpdateFunction (void) |
Returns true if this is known to be one of the parameters in its node class's callback update function. More... | |
size_t | getIndexInCallbackUpdateFunction (void) |
Returns the index of this port's parameter in its node class's callback update function. More... | |
void | setIndexInCallbackUpdateFunction (size_t indexInCallbackUpdateFunction) |
Indicates that this is the parameter at index indexInCallbackUpdateFunction in its node class's callback update function. More... | |
bool | isInCallbackStopFunction (void) |
Returns true if this is known to be one of the parameters in its node class's callback stop function. More... | |
size_t | getIndexInCallbackStopFunction (void) |
Returns the index of this port's parameter in its node class's callback stop function. More... | |
void | setIndexInCallbackStopFunction (size_t indexInCallbackStopFunction) |
Indicates that this is the parameter at index indexInCallbackStopFunction in its node class's callback stop function. More... | |
Public Member Functions inherited from VuoBaseDetail< VuoPortClass > | |
VuoBaseDetail (string description, VuoPortClass *base) | |
Creates a detail class. More... | |
VuoPortClass * | getBase (void) const |
Returns the detail class instance's base class instance. More... | |
void | setBase (VuoPortClass *base) |
Sets the detail class instance's base class instance. More... | |
Protected Member Functions | |
VuoCompilerNodeArgumentClass (string name, VuoPortClass::PortType portType, Type *type) | |
Creates a parameter for calling a node's event or init function, and creates its corresponding base VuoPortClass . More... | |
Protected Attributes | |
Type * | type |
The parameter's type. More... | |
bool | inEventFunction |
Does this parameter appear in the node's event function? More... | |
size_t | indexInEventFunction |
Where this parameter appears in the node's event function's parameter list. More... | |
bool | inInitFunction |
Does this parameter appear in the node's init function? More... | |
size_t | indexInInitFunction |
Where this parameter appears in the node's init function's parameter list. More... | |
bool | inCallbackStartFunction |
Does this parameter appear in the node's callback start function? More... | |
size_t | indexInCallbackStartFunction |
Where this parameter appears in the node's callback start function's parameter list. More... | |
bool | inCallbackUpdateFunction |
Does this parameter appear in the node's callback update function? More... | |
size_t | indexInCallbackUpdateFunction |
Where this parameter appears in the node's callback update function's parameter list. More... | |
bool | inCallbackStopFunction |
Does this parameter appear in the node's callback stop function? More... | |
size_t | indexInCallbackStopFunction |
Where this parameter appears in the node's callback stop function's parameter list. More... | |
|
protected |
Creates a parameter for calling a node's event or init function, and creates its corresponding base VuoPortClass
.
Definition at line 16 of file VuoCompilerNodeArgumentClass.cc.
|
virtual |
to make this class dynamic_cast-able
Destructor.
Definition at line 33 of file VuoCompilerNodeArgumentClass.cc.
size_t VuoCompilerNodeArgumentClass::getIndexInCallbackStartFunction | ( | void | ) |
Returns the index of this port's parameter in its node class's callback start function.
Assumes this port is known to be one of the parameters in its node class's callback start function.
Definition at line 112 of file VuoCompilerNodeArgumentClass.cc.
size_t VuoCompilerNodeArgumentClass::getIndexInCallbackStopFunction | ( | void | ) |
Returns the index of this port's parameter in its node class's callback stop function.
Assumes this port is known to be one of the parameters in its node class's callback stop function.
Definition at line 166 of file VuoCompilerNodeArgumentClass.cc.
size_t VuoCompilerNodeArgumentClass::getIndexInCallbackUpdateFunction | ( | void | ) |
Returns the index of this port's parameter in its node class's callback update function.
Assumes this port is known to be one of the parameters in its node class's callback update function.
Definition at line 139 of file VuoCompilerNodeArgumentClass.cc.
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.
Definition at line 58 of file VuoCompilerNodeArgumentClass.cc.
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.
Definition at line 85 of file VuoCompilerNodeArgumentClass.cc.
|
virtual |
Returns the type of this argument.
Reimplemented in VuoCompilerDataClass.
Definition at line 40 of file VuoCompilerNodeArgumentClass.cc.
bool VuoCompilerNodeArgumentClass::isInCallbackStartFunction | ( | void | ) |
Returns true if this is known to be one of the parameters in its node class's callback start function.
Definition at line 102 of file VuoCompilerNodeArgumentClass.cc.
bool VuoCompilerNodeArgumentClass::isInCallbackStopFunction | ( | void | ) |
Returns true if this is known to be one of the parameters in its node class's callback stop function.
Definition at line 156 of file VuoCompilerNodeArgumentClass.cc.
bool VuoCompilerNodeArgumentClass::isInCallbackUpdateFunction | ( | void | ) |
Returns true if this is known to be one of the parameters in its node class's callback update function.
Definition at line 129 of file VuoCompilerNodeArgumentClass.cc.
bool VuoCompilerNodeArgumentClass::isInEventFunction | ( | void | ) |
Returns true if this is known to be one of the parameters in its node class's event function.
Definition at line 48 of file VuoCompilerNodeArgumentClass.cc.
bool VuoCompilerNodeArgumentClass::isInInitFunction | ( | void | ) |
Returns true if this is known to be one of the parameters in its node class's init function.
Definition at line 75 of file VuoCompilerNodeArgumentClass.cc.
void VuoCompilerNodeArgumentClass::setIndexInCallbackStartFunction | ( | size_t | indexInCallbackStartFunction | ) |
Indicates that this is the parameter at index indexInCallbackStartFunction
in its node class's callback start function.
Definition at line 120 of file VuoCompilerNodeArgumentClass.cc.
void VuoCompilerNodeArgumentClass::setIndexInCallbackStopFunction | ( | size_t | indexInCallbackStopFunction | ) |
Indicates that this is the parameter at index indexInCallbackStopFunction
in its node class's callback stop function.
Definition at line 174 of file VuoCompilerNodeArgumentClass.cc.
void VuoCompilerNodeArgumentClass::setIndexInCallbackUpdateFunction | ( | size_t | indexInCallbackUpdateFunction | ) |
Indicates that this is the parameter at index indexInCallbackUpdateFunction
in its node class's callback update function.
Definition at line 147 of file VuoCompilerNodeArgumentClass.cc.
void VuoCompilerNodeArgumentClass::setIndexInEventFunction | ( | size_t | indexInEventFunction | ) |
Indicates that this is the parameter at index indexInEventFunction
in its node class's event function.
Definition at line 66 of file VuoCompilerNodeArgumentClass.cc.
void VuoCompilerNodeArgumentClass::setIndexInInitFunction | ( | size_t | indexInInitFunction | ) |
Indicates that this is the parameter at index indexInInitFunction
in its node class's init function.
Definition at line 93 of file VuoCompilerNodeArgumentClass.cc.
|
protected |
Does this parameter appear in the node's callback start function?
Definition at line 29 of file VuoCompilerNodeArgumentClass.hh.
|
protected |
Does this parameter appear in the node's callback stop function?
Definition at line 33 of file VuoCompilerNodeArgumentClass.hh.
|
protected |
Does this parameter appear in the node's callback update function?
Definition at line 31 of file VuoCompilerNodeArgumentClass.hh.
|
protected |
Where this parameter appears in the node's callback start function's parameter list.
Definition at line 30 of file VuoCompilerNodeArgumentClass.hh.
|
protected |
Where this parameter appears in the node's callback stop function's parameter list.
Definition at line 34 of file VuoCompilerNodeArgumentClass.hh.
|
protected |
Where this parameter appears in the node's callback update function's parameter list.
Definition at line 32 of file VuoCompilerNodeArgumentClass.hh.
|
protected |
Where this parameter appears in the node's event function's parameter list.
Definition at line 26 of file VuoCompilerNodeArgumentClass.hh.
|
protected |
Where this parameter appears in the node's init function's parameter list.
Definition at line 28 of file VuoCompilerNodeArgumentClass.hh.
|
protected |
Does this parameter appear in the node's event function?
Definition at line 25 of file VuoCompilerNodeArgumentClass.hh.
|
protected |
Does this parameter appear in the node's init function?
Definition at line 27 of file VuoCompilerNodeArgumentClass.hh.
|
protected |
The parameter's type.
Definition at line 24 of file VuoCompilerNodeArgumentClass.hh.