Vuo  1.0.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VuoCompilerEventPort Class Referenceabstract

Description

A passive (non-trigger) port, optionally with data.

Public Member Functions

void generateAllocation (Module *module, string nodeInstanceIdentifier)
 Generates code to allocate this port.
 
StoreInst * generateStore (Value *value, BasicBlock *block)
 Generates code to set the port's value to value.
 
StoreInst * generateStore (bool pushed, BasicBlock *block)
 Generates code to set the port's value to bool value.
 
string getIdentifier (void)
 Returns a unique, consistent identifier for this port.
 
virtual VuoCompilerDatagetData (void)=0
 Returns this port's data, or NULL if none.
 
VuoCompilerTypegetDataType (void)
 Returns the type of this port's data, or NULL if none.
 
- 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.
 
VuoTypegetDataVuoType (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
virtual LoadInst * generateLoad (BasicBlock *block)
 Generate code to get the port's value.
 
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.
 
VuoPortgetBase (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.
 

Protected Member Functions

 VuoCompilerEventPort (VuoPort *basePort)
 Creates a passive (non-trigger) port from the specified portClass.
 
Constant * getBoolConstant (bool value)
 Returns constant with value value.
 
string getVariableBaseName (void)
 Distinguishes the variable for the event from the variable for the data in data-and-event ports.
 
- Protected Member Functions inherited from VuoCompilerPort
 VuoCompilerPort (VuoPort *basePort)
 Creates a compiler detail from a given basePort.
 
- Protected Member Functions inherited from VuoCompilerNodeArgument
 VuoCompilerNodeArgument (VuoPort *basePort)
 Creates an argument instance based on the specified argumentClass.
 

Protected Attributes

VuoCompilerDatadata
 Optional data stored in this port.
 

Constructor & Destructor Documentation

VuoCompilerEventPort::VuoCompilerEventPort ( VuoPort basePort)
protected

Creates a passive (non-trigger) port from the specified portClass.

Member Function Documentation

void VuoCompilerEventPort::generateAllocation ( Module *  module,
string  nodeInstanceIdentifier 
)
virtual

Generates code to allocate this port.

Reimplemented from VuoCompilerNodeArgument.

StoreInst * VuoCompilerEventPort::generateStore ( Value *  value,
BasicBlock *  block 
)
virtual

Generates code to set the port's value to value.

Reimplemented from VuoCompilerNodeArgument.

StoreInst * VuoCompilerEventPort::generateStore ( bool  pushed,
BasicBlock *  block 
)

Generates code to set the port's value to bool value.

Constant * VuoCompilerEventPort::getBoolConstant ( bool  value)
protected

Returns constant with value value.

virtual VuoCompilerData* VuoCompilerEventPort::getData ( void  )
pure virtual

Returns this port's data, or NULL if none.

Implemented in VuoCompilerOutputEventPort, and VuoCompilerInputEventPort.

VuoCompilerType * VuoCompilerEventPort::getDataType ( void  )

Returns the type of this port's data, or NULL if none.

string VuoCompilerEventPort::getIdentifier ( void  )
virtual

Returns a unique, consistent identifier for this port.

Assumes generateAllocation has been called.

Implements VuoCompilerPort.

string VuoCompilerEventPort::getVariableBaseName ( void  )
protectedvirtual

Distinguishes the variable for the event from the variable for the data in data-and-event ports.

Reimplemented from VuoCompilerNodeArgument.

Member Data Documentation

VuoCompilerData* VuoCompilerEventPort::data
protected

Optional data stored in this port.


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