VuoCompilerNodeArgumentClass Class Reference

Description

A parameter to a node's event and/or init function.

To create an argument to pass for this parameter, instantiate a VuoCompilerNodeArgument.

See Also

VuoPortClass

Public Member Functions
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
	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
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

VuoCompilerNodeArgumentClass::VuoCompilerNodeArgumentClass ( string  name, VuoPortClass::PortType  portType, Type *  type  )

protected

Creates a parameter for calling a node's event or init function, and creates its corresponding base VuoPortClass.

VuoCompilerNodeArgumentClass::~VuoCompilerNodeArgumentClass ( void  )

protectedvirtual

to make this class dynamic_cast-able

Member Function Documentation

size_t VuoCompilerNodeArgumentClass::getIndexInCallbackStartFunction

(

void

)

Returns the index of this port's parameter in its node class's callback start function.

Assumes this port is known to be one of the parameters in its node class's callback start function.

size_t VuoCompilerNodeArgumentClass::getIndexInCallbackStopFunction

(

void

)

Returns the index of this port's parameter in its node class's callback stop function.

Assumes this port is known to be one of the parameters in its node class's callback stop function.

size_t VuoCompilerNodeArgumentClass::getIndexInCallbackUpdateFunction

(

void

)

Returns the index of this port's parameter in its node class's callback update function.

Assumes this port is known to be one of the parameters in its node class's callback update function.

size_t VuoCompilerNodeArgumentClass::getIndexInEventFunction

(

void

)

Returns the index of this port's parameter in its node class's event function.

Assumes this port is known to be one of the parameters in its node class's event function.

size_t VuoCompilerNodeArgumentClass::getIndexInInitFunction

(

void

)

Returns the index of this port's parameter in its node class's init function.

Assumes this port is known to be one of the parameters in its node class's init function.

Type * VuoCompilerNodeArgumentClass::getType ( void  )

virtual

Returns the type of this argument.

Reimplemented in VuoCompilerDataClass.

bool VuoCompilerNodeArgumentClass::isInCallbackStartFunction

(

void

)

Returns true if this is known to be one of the parameters in its node class's callback start function.

bool VuoCompilerNodeArgumentClass::isInCallbackStopFunction

(

void

)

Returns true if this is known to be one of the parameters in its node class's callback stop function.

bool VuoCompilerNodeArgumentClass::isInCallbackUpdateFunction

(

void

)

Returns true if this is known to be one of the parameters in its node class's callback update function.

bool VuoCompilerNodeArgumentClass::isInEventFunction

(

void

)

Returns true if this is known to be one of the parameters in its node class's event function.

bool VuoCompilerNodeArgumentClass::isInInitFunction

(

void

)

Returns true if this is known to be one of the parameters in its node class's init function.

void VuoCompilerNodeArgumentClass::setIndexInCallbackStartFunction

(

size_t

indexInCallbackStartFunction

)

Indicates that this is the parameter at index indexInCallbackStartFunction in its node class's callback start function.

void VuoCompilerNodeArgumentClass::setIndexInCallbackStopFunction

(

size_t

indexInCallbackStopFunction

)

Indicates that this is the parameter at index indexInCallbackStopFunction in its node class's callback stop function.

void VuoCompilerNodeArgumentClass::setIndexInCallbackUpdateFunction

(

size_t

indexInCallbackUpdateFunction

)

Indicates that this is the parameter at index indexInCallbackUpdateFunction in its node class's callback update function.

void VuoCompilerNodeArgumentClass::setIndexInEventFunction

(

size_t

indexInEventFunction

)

Indicates that this is the parameter at index indexInEventFunction in its node class's event function.

void VuoCompilerNodeArgumentClass::setIndexInInitFunction

(

size_t

indexInInitFunction

)

Indicates that this is the parameter at index indexInInitFunction in its node class's init function.

Member Data Documentation

bool VuoCompilerNodeArgumentClass::inCallbackStartFunction

protected

Does this parameter appear in the node's callback start function?

bool VuoCompilerNodeArgumentClass::inCallbackStopFunction

protected

Does this parameter appear in the node's callback stop function?

bool VuoCompilerNodeArgumentClass::inCallbackUpdateFunction

protected

Does this parameter appear in the node's callback update function?

size_t VuoCompilerNodeArgumentClass::indexInCallbackStartFunction

protected

Where this parameter appears in the node's callback start function's parameter list.

size_t VuoCompilerNodeArgumentClass::indexInCallbackStopFunction

protected

Where this parameter appears in the node's callback stop function's parameter list.

size_t VuoCompilerNodeArgumentClass::indexInCallbackUpdateFunction

protected

Where this parameter appears in the node's callback update function's parameter list.

size_t VuoCompilerNodeArgumentClass::indexInEventFunction

protected

Where this parameter appears in the node's event function's parameter list.

size_t VuoCompilerNodeArgumentClass::indexInInitFunction

protected

Where this parameter appears in the node's init function's parameter list.

bool VuoCompilerNodeArgumentClass::inEventFunction

protected

Does this parameter appear in the node's event function?

bool VuoCompilerNodeArgumentClass::inInitFunction

protected

Does this parameter appear in the node's init function?

Type* VuoCompilerNodeArgumentClass::type

protected

The parameter's type.

---

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

• compiler/VuoCompilerNodeArgumentClass.hh
• compiler/VuoCompilerNodeArgumentClass.cc