Vuo  1.1.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
VuoCompilerTriggerPortClass Class Reference

Description

A trigger output port type.

See Also
{VuoCompilerTriggerPort}

Public Member Functions

 VuoCompilerTriggerPortClass (string name, PointerType *type)
 Creates a trigger output port.
 
VuoCompilerPortnewPort (void)
 Creates a new port based on this port type, and creates its corresponding base VuoPort.
 
VuoCompilerPortnewPort (VuoPort *port)
 Creates a new port based on this port type, using the pre-existing port as its base.
 
FunctionType * getFunctionType (void)
 Returns the FunctionType pointed to by this port's PointerType parameter in its node class's event/init functions.
 
VuoTypegetDataVuoType (void)
 Returns the type of the data transmitted by this trigger, as set in setDataVuoType.
 
void setDataVuoType (VuoType *type)
 Sets the type of the data transmitted by this trigger.
 
- Public Member Functions inherited from VuoCompilerPortClass
 ~VuoCompilerPortClass (void)
 Destructor.
 
void setDetails (struct json_object *details)
 Sets details for this port.
 
json_objectgetDetails (void)
 Returns details for this port, set in setDetails().
 
string getDisplayName (void)
 Returns the port class's display name, camel-case expanded, and optionally overridden by the port class details.
 
- Public Member Functions inherited from VuoCompilerNodeArgumentClass
virtual ~VuoCompilerNodeArgumentClass (void)
 to make this class dynamic_cast-able
 
virtual Type * getType (void)
 Returns the type of this argument.
 
bool isInEventFunction (void)
 Returns true if this is known to be one of the parameters in its node class's event function.
 
size_t getIndexInEventFunction (void)
 Returns the index of this port's parameter in its node class's event function.
 
void setIndexInEventFunction (size_t indexInEventFunction)
 Indicates that this is the parameter at index indexInEventFunction in its node class's event function.
 
bool isInInitFunction (void)
 Returns true if this is known to be one of the parameters in its node class's init function.
 
size_t getIndexInInitFunction (void)
 Returns the index of this port's parameter in its node class's init function.
 
void setIndexInInitFunction (size_t indexInInitFunction)
 Indicates that this is the parameter at index indexInInitFunction in its node class's init function.
 
bool isInCallbackStartFunction (void)
 Returns true if this is known to be one of the parameters in its node class's callback start function.
 
size_t getIndexInCallbackStartFunction (void)
 Returns the index of this port's parameter in its node class's callback start function.
 
void setIndexInCallbackStartFunction (size_t indexInCallbackStartFunction)
 Indicates that this is the parameter at index indexInCallbackStartFunction in its node class's callback start function.
 
bool isInCallbackUpdateFunction (void)
 Returns true if this is known to be one of the parameters in its node class's callback update function.
 
size_t getIndexInCallbackUpdateFunction (void)
 Returns the index of this port's parameter in its node class's callback update function.
 
void setIndexInCallbackUpdateFunction (size_t indexInCallbackUpdateFunction)
 Indicates that this is the parameter at index indexInCallbackUpdateFunction in its node class's callback update function.
 
bool isInCallbackStopFunction (void)
 Returns true if this is known to be one of the parameters in its node class's callback stop function.
 
size_t getIndexInCallbackStopFunction (void)
 Returns the index of this port's parameter in its node class's callback stop function.
 
void setIndexInCallbackStopFunction (size_t indexInCallbackStopFunction)
 Indicates that this is the parameter at index indexInCallbackStopFunction in its node class's callback stop function.
 
- Public Member Functions inherited from VuoBaseDetail< VuoPortClass >
 VuoBaseDetail (string description, VuoPortClass *base)
 Creates a VuoPortClass detail class.
 
VuoPortClassgetBase (void) const
 Returns the VuoPortClass detail class instance's base class instance.
 
void setBase (VuoPortClass *base)
 Sets the VuoPortClass detail class instance's base class instance.
 

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.
 
- Protected Attributes inherited from VuoCompilerNodeArgumentClass
Type * type
 The parameter's type.
 
bool inEventFunction
 Does this parameter appear in the node's event function?
 
size_t indexInEventFunction
 Where this parameter appears in the node's event function's parameter list.
 
bool inInitFunction
 Does this parameter appear in the node's init function?
 
size_t indexInInitFunction
 Where this parameter appears in the node's init function's parameter list.
 
bool inCallbackStartFunction
 Does this parameter appear in the node's callback start function?
 
size_t indexInCallbackStartFunction
 Where this parameter appears in the node's callback start function's parameter list.
 
bool inCallbackUpdateFunction
 Does this parameter appear in the node's callback update function?
 
size_t indexInCallbackUpdateFunction
 Where this parameter appears in the node's callback update function's parameter list.
 
bool inCallbackStopFunction
 Does this parameter appear in the node's callback stop function?
 
size_t indexInCallbackStopFunction
 Where this parameter appears in the node's callback stop function's parameter list.
 

Constructor & Destructor Documentation

VuoCompilerTriggerPortClass::VuoCompilerTriggerPortClass ( string  name,
PointerType *  type 
)

Creates a trigger output port.

Upon creation, isInEventFunction and isInCallbackStartFunction both return false.

Parameters
nameThe port's identifier and title.
typeA 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.

Member Function Documentation

VuoType * VuoCompilerTriggerPortClass::getDataVuoType ( void  )
virtual

Returns the type of the data transmitted by this trigger, as set in setDataVuoType.

Implements VuoCompilerPortClass.

FunctionType * VuoCompilerTriggerPortClass::getFunctionType ( void  )

Returns the FunctionType pointed to by this port's PointerType parameter in its node class's event/init functions.

VuoCompilerPort * VuoCompilerTriggerPortClass::newPort ( void  )
virtual

Creates a new port based on this port type, and creates its corresponding base VuoPort.

Implements VuoCompilerPortClass.

VuoCompilerPort * VuoCompilerTriggerPortClass::newPort ( VuoPort port)
virtual

Creates a new port based on this port type, using the pre-existing port as its base.

Implements VuoCompilerPortClass.

void VuoCompilerTriggerPortClass::setDataVuoType ( VuoType type)
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.


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