VuoCompilerTriggerPort Class Reference

Description

A trigger output port.

See Also

{VuoCompilerTriggerPortClass}

Public Member Functions
	VuoCompilerTriggerPort (VuoPort *basePort)
	Creates a trigger port based on portClass.
void	generateAllocation (Module *module, string nodeInstanceIdentifier)
	Does nothing.
LoadInst *	generateLoad (BasicBlock *block)
	Does nothing.
StoreInst *	generateStore (Value *value, BasicBlock *block)
	Does nothing.
void	setFunction (Function *function)
	Sets the function that's called each time the trigger port generates a push.
Function *	getFunction (void)
	Returns the function that's called each time the trigger port generates a push.
VuoCompilerTriggerPortClass *	getClass (void)
	Returns the trigger port class of this trigger port.
string	getIdentifier (void)
	Returns a unique, consistent identifier for this port.
Public Member Functions inherited from VuoCompilerPort
bool	hasConnectedCable (bool includePublishedCables) const
	Returns a boolean indicating whether this port has any attached cables.
bool	hasConnectedDataCable (bool includePublishedCables) const
	Returns a boolean indicating whether this port has any attached data+event cables.
VuoType *	getDataVuoType (void)
	Returns tthis port's data type, or null if this port is event-only.
void	setDataVuoType (VuoType *dataType)
	Sets the data type for this port, overriding the type from the port class.
Public Member Functions inherited from VuoCompilerNodeArgument
GlobalVariable *	getVariable (void)
	Returns the global variable to store the argument's value, if generateAllocation has been called.
Public Member Functions inherited from VuoBaseDetail< VuoPort >
	VuoBaseDetail (string description, VuoPort *base)
	Creates a VuoNode detail class.
VuoPort *	getBase (void) const
	Returns the VuoNode detail class instance's base class instance.
void	setBase (VuoPort *base)
	Sets the VuoNode detail class instance's base class instance.

Additional Inherited Members
Protected Member Functions inherited from VuoCompilerPort
	VuoCompilerPort (VuoPort *basePort)
	Creates a compiler detail from a given basePort.
Protected Attributes inherited from VuoCompilerNodeArgument
GlobalVariable *	variable
	The global variable in the generated code in which this argument is stored.

Constructor & Destructor Documentation

VuoCompilerTriggerPort::VuoCompilerTriggerPort

(

VuoPort *

basePort

)

Creates a trigger port based on portClass.

Member Function Documentation

void VuoCompilerTriggerPort::generateAllocation ( Module *  module, string  nodeInstanceIdentifier  )

virtual

Does nothing.

Reimplemented from VuoCompilerNodeArgument.

LoadInst * VuoCompilerTriggerPort::generateLoad ( BasicBlock *  block )

virtual

Does nothing.

Reimplemented from VuoCompilerNodeArgument.

StoreInst * VuoCompilerTriggerPort::generateStore ( Value *  value, BasicBlock *  block  )

virtual

Does nothing.

Reimplemented from VuoCompilerNodeArgument.

VuoCompilerTriggerPortClass * VuoCompilerTriggerPort::getClass

(

void

)

Returns the trigger port class of this trigger port.

Function * VuoCompilerTriggerPort::getFunction

(

void

)

Returns the function that's called each time the trigger port generates a push.

string VuoCompilerTriggerPort::getIdentifier ( void  )

virtual

Returns a unique, consistent identifier for this port.

Assumes generateAllocation has been called.

Implements VuoCompilerPort.

void VuoCompilerTriggerPort::setFunction

(

Function *

function

)

Sets the function that's called each time the trigger port generates a push.

---

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

• compiler/VuoCompilerTriggerPort.hh
• compiler/VuoCompilerTriggerPort.cc