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

Description

A port.

Public Member Functions

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.
 
virtual GlobalVariable * getDataVariable (void)=0
 Returns the variable that stores this port's data, or NULL if this port is event-only.
 
virtual string getIdentifier (void)=0
 Returns a unique, consistent identifier for this port.
 
- Public Member Functions inherited from VuoCompilerNodeArgument
virtual void generateAllocation (Module *module, string nodeInstanceIdentifier)
 Generate the allocation of the argument's runtime representation: a global variable to store the argument's value.
 
virtual LoadInst * generateLoad (BasicBlock *block)
 Generate code to get the port's value.
 
virtual StoreInst * generateStore (Value *value, BasicBlock *block)
 Generate code to set 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

 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.
 
virtual string getVariableBaseName (void)
 Returns a name for this argument, which will be a substring of variable names in the generated code.
 

Additional Inherited Members

- Protected Attributes inherited from VuoCompilerNodeArgument
GlobalVariable * variable
 The global variable in the generated code in which this argument is stored.
 

Constructor & Destructor Documentation

VuoCompilerPort::VuoCompilerPort ( VuoPort basePort)
protected

Creates a compiler detail from a given basePort.

Member Function Documentation

virtual GlobalVariable* VuoCompilerPort::getDataVariable ( void  )
pure virtual

Returns the variable that stores this port's data, or NULL if this port is event-only.

Implemented in VuoCompilerTriggerPort, and VuoCompilerEventPort.

VuoType * VuoCompilerPort::getDataVuoType ( void  )

Returns tthis port's data type, or null if this port is event-only.

If setDataVuoType() has been called, returns that type. Otherwise returns the type from the port class.

virtual string VuoCompilerPort::getIdentifier ( void  )
pure virtual

Returns a unique, consistent identifier for this port.

Implemented in VuoCompilerTriggerPort, and VuoCompilerEventPort.

bool VuoCompilerPort::hasConnectedCable ( bool  includePublishedCables) const

Returns a boolean indicating whether this port has any attached cables.

bool VuoCompilerPort::hasConnectedDataCable ( bool  includePublishedCables) const

Returns a boolean indicating whether this port has any attached data+event cables.

void VuoCompilerPort::setDataVuoType ( VuoType dataType)

Sets the data type for this port, overriding the type from the port class.


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