Vuo  1.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
VuoCompilerPublishedPort Class Reference

Description

The compiler detail class for VuoPublishedPort.

Public Member Functions

 VuoCompilerPublishedPort (VuoPort *basePort)
 Creates a published port that is not connected to any port in a running composition.
 
string getIdentifier (void)
 Returns a unique, consistent identifier for this port.
 
void setInitialValue (string initialValueAsString)
 Sets the initial value of the port data.
 
string getInitialValue (void)
 Returns the string representation of the initial value of the port data.
 
json_objectgetDetails (bool isInput)
 Returns details for this published port, such as "suggestedMin".
 
string getGraphvizAttributes (void)
 Returns a string representation of this published port's type and details, as they would appear in the attributes list of a published node declaration within a .vuo (Graphviz DOT format) file.
 
Value * generateCreatePortContext (Module *module, BasicBlock *block)
 Returns null, since VuoCompilerPort::generateCreatePortContext() doesn't mean anything for published ports.
 
- Public Member Functions inherited from VuoCompilerPort
bool hasConnectedCable (void) const
 Returns a boolean indicating whether this port has any attached cables.
 
bool hasConnectedDataCable (void) const
 Returns a boolean indicating whether this port has any attached data+event cables.
 
VuoTypegetDataVuoType (void)
 Returns this 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.
 
void setNodeIdentifier (string nodeIdentifier)
 Sets an identifier that will be part of the string returned by getIdentifier().
 
void setIndexInPortContexts (int indexInPortContexts)
 Sets the index of this node within the array of port contexts within the node context.
 
int getIndexInPortContexts (void)
 Returns the index of this node within the array of port contexts within the node context.
 
void setConstantStringCache (VuoCompilerConstantStringCache *constantStrings)
 Sets the cache used to generate constant string values.
 
Value * getDataVariable (Module *module, BasicBlock *block, Value *nodeContextValue)
 Returns the address of the data field within this port's context.
 
Value * generateGetPortContext (Module *module, BasicBlock *block, Value *nodeContextValue)
 Returns this port's context.
 
- Public Member Functions inherited from VuoCompilerNodeArgument
virtual ~VuoCompilerNodeArgument (void)
 Destructor.
 
- 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.
 

Additional Inherited Members

- Protected Member Functions inherited from VuoCompilerPort
 VuoCompilerPort (VuoPort *basePort)
 Creates a compiler detail from a given basePort.
 
- Protected Attributes inherited from VuoCompilerPort
VuoCompilerConstantStringCacheconstantStrings
 Cache used to generate constant string values.
 

Constructor & Destructor Documentation

VuoCompilerPublishedPort::VuoCompilerPublishedPort ( VuoPort basePort)

Creates a published port that is not connected to any port in a running composition.

Member Function Documentation

Value * VuoCompilerPublishedPort::generateCreatePortContext ( Module *  module,
BasicBlock *  block 
)
virtual

Returns null, since VuoCompilerPort::generateCreatePortContext() doesn't mean anything for published ports.

Implements VuoCompilerPort.

json_object * VuoCompilerPublishedPort::getDetails ( bool  isInput)

Returns details for this published port, such as "suggestedMin".

If the detail was set by a call to setDetail(), then that value is used. Otherwise, the detail's value is coalesced across all connected ports.

Todo:
https://b33p.net/kosada/node/7317
Todo:
https://b33p.net/kosada/node/7317
Todo:
https://b33p.net/kosada/node/7317
string VuoCompilerPublishedPort::getGraphvizAttributes ( void  )

Returns a string representation of this published port's type and details, as they would appear in the attributes list of a published node declaration within a .vuo (Graphviz DOT format) file.

string VuoCompilerPublishedPort::getIdentifier ( void  )
virtual

Returns a unique, consistent identifier for this port.

Reimplemented from VuoCompilerPort.

string VuoCompilerPublishedPort::getInitialValue ( void  )

Returns the string representation of the initial value of the port data.

void VuoCompilerPublishedPort::setInitialValue ( string  initialValueAsString)

Sets the initial value of the port data.

This is the value it has from the time that the composition begins executing until the first time the port data is overwritten.

Parameters
initialValueAsStringString representation of the initial value.

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