Information about a trigger port inside a subcomposition that the subcomposition advertises to its containing composition.
Definition at line 22 of file VuoCompilerTriggerDescription.hh.
Public Member Functions | |
json_object * | getJsonWithinSubcomposition (VuoCompilerNode *subcompositionNode) |
Returns a JSON representation of this trigger description that includes fields for subcompositionNode, the subcomposition that contains the node on which the trigger appears. More... | |
size_t | getNodeIndex (void) |
Returns the index (in the compiler's list of ordered nodes) of the node on which the trigger port appears. More... | |
string | getNodeIdentifier (void) |
Returns the identifier of the node on which the trigger port appears. More... | |
string | getNodeClassName (void) |
Returns the node class name of the node on which the trigger port appears. More... | |
string | getPortName (void) |
Returns the name of the trigger port. More... | |
int | getPortContextIndex (void) |
Returns the index of this trigger port within its node's port contexts. More... | |
VuoPortClass::EventThrottling | getEventThrottling (void) |
Returns the event throttling setting of the trigger port. More... | |
VuoType * | getDataType (void) |
Returns the data type of the trigger port. More... | |
void | setDataType (VuoType *dataType) |
Sets the data type of the trigger port. More... | |
void | getWorkerThreadsNeeded (int &minThreadsNeeded, int &maxThreadsNeeded) |
Gives the minimum and maximum number of threads needed for an event from this trigger to propagate through the composition. More... | |
int | getChainCount (void) |
Returns the number of chains of nodes downstream of the trigger port. More... | |
string | getSubcompositionNodeClassName (void) |
Returns the node class name of the subcomposition that contains the node on which this trigger appears. More... | |
string | getSubcompositionNodeIdentifier (void) |
Returns the node identifier of the subcomposition that contains the node on which this trigger appears. More... | |
Static Public Member Functions | |
static json_object * | getJson (VuoCompilerNode *triggerNode, VuoCompilerTriggerPort *trigger, VuoCompilerGraph *graph) |
Returns a JSON representation of trigger that can later be parsed to create a VuoCompilerTriggerDescription. More... | |
static vector< VuoCompilerTriggerDescription * > | parseFromJson (json_object *js) |
Parses a JSON array of trigger descriptions. More... | |
int VuoCompilerTriggerDescription::getChainCount | ( | void | ) |
Returns the number of chains of nodes downstream of the trigger port.
Definition at line 231 of file VuoCompilerTriggerDescription.cc.
VuoType * VuoCompilerTriggerDescription::getDataType | ( | void | ) |
Returns the data type of the trigger port.
Definition at line 203 of file VuoCompilerTriggerDescription.cc.
VuoPortClass::EventThrottling VuoCompilerTriggerDescription::getEventThrottling | ( | void | ) |
Returns the event throttling setting of the trigger port.
Definition at line 195 of file VuoCompilerTriggerDescription.cc.
|
static |
Returns a JSON representation of trigger that can later be parsed to create a VuoCompilerTriggerDescription.
Definition at line 37 of file VuoCompilerTriggerDescription.cc.
json_object * VuoCompilerTriggerDescription::getJsonWithinSubcomposition | ( | VuoCompilerNode * | subcompositionNode | ) |
Returns a JSON representation of this trigger description that includes fields for subcompositionNode, the subcomposition that contains the node on which the trigger appears.
Definition at line 124 of file VuoCompilerTriggerDescription.cc.
string VuoCompilerTriggerDescription::getNodeClassName | ( | void | ) |
Returns the node class name of the node on which the trigger port appears.
Definition at line 171 of file VuoCompilerTriggerDescription.cc.
string VuoCompilerTriggerDescription::getNodeIdentifier | ( | void | ) |
Returns the identifier of the node on which the trigger port appears.
Definition at line 163 of file VuoCompilerTriggerDescription.cc.
size_t VuoCompilerTriggerDescription::getNodeIndex | ( | void | ) |
Returns the index (in the compiler's list of ordered nodes) of the node on which the trigger port appears.
Definition at line 155 of file VuoCompilerTriggerDescription.cc.
int VuoCompilerTriggerDescription::getPortContextIndex | ( | void | ) |
Returns the index of this trigger port within its node's port contexts.
Definition at line 187 of file VuoCompilerTriggerDescription.cc.
string VuoCompilerTriggerDescription::getPortName | ( | void | ) |
Returns the name of the trigger port.
Definition at line 179 of file VuoCompilerTriggerDescription.cc.
string VuoCompilerTriggerDescription::getSubcompositionNodeClassName | ( | void | ) |
Returns the node class name of the subcomposition that contains the node on which this trigger appears.
Definition at line 239 of file VuoCompilerTriggerDescription.cc.
string VuoCompilerTriggerDescription::getSubcompositionNodeIdentifier | ( | void | ) |
Returns the node identifier of the subcomposition that contains the node on which this trigger appears.
Definition at line 247 of file VuoCompilerTriggerDescription.cc.
void VuoCompilerTriggerDescription::getWorkerThreadsNeeded | ( | int & | minThreadsNeeded, |
int & | maxThreadsNeeded | ||
) |
Gives the minimum and maximum number of threads needed for an event from this trigger to propagate through the composition.
Definition at line 222 of file VuoCompilerTriggerDescription.cc.
|
static |
Parses a JSON array of trigger descriptions.
Definition at line 71 of file VuoCompilerTriggerDescription.cc.
void VuoCompilerTriggerDescription::setDataType | ( | VuoType * | dataType | ) |
Sets the data type of the trigger port.
Definition at line 211 of file VuoCompilerTriggerDescription.cc.