VuoCompilerEventPortClass Class Reference

Description

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

Public Member Functions
	~VuoCompilerEventPortClass (void)
	Destructor.
VuoCompilerDataClass *	getDataClass (void)
	Returns this port's data class, or NULL if none.
void	setDataClass (VuoCompilerDataClass *dataClass)
	Sets this port's data class.
VuoType *	getDataVuoType (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.
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 VuoCompilerPortClass
	~VuoCompilerPortClass (void)
	Destructor.
virtual VuoCompilerPort *	newPort (void)=0
	Factory method to construct a VuoCompilerPort instance from this port class, and create its corresponding base VuoPort.
virtual VuoCompilerPort *	newPort (VuoPort *port)=0
	Factory method to construct a VuoCompilerPort instance from this port class, using the pre-existing port as its base.
void	setDetails (struct json_object *details)
	Sets details for this port.
json_object *	getDetails (void)
	Returns details for this port, set in setDetails().
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.
VuoPortClass *	getBase (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.

Protected Attributes
VuoCompilerDataClass *	dataClass
	This port's optional data class.
Protected Attributes inherited from VuoCompilerPortClass
struct json_object *	details
	Metadata specified in the node class implementation, such as the port's display name.
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

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.

VuoCompilerEventPortClass::~VuoCompilerEventPortClass

(

void

)

Destructor.

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.

string VuoCompilerEventPortClass::getDisplayName ( void  )

virtual

Returns the port class's display name, camel-case expanded, and optionally overridden by the port class details.

Reimplemented from 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:

• compiler/VuoCompilerEventPortClass.hh
• compiler/VuoCompilerEventPortClass.cc