VuoCompilerInputDataClass Class Reference

Description

The data type for a data-and-event input port.

Public Member Functions
	VuoCompilerInputDataClass (string name, Type *type, bool twoParameters)
	True if this event function parameter in the node class implementation is lowered to two parameters in the LLVM bitcode.
VuoCompilerData *	newData (void)
	Creates a data instance based on this data type.
string	getDefaultValue (void)
	Returns the string representation of the default initial value of port data instantiated from this data type.
bool	isLoweredToTwoParameters (void)
	Returns true if, in the node event function, Clang converts this one parameter in source code to two parameters in the compiled bitcode.
Public Member Functions inherited from VuoCompilerDataClass
	~VuoCompilerDataClass (void)
	Destructor.
VuoType *	getVuoType (void)
	Returns the VuoType for this port data, as set in setVuoType.
void	setVuoType (VuoType *vuoType)
	Sets the VuoType for this port data.
Type *	getType (void)
	Returns the LLVM type for this port data's Vuo type.
void	setDetails (struct json_object *details)
	Sets details for this port data.
json_object *	getDetails (void)
	Returns details for this port data, set in setDetails().
Public Member Functions inherited from VuoCompilerNodeArgumentClass
virtual	~VuoCompilerNodeArgumentClass (void)
	to make this class dynamic_cast-able
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.

Additional Inherited Members
Protected Member Functions inherited from VuoCompilerDataClass
	VuoCompilerDataClass (string name, Type *type)
	Creates a data type for a data-and-event port.
Protected Attributes inherited from VuoCompilerDataClass
struct json_object *	details
	Metadata specified in the node class implementation, such as the default value.

Constructor & Destructor Documentation

VuoCompilerInputDataClass::VuoCompilerInputDataClass	(	string	name,
		Type *	type,
		bool	twoParameters
	)

True if this event function parameter in the node class implementation is lowered to two parameters in the LLVM bitcode.

Creates a data type for a data-and-event input port.

The default data value for instances of this data type is not set. Set it with setDefaultValue.

Member Function Documentation

string VuoCompilerInputDataClass::getDefaultValue

(

void

)

Returns the string representation of the default initial value of port data instantiated from this data type.

bool VuoCompilerInputDataClass::isLoweredToTwoParameters

(

void

)

Returns true if, in the node event function, Clang converts this one parameter in source code to two parameters in the compiled bitcode.

VuoCompilerData * VuoCompilerInputDataClass::newData ( void  )

virtual

Creates a data instance based on this data type.

Implements VuoCompilerDataClass.

---

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

• compiler/VuoCompilerInputDataClass.hh
• compiler/VuoCompilerInputDataClass.cc