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

Description

A passive (non-trigger) output port type, optionally with data.

See Also
{VuoCompilerOutputEventPort}

Public Member Functions

 VuoCompilerOutputEventPortClass (string name, Type *type)
 Creates a passive (non-trigger) output port type with the specified data type type.
 
 VuoCompilerOutputEventPortClass (string name)
 Creates a passive (non-trigger) output port type.
 
VuoCompilerPortnewPort (void)
 Creates a passive (non-trigger) output port based on this port type, and creates its corresponding base VuoPort.
 
VuoCompilerPortnewPort (VuoPort *port)
 Creates a passive (non-trigger) output port based on this port type, using the pre-existing port as its base.
 
VuoCompilerOutputDataClassgetDataClass (void)
 Returns the data class for this port.
 
- Public Member Functions inherited from VuoCompilerEventPortClass
 ~VuoCompilerEventPortClass (void)
 Destructor.
 
VuoCompilerDataClassgetDataClass (void)
 Returns this port's data class, or NULL if none.
 
void setDataClass (VuoCompilerDataClass *dataClass)
 Sets this port's data class.
 
VuoTypegetDataVuoType (void)
 Returns the type of data carried by this port, or null if this port is event-only.
 
void setDataVuoType (VuoType *type)
 Sets the type of the data carried by this port.
 
- 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 VuoCompilerEventPortClass
 VuoCompilerEventPortClass (string name, Type *type)
 Creates a passive (non-trigger) port with the specified data type type.
 
 VuoCompilerEventPortClass (string name)
 Creates a passive (non-trigger) port.
 
- Protected Attributes inherited from VuoCompilerEventPortClass
VuoCompilerDataClassdataClass
 This port's optional data class.
 

Constructor & Destructor Documentation

VuoCompilerOutputEventPortClass::VuoCompilerOutputEventPortClass ( string  name,
Type *  type 
)

Creates a passive (non-trigger) output port type with the specified data type type.

VuoCompilerOutputEventPortClass::VuoCompilerOutputEventPortClass ( string  name)

Creates a passive (non-trigger) output port type.

Member Function Documentation

VuoCompilerOutputDataClass * VuoCompilerOutputEventPortClass::getDataClass ( void  )

Returns the data class for this port.

NULL if the port is event-only.

VuoCompilerPort * VuoCompilerOutputEventPortClass::newPort ( void  )
virtual

Creates a passive (non-trigger) output port based on this port type, and creates its corresponding base VuoPort.

Implements VuoCompilerPortClass.

VuoCompilerPort * VuoCompilerOutputEventPortClass::newPort ( VuoPort port)
virtual

Creates a passive (non-trigger) output port based on this port type, using the pre-existing port as its base.

Implements VuoCompilerPortClass.


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