Vuo  2.3.2
Public Member Functions | Static Public Member Functions | List of all members
VuoCompilerInputEventPort Class Reference

Description

An input port, optionally with data.

Definition at line 20 of file VuoCompilerInputEventPort.hh.

Public Member Functions

 VuoCompilerInputEventPort (VuoPort *basePort)
 Creates an input port based on the specified portClass. More...
 
VuoCompilerInputDatagetData (void)
 Returns this port's data, or NULL if none. More...
 
- Public Member Functions inherited from VuoCompilerEventPort
Value * generateCreatePortContext (Module *module, BasicBlock *block)
 Generates code to create a heap-allocated PortContext. More...
 
Value * generateLoadEvent (Module *module, BasicBlock *block, Value *nodeContextValue, Value *portContextValue=NULL)
 Generates code to get the current event value for this port. More...
 
void generateStoreEvent (Module *module, BasicBlock *block, Value *nodeContextValue, Value *eventValue, Value *portContextValue=NULL)
 Generates code to update the event value for this port. More...
 
void generateStoreEvent (Module *module, BasicBlock *block, Value *nodeContextValue, bool event, Value *portContextValue=NULL)
 Generates code to update the event value for this port. More...
 
Value * generateRetrieveData (Module *module, BasicBlock *block, Value *nodeContextValue, Value *portContextValue=NULL)
 Generates code to get a pointer to the current data value for this port. More...
 
void generateReplaceData (Module *module, BasicBlock *block, Value *nodeContextValue, Value *dataPointer, Value *portContextValue=NULL)
 Generates code to update the data value for this port, handling the memory management for replacing the old data value. More...
 
VuoCompilerTypegetDataType (void)
 Returns the type of this port's data, or NULL if none. More...
 
- Public Member Functions inherited from VuoCompilerPort
bool hasConnectedCable (void) const
 Returns a boolean indicating whether this port has any attached cables. More...
 
bool hasConnectedDataCable (void) const
 Returns a boolean indicating whether this port has any attached data+event cables. More...
 
VuoTypegetDataVuoType (void)
 Returns this port's data type, or null if this port is event-only. More...
 
void setDataVuoType (VuoType *dataType)
 Sets the data type for this port, overriding the type from the port class. More...
 
void setNodeIdentifier (string nodeIdentifier)
 Sets an identifier that will be part of the string returned by getIdentifier(). More...
 
virtual string getIdentifier (void)
 Returns a unique, consistent identifier for this port. More...
 
void setIndexInPortContexts (int indexInPortContexts)
 Sets the index of this node within the array of port contexts within the node context. More...
 
int getIndexInPortContexts (void)
 Returns the index of this node within the array of port contexts within the node context. More...
 
void setConstantsCache (VuoCompilerConstantsCache *constantsCache)
 Sets the cache used to generate constant string values. More...
 
Value * getDataVariable (Module *module, BasicBlock *block, Value *nodeContextValue)
 Returns the address of the data field within this port's context. More...
 
Value * generateGetPortContext (Module *module, BasicBlock *block, Value *nodeContextValue)
 Returns this port's context. More...
 
- Public Member Functions inherited from VuoCompilerNodeArgument
virtual ~VuoCompilerNodeArgument (void)
 Destructor. More...
 
- Public Member Functions inherited from VuoBaseDetail< VuoPort >
 VuoBaseDetail (string description, VuoPort *base)
 Creates a detail class. More...
 
VuoPortgetBase (void) const
 Returns the detail class instance's base class instance. More...
 
void setBase (VuoPort *base)
 Sets the detail class instance's base class instance. More...
 

Static Public Member Functions

static VuoCompilerInputEventPortnewPort (string name, VuoType *type)
 Creates a VuoCompilerInputEventPort along with its VuoCompilerInputEventPortClass. More...
 

Additional Inherited Members

- Protected Member Functions inherited from VuoCompilerEventPort
 VuoCompilerEventPort (VuoPort *basePort)
 Creates a passive (non-trigger) port from the specified portClass. More...
 
- Protected Member Functions inherited from VuoCompilerPort
 VuoCompilerPort (VuoPort *basePort)
 Creates a compiler detail from a given basePort. More...
 
- Protected Member Functions inherited from VuoCompilerNodeArgument
 VuoCompilerNodeArgument (VuoPort *basePort)
 Creates an argument instance based on the specified argumentClass. More...
 
- Protected Attributes inherited from VuoCompilerEventPort
VuoCompilerDatadata
 Optional data stored in this port. More...
 
- Protected Attributes inherited from VuoCompilerPort
VuoCompilerConstantsCacheconstantsCache
 Cache used to generate constant string values. More...
 

Constructor & Destructor Documentation

◆ VuoCompilerInputEventPort()

VuoCompilerInputEventPort::VuoCompilerInputEventPort ( VuoPort basePort)

Creates an input port based on the specified portClass.

Definition at line 36 of file VuoCompilerInputEventPort.cc.

Member Function Documentation

◆ getData()

VuoCompilerInputData * VuoCompilerInputEventPort::getData ( void  )
virtual

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

Implements VuoCompilerEventPort.

Definition at line 44 of file VuoCompilerInputEventPort.cc.

◆ newPort()

VuoCompilerInputEventPort * VuoCompilerInputEventPort::newPort ( string  name,
VuoType type 
)
static

Creates a VuoCompilerInputEventPort along with its VuoCompilerInputEventPortClass.

Definition at line 19 of file VuoCompilerInputEventPort.cc.


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