Vuo
1.0.0
|
A published input port.
Public Member Functions | |
VuoCompilerPublishedInputPort (string name, VuoType *type, const set< VuoCompilerPort * > &connectedPorts, VuoCompilerTriggerPort *triggerPort) | |
Creates a published port that is not connected to any port in a composition. | |
VuoPort * | getVuoPseudoPort (void) |
Returns the base port belonging to the "vuo.in" pseudo-node and associated with this published port. | |
VuoCompilerTriggerPort * | getTriggerPort (void) |
Returns the trigger port that implements events fired via this published port. | |
void | setTriggerPort (VuoCompilerTriggerPort *port) |
Sets the trigger port that implements events fired via this published port. | |
string | getInitialValue (void) |
Returns the JSON-formatted representation of the initial value of the published port data. | |
void | setInitialValue (string initialValueAsString) |
Sets the initial value of the published port data. | |
Public Member Functions inherited from VuoCompilerPublishedPort | |
~VuoCompilerPublishedPort (void) | |
Destructor. | |
set< string > | getConnectedPortIdentifiers (void) |
Returns the identifiers of the internal ports for which this published port is an alias. | |
json_object * | getDetails (void) |
Returns details for this published port, such as "suggestedMin". | |
void | setDetail (string key, string value) |
Sets the value of a detail for this published port. | |
void | unsetDetail (string key) |
Unsets the value of a detail for this published port. | |
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. | |
Public Member Functions inherited from VuoBaseDetail< VuoPublishedPort > | |
VuoBaseDetail (string description, VuoPublishedPort *base) | |
Creates a VuoPublishedPort detail class. | |
VuoPublishedPort * | getBase (void) const |
Returns the VuoPublishedPort detail class instance's base class instance. | |
void | setBase (VuoPublishedPort *base) |
Sets the VuoPublishedPort detail class instance's base class instance. | |
Additional Inherited Members | |
Protected Member Functions inherited from VuoCompilerPublishedPort | |
VuoCompilerPublishedPort (string name, VuoType *type, bool isOutput, const set< VuoCompilerPort * > &connectedPorts=set< VuoCompilerPort * >()) | |
Creates a published port that is not connected to any port in a running composition. | |
Protected Attributes inherited from VuoCompilerPublishedPort | |
struct json_object * | details |
Metadata specified in the serialized composition, such as the default value. | |
VuoCompilerPublishedInputPort::VuoCompilerPublishedInputPort | ( | string | name, |
VuoType * | type, | ||
const set< VuoCompilerPort * > & | connectedPorts, | ||
VuoCompilerTriggerPort * | triggerPort | ||
) |
Creates a published port that is not connected to any port in a composition.
name | A name for the published port. |
type | A type for the published port. |
connectedPorts | A non-empty set of ports, all having the same data type. |
triggerPort | The trigger port that implements events fired via this published port. |
string VuoCompilerPublishedInputPort::getInitialValue | ( | void | ) |
Returns the JSON-formatted representation of the initial value of the published port data.
VuoCompilerTriggerPort * VuoCompilerPublishedInputPort::getTriggerPort | ( | void | ) |
Returns the trigger port that implements events fired via this published port.
|
virtual |
Returns the base port belonging to the "vuo.in" pseudo-node and associated with this published port.
Implements VuoCompilerPublishedPort.
void VuoCompilerPublishedInputPort::setInitialValue | ( | string | initialValueAsString | ) |
Sets the initial value of the published 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.
initialValueAsString | JSON-formatted representation of the initial value. |
void VuoCompilerPublishedInputPort::setTriggerPort | ( | VuoCompilerTriggerPort * | port | ) |
Sets the trigger port that implements events fired via this published port.