Vuo  0.5.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VuoCompilerEventPortClass Class Reference

Description

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

Public Member Functions

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
virtual VuoCompilerPortnewPort (void)=0
 Factory method to construct a VuoCompilerPort instance from this port class, and create its corresponding base VuoPort.
 
virtual VuoCompilerPortnewPort (VuoPort *port)=0
 Factory method to construct a VuoCompilerPort instance from this port class, using the pre-existing port as its base.
 
- Public Member Functions inherited from VuoCompilerNodeArgumentClass
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.
 
- 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.
 

Protected Member Functions

 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 Member Functions inherited from VuoCompilerPortClass
 VuoCompilerPortClass (string name, VuoPortClass::PortType portType, Type *type)
 Creates a port type and creates its corresponding base VuoPortClass.
 
- 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.
 
virtual ~VuoCompilerNodeArgumentClass (void)
 to make this class dynamic_cast-able
 

Protected Attributes

VuoCompilerDataClassdataClass
 This port's optional data class.
 

Constructor & Destructor Documentation

VuoCompilerEventPortClass::VuoCompilerEventPortClass ( string  name,
Type *  type 
)
protected

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

VuoCompilerEventPortClass::VuoCompilerEventPortClass ( string  name)
protected

Creates a passive (non-trigger) port.

Member Function Documentation

VuoCompilerDataClass * VuoCompilerEventPortClass::getDataClass ( void  )

Returns this port's data class, or NULL if none.

VuoType * VuoCompilerEventPortClass::getDataVuoType ( void  )
virtual

Returns the type of data carried by this port, or null if this port is event-only.

Implements VuoCompilerPortClass.

void VuoCompilerEventPortClass::setDataClass ( VuoCompilerDataClass dataClass)

Sets this port's data class.

void VuoCompilerEventPortClass::setDataVuoType ( VuoType type)
virtual

Sets the type of the data carried by this port.

Assumes this port is not event-only.

Implements VuoCompilerPortClass.

Member Data Documentation

VuoCompilerDataClass* VuoCompilerEventPortClass::dataClass
protected

This port's optional data class.


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