A published port type.
Definition at line 21 of file VuoCompilerPublishedPortClass.hh.
Public Member Functions | |
VuoCompilerPublishedPortClass (string name, VuoPortClass::PortType portType, Type *type) | |
Creates a published port type. 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... | |
VuoType * | getDataVuoType (void) |
Returns the type of data carried by this port, or null if this port is event-only. More... | |
void | setDataVuoType (VuoType *type) |
Sets the type of the data carried by this port. More... | |
string | getDisplayName (void) |
Returns the port class's display name. More... | |
void | setDetail (string key, string value) |
Sets the value of a detail for this published port. More... | |
void | unsetDetail (string key) |
Unsets the value of a detail for this published port. More... | |
void | updateDetails (json_object *modifiedDetails) |
Updates the details for this published port with the new values in modifiedDetails. More... | |
Public Member Functions inherited from VuoCompilerPortClass | |
~VuoCompilerPortClass (void) | |
Destructor. 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... | |
VuoCompilerPublishedPortClass::VuoCompilerPublishedPortClass | ( | string | name, |
VuoPortClass::PortType | portType, | ||
Type * | type | ||
) |
Creates a published port type.
Definition at line 17 of file VuoCompilerPublishedPortClass.cc.
|
virtual |
Returns the type of data carried by this port, or null if this port is event-only.
Implements VuoCompilerPortClass.
Definition at line 43 of file VuoCompilerPublishedPortClass.cc.
|
virtual |
Returns the port class's display name.
Reimplemented from VuoCompilerPortClass.
Definition at line 61 of file VuoCompilerPublishedPortClass.cc.
|
virtual |
Creates a new port based on this port type, and creates its corresponding base VuoPort
.
Implements VuoCompilerPortClass.
Definition at line 27 of file VuoCompilerPublishedPortClass.cc.
|
virtual |
Creates a new port based on this port type, using the pre-existing port
as its base.
Implements VuoCompilerPortClass.
Definition at line 35 of file VuoCompilerPublishedPortClass.cc.
|
virtual |
Sets the type of the data carried by this port.
Assumes this port is not event-only.
Implements VuoCompilerPortClass.
Definition at line 53 of file VuoCompilerPublishedPortClass.cc.
void VuoCompilerPublishedPortClass::setDetail | ( | string | key, |
string | value | ||
) |
Sets the value of a detail for this published port.
The previous detail value for key (if any) is replaced by value.
Definition at line 70 of file VuoCompilerPublishedPortClass.cc.
void VuoCompilerPublishedPortClass::unsetDetail | ( | string | key | ) |
Unsets the value of a detail for this published port.
The previous detail value for key (if any) is removed.
Definition at line 79 of file VuoCompilerPublishedPortClass.cc.
void VuoCompilerPublishedPortClass::updateDetails | ( | json_object * | modifiedDetails | ) |
Updates the details for this published port with the new values in modifiedDetails.
If a detail's value is null in modifiedDetails, it will be unset.
If a detail's key is not in modifiedDetails, it will remain unchanged.
Definition at line 91 of file VuoCompilerPublishedPortClass.cc.