Vuo  1.2.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
VuoCompilerTriggerDescription Class Reference

Description

Information about a trigger port inside a subcomposition that the subcomposition advertises to its containing composition.

Public Member Functions

json_objectgetJsonWithinSubcomposition (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.
 
string getNodeIdentifier (void)
 Returns the identifier of the node on which the trigger port appears.
 
string getPortName (void)
 Returns the name of the trigger port.
 
int getPortContextIndex (void)
 Returns the index of this trigger port within its node's port contexts.
 
VuoPortClass::EventThrottling getEventThrottling (void)
 Returns the event throttling setting of the trigger port.
 
VuoTypegetDataType (void)
 Returns the data type of the trigger port.
 
void setDataType (VuoType *dataType)
 Sets the data type of the trigger port.
 
string getSubcompositionNodeClassName (void)
 Returns the node class name of the subcomposition that contains the node on which this trigger appears.
 
string getSubcompositionNodeIdentifier (void)
 Returns the node identifier of the subcomposition that contains the node on which this trigger appears.
 

Static Public Member Functions

static json_objectgetJson (VuoCompilerNode *triggerNode, VuoCompilerTriggerPort *trigger)
 Returns a JSON representation of trigger that can later be parsed to create a VuoCompilerTriggerDescription.
 
static vector
< VuoCompilerTriggerDescription * > 
parseFromJson (json_object *js)
 Parses a JSON array of trigger descriptions.
 

Member Function Documentation

VuoType * VuoCompilerTriggerDescription::getDataType ( void  )

Returns the data type of the trigger port.

VuoPortClass::EventThrottling VuoCompilerTriggerDescription::getEventThrottling ( void  )

Returns the event throttling setting of the trigger port.

json_object * VuoCompilerTriggerDescription::getJson ( VuoCompilerNode triggerNode,
VuoCompilerTriggerPort trigger 
)
static

Returns a JSON representation of trigger that can later be parsed to create a VuoCompilerTriggerDescription.

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.

string VuoCompilerTriggerDescription::getNodeIdentifier ( void  )

Returns the identifier of the node on which the trigger port appears.

int VuoCompilerTriggerDescription::getPortContextIndex ( void  )

Returns the index of this trigger port within its node's port contexts.

string VuoCompilerTriggerDescription::getPortName ( void  )

Returns the name of the trigger port.

string VuoCompilerTriggerDescription::getSubcompositionNodeClassName ( void  )

Returns the node class name of the subcomposition that contains the node on which this trigger appears.

string VuoCompilerTriggerDescription::getSubcompositionNodeIdentifier ( void  )

Returns the node identifier of the subcomposition that contains the node on which this trigger appears.

vector< VuoCompilerTriggerDescription * > VuoCompilerTriggerDescription::parseFromJson ( json_object js)
static

Parses a JSON array of trigger descriptions.

void VuoCompilerTriggerDescription::setDataType ( VuoType dataType)

Sets the data type of the trigger port.


The documentation for this class was generated from the following files: