VuoCompilerPortClass Class Reference

Description

A port type.

Public Member Functions
virtual VuoCompilerPort *	newPort (void)=0
	Factory method to construct a VuoCompilerPort instance from this port class, and create its corresponding base VuoPort.
virtual VuoType *	getDataVuoType (void)=0
	Returns the type of data carried by this port, or null if this port is event-only.
virtual void	setDataVuoType (VuoType *type)=0
	Sets the type of data carried by this port.
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.
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
	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

Additional Inherited Members
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.

Member Function Documentation

virtual void VuoCompilerPortClass::setDataVuoType ( VuoType *  type )

pure virtual

Sets the type of data carried by this port.

The type must be null if this port is event-only.

Implemented in VuoCompilerEventPortClass, and VuoCompilerTriggerPortClass.

---

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

• compiler/VuoCompilerPortClass.hh
• compiler/VuoCompilerPortClass.cc