The data type for a data-and-event port.
Definition at line 20 of file VuoCompilerDataClass.hh.
Public Member Functions | |
virtual VuoCompilerData * | newData (void)=0 |
Factory method for constructing a VuoCompilerData that instantiates this data class. More... | |
~VuoCompilerDataClass (void) | |
Destructor. More... | |
VuoType * | getVuoType (void) |
Returns the VuoType for this port data, as set in setVuoType . More... | |
void | setVuoType (VuoType *vuoType) |
Sets the VuoType for this port data. More... | |
Type * | getType (void) |
Returns the LLVM type for this port data's Vuo type. More... | |
void | setDetails (struct json_object *details) |
Sets details for this port data. More... | |
json_object * | getDetails (void) |
Returns details for this port data, set in setDetails() . More... | |
Public Member Functions inherited from VuoCompilerNodeArgumentClass | |
virtual | ~VuoCompilerNodeArgumentClass (void) |
to make this class dynamic_cast-able 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 | |
VuoCompilerDataClass (string name, Type *type) | |
Creates a data type for a data-and-event port. More... | |
Protected Member Functions inherited from VuoCompilerNodeArgumentClass | |
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 | |
struct json_object * | details |
Metadata specified in the node class implementation, such as the default value. More... | |
Protected Attributes inherited from VuoCompilerNodeArgumentClass | |
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 data type for a data-and-event port.
Definition at line 17 of file VuoCompilerDataClass.cc.
VuoCompilerDataClass::~VuoCompilerDataClass | ( | void | ) |
Destructor.
Definition at line 27 of file VuoCompilerDataClass.cc.
json_object * VuoCompilerDataClass::getDetails | ( | void | ) |
Returns details for this port data, set in setDetails()
.
Definition at line 84 of file VuoCompilerDataClass.cc.
|
virtual |
Returns the LLVM type for this port data's Vuo type.
Overrides the implementation in VuoCompilerNodeArgumentClass
.
Reimplemented from VuoCompilerNodeArgumentClass.
Definition at line 54 of file VuoCompilerDataClass.cc.
VuoType * VuoCompilerDataClass::getVuoType | ( | void | ) |
Returns the VuoType
for this port data, as set in setVuoType
.
Definition at line 35 of file VuoCompilerDataClass.cc.
|
pure virtual |
Factory method for constructing a VuoCompilerData
that instantiates this data class.
Implemented in VuoCompilerInputDataClass, and VuoCompilerOutputDataClass.
void VuoCompilerDataClass::setDetails | ( | struct json_object * | details | ) |
Sets details for this port data.
Definition at line 76 of file VuoCompilerDataClass.cc.
void VuoCompilerDataClass::setVuoType | ( | VuoType * | vuoType | ) |
Sets the VuoType
for this port data.
Its VuoCompilerType
may be null (but needs to be non-null by the time the composition is compiled).
Definition at line 44 of file VuoCompilerDataClass.cc.
|
protected |
Metadata specified in the node class implementation, such as the default value.
Definition at line 26 of file VuoCompilerDataClass.hh.