A trigger output port type.
Definition at line 19 of file VuoCompilerTriggerPortClass.hh.
Public Member Functions | |
VuoCompilerTriggerPortClass (string name, PointerType *type) | |
Creates a trigger output port. More... | |
VuoCompilerPort * | newPort (void) |
Creates a new port based on this port type, and creates its corresponding base VuoPort . More... | |
VuoCompilerPort * | newPort (VuoPort *port) |
Creates a new port based on this port type, using the pre-existing port as its base. More... | |
FunctionType * | getFunctionType (void) |
Returns the FunctionType pointed to by this port's PointerType parameter in its node class's event/init functions. More... | |
VuoType * | getDataVuoType (void) |
Returns the type of the data transmitted by this trigger, as set in setDataVuoType . More... | |
void | setDataVuoType (VuoType *type) |
Sets the type of the data transmitted by this trigger. More... | |
Public Member Functions inherited from VuoCompilerPortClass | |
~VuoCompilerPortClass (void) | |
Destructor. More... | |
virtual string | getDisplayName (void) |
Returns the port class's display name, camel-case expanded, and optionally overridden by the port class details . More... | |
void | setDetails (struct json_object *details) |
Sets details for this port. More... | |
json_object * | getDetails (void) |
Returns details for this port, set in setDetails() . More... | |
Public Member Functions inherited from VuoCompilerNodeArgumentClass | |
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... | |
Additional Inherited Members | |
Protected Member Functions inherited from VuoCompilerPortClass | |
VuoCompilerPortClass (string name, VuoPortClass::PortType portType, Type *type) | |
Creates a port type and creates its corresponding base VuoPortClass . 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 inherited from VuoCompilerPortClass | |
struct json_object * | details |
Metadata specified in the node class implementation, such as the port's display name. 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... | |
VuoCompilerTriggerPortClass::VuoCompilerTriggerPortClass | ( | string | name, |
PointerType * | type | ||
) |
Creates a trigger output port.
Upon creation, isInEventFunction
and isInCallbackStartFunction
both return false.
name | The port's identifier and title. |
type | A PointerType pointing to a FunctionType which has 0 or 1 parameter. The parameter indicates the type of data, if any, transmitted by the port alongside the fired event. |
Definition at line 22 of file VuoCompilerTriggerPortClass.cc.
|
virtual |
Returns the type of the data transmitted by this trigger, as set in setDataVuoType
.
Implements VuoCompilerPortClass.
Definition at line 55 of file VuoCompilerTriggerPortClass.cc.
FunctionType * VuoCompilerTriggerPortClass::getFunctionType | ( | void | ) |
Returns the FunctionType
pointed to by this port's PointerType
parameter in its node class's event/init functions.
Definition at line 47 of file VuoCompilerTriggerPortClass.cc.
|
virtual |
Creates a new port based on this port type, and creates its corresponding base VuoPort
.
Implements VuoCompilerPortClass.
Definition at line 31 of file VuoCompilerTriggerPortClass.cc.
|
virtual |
Creates a new port based on this port type, using the pre-existing port
as its base.
Implements VuoCompilerPortClass.
Definition at line 39 of file VuoCompilerTriggerPortClass.cc.
|
virtual |
Sets the type of the data transmitted by this trigger.
Its VuoCompilerType
may be null (but needs to be non-null by the time the composition is compiled).
If the VuoCompilerType
is not null, then its LLVM type should equal the first parameter of this port's function type.
Implements VuoCompilerPortClass.
Definition at line 66 of file VuoCompilerTriggerPortClass.cc.