Description
The data type for a data-and-event input port.
Definition at line 19 of file VuoCompilerInputDataClass.hh.
Public Member Functions | |
| VuoCompilerInputDataClass (string name) | |
| Creates a data type for a data-and-event input port. More... | |
| VuoCompilerData * | newData (void) |
| Creates a data instance based on this data type. More... | |
| string | getDefaultValue (void) |
| Returns the string representation of the default initial value of port data instantiated from this data type. More... | |
| string | getAutoValue (void) |
Returns the string representation of auto value for port data instantiated from this data type. More... | |
| bool | getAutoSupersedesDefaultValue (void) |
Returns the boolean autoSupersedesDefault value for port data instantiated from this data type. More... | |
| void | setUnloweredStructPointerInEventFunction (Type *firstParameterType) |
| Stores whether parameterType — this data's first (and possibly only) parameter in the node event function — is an unlowered struct passed by reference. More... | |
| bool | isUnloweredStructPointerInEventFunction (void) |
| void | setUnloweredStructPointerInInitFunction (Type *firstParameterType) |
| bool | isUnloweredStructPointerInInitFunction (void) |
| void | setUnloweredStructPointerInCallbackStartFunction (Type *firstParameterType) |
| bool | isUnloweredStructPointerInCallbackStartFunction (void) |
| void | setUnloweredStructPointerInCallbackUpdateFunction (Type *firstParameterType) |
| bool | isUnloweredStructPointerInCallbackUpdateFunction (void) |
| void | setUnloweredStructPointerInCallbackStopFunction (Type *firstParameterType) |
| bool | isUnloweredStructPointerInCallbackStopFunction (void) |
 Public Member Functions inherited from VuoCompilerDataClass | |
| ~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... | |
| 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from VuoCompilerDataClass | |
| VuoCompilerDataClass (string name) | |
| Creates a data type for a data-and-event port. More... | |
| Protected Member Functions inherited from VuoCompilerNodeArgumentClass | |
| VuoCompilerNodeArgumentClass (string name, VuoPortClass::PortType portType) | |
Creates a parameter for calling a node's event or init function, and creates its corresponding base VuoPortClass. More... | |
| Protected Attributes inherited from VuoCompilerDataClass | |
| struct json_object * | details |
| Metadata specified in the node class implementation, such as the default value. More... | |
| Protected Attributes inherited from VuoCompilerNodeArgumentClass | |
| 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... | |
Constructor & Destructor Documentation
◆ VuoCompilerInputDataClass()
|
explicit |
Creates a data type for a data-and-event input port.
The default data value for instances of this data type is not set. Set it with setDefaultValue.
Definition at line 22 of file VuoCompilerInputDataClass.cc.
Member Function Documentation
◆ getAutoSupersedesDefaultValue()
| bool VuoCompilerInputDataClass::getAutoSupersedesDefaultValue | ( | void | ) |
Returns the boolean autoSupersedesDefault value for port data instantiated from this data type.
Definition at line 84 of file VuoCompilerInputDataClass.cc.
◆ getAutoValue()
| string VuoCompilerInputDataClass::getAutoValue | ( | void | ) |
Returns the string representation of auto value for port data instantiated from this data type.
Definition at line 68 of file VuoCompilerInputDataClass.cc.
◆ getDefaultValue()
| string VuoCompilerInputDataClass::getDefaultValue | ( | void | ) |
Returns the string representation of the default initial value of port data instantiated from this data type.
Definition at line 44 of file VuoCompilerInputDataClass.cc.
◆ isUnloweredStructPointerInCallbackStartFunction()
| bool VuoCompilerInputDataClass::isUnloweredStructPointerInCallbackStartFunction | ( | void | ) |
Definition at line 163 of file VuoCompilerInputDataClass.cc.
◆ isUnloweredStructPointerInCallbackStopFunction()
| bool VuoCompilerInputDataClass::isUnloweredStructPointerInCallbackStopFunction | ( | void | ) |
Definition at line 195 of file VuoCompilerInputDataClass.cc.
◆ isUnloweredStructPointerInCallbackUpdateFunction()
| bool VuoCompilerInputDataClass::isUnloweredStructPointerInCallbackUpdateFunction | ( | void | ) |
Definition at line 179 of file VuoCompilerInputDataClass.cc.
◆ isUnloweredStructPointerInEventFunction()
| bool VuoCompilerInputDataClass::isUnloweredStructPointerInEventFunction | ( | void | ) |
Definition at line 131 of file VuoCompilerInputDataClass.cc.
◆ isUnloweredStructPointerInInitFunction()
| bool VuoCompilerInputDataClass::isUnloweredStructPointerInInitFunction | ( | void | ) |
Definition at line 147 of file VuoCompilerInputDataClass.cc.
◆ newData()
|
virtual |
Creates a data instance based on this data type.
Implements VuoCompilerDataClass.
Definition at line 35 of file VuoCompilerInputDataClass.cc.
◆ setUnloweredStructPointerInCallbackStartFunction()
| void VuoCompilerInputDataClass::setUnloweredStructPointerInCallbackStartFunction | ( | Type * | firstParameterType | ) |
Definition at line 155 of file VuoCompilerInputDataClass.cc.
◆ setUnloweredStructPointerInCallbackStopFunction()
| void VuoCompilerInputDataClass::setUnloweredStructPointerInCallbackStopFunction | ( | Type * | firstParameterType | ) |
Definition at line 187 of file VuoCompilerInputDataClass.cc.
◆ setUnloweredStructPointerInCallbackUpdateFunction()
| void VuoCompilerInputDataClass::setUnloweredStructPointerInCallbackUpdateFunction | ( | Type * | firstParameterType | ) |
Definition at line 171 of file VuoCompilerInputDataClass.cc.
◆ setUnloweredStructPointerInEventFunction()
| void VuoCompilerInputDataClass::setUnloweredStructPointerInEventFunction | ( | Type * | firstParameterType | ) |
Stores whether parameterType — this data's first (and possibly only) parameter in the node event function — is an unlowered struct passed by reference.
The reason for storing this when a node class's module is first loaded, instead of checking it as needed, is to work around an apparent bug in LLVM. When the module is linked into a composition (i.e., a clone of it is passed to llvm::Linker::linkInModule()), the struct type names in the module's function parameters are changed from the original (e.g. struct.VuoRange) to something different (e.g. %"type 0x7f8ef07bce80"*). https://b33p.net/kosada/vuo/vuo/-/issues/18132
Definition at line 123 of file VuoCompilerInputDataClass.cc.
◆ setUnloweredStructPointerInInitFunction()
| void VuoCompilerInputDataClass::setUnloweredStructPointerInInitFunction | ( | Type * | firstParameterType | ) |
Definition at line 139 of file VuoCompilerInputDataClass.cc.
The documentation for this class was generated from the following files:
- compiler/VuoCompilerInputDataClass.hh
- compiler/VuoCompilerInputDataClass.cc
