Description

A generator output port type.

Public Member Functions
	VuoCompilerGeneratorPortClass (string name, PointerType *type)
	Creates a generator output port.

VuoCompilerPort *	newPort (void)
	Creates a new port based on this port type, and creates its corresponding base `VuoPort`.

FunctionType *	getFunctionType (void)
	Returns the `FunctionType` pointed to by this port's `PointerType` parameter in its node class's event/init functions.

VuoType *	getDataVuoType (void)
	Returns the type of the data transmitted by this generator, as set in `setDataVuoType`.

void	setDataVuoType (VuoType *type)
	Sets the type of the data transmitted by this generator.

Additional Inherited Members
Protected Member Functions inherited from VuoCompilerPortClass
	VuoCompilerPortClass (string name, VuoPortClass::PortType portType, Type *type, bool inEventFunction, size_t indexInEventFunction, bool inInitFunction, size_t indexInInitFunction)
	Creates a port type and creates its corresponding base `VuoPortClass`.

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.

Constructor & Destructor Documentation

VuoCompilerGeneratorPortClass::VuoCompilerGeneratorPortClass	(	string	name,
		PointerType *	type
	)

Creates a generator output port.

Upon creation, isInEventFunction and isInInitFunction both return false.

Parameters

name	The port's identifier and display name.
type	A `PointerType` pointing to a FunctionType which has 0 or 1 parameter. The parameter indicates the type of data, if any, transmitted by the port alongside the generated event.

void VuoCompilerGeneratorPortClass::setDataVuoType ( VuoType * type )

Sets the type of the data transmitted by this generator.

Its VuoCompilerType may be null (but needs to be non-null by the time the graph is compiled).

If the VuoCompilerType is not null, then its LLVM type should equal the first parameter of this port's function type.

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