Description
This class represents a published port in a composition.
Published ports are visible to clients of the composition, for example to a VuoRunner running the composition or to another composition in which this composition is a subcomposition.
Definition at line 19 of file VuoPublishedPort.hh.
Public Member Functions | |
| VuoPublishedPort (VuoPortClass *portClass) | |
| Creates a published port that is not yet connected to any port in a running composition. More... | |
| void | setProtocolPort (bool protocolPort) |
| Sets whether this port is part of any active protocol. More... | |
| bool | isProtocolPort (void) |
| Returns true if this port is part of any active protocol. More... | |
 Public Member Functions inherited from VuoPort | |
| VuoPort (VuoPortClass *portClass) | |
Creates a base port instance from a portClass. More... | |
| virtual | ~VuoPort (void) |
| to make this class dynamic_cast-able More... | |
| VuoPortClass * | getClass (void) |
| Returns the argument class of this argument. More... | |
| vector< VuoCable * > | getConnectedCables (bool includePublishedCables=true) |
| Returns the cables connected to this port. More... | |
| void | addConnectedCable (VuoCable *cable) |
| Adds a connected cable. More... | |
| void | removeConnectedCable (VuoCable *cable) |
| Removes a connected cable. More... | |
| VuoCable * | getCableConnecting (VuoPort *otherPort) |
Returns the cable connecting this port to or from the provided otherPort, or NULL if no such cable exists. More... | |
| VuoPortClass::EventThrottling | getEventThrottling (void) |
| Returns the event-throttling behavior of this port. More... | |
| void | setEventThrottling (VuoPortClass::EventThrottling eventThrottling) |
| Sets the event-throttling behavior of this port. More... | |
| void | setRawInitialValue (const string &rawInitialValue) |
| Stores the port's original initial value found when parsing it from a Graphviz-formatted composition string. More... | |
| string | getRawInitialValue (void) |
| Returns the port's original initial value found when parsing it from a Graphviz-formatted composition string. More... | |
| void | print (void) |
| Prints info about this port, for debugging. More... | |
| Public Member Functions inherited from VuoBase< VuoCompilerNodeArgument, VuoRendererPort > | |
| VuoBase (string id) | |
| Creates a base class. More... | |
| void | setCompiler (VuoCompilerNodeArgument *compiler) |
| Sets the base class instance's compiler detail class instance. More... | |
| VuoCompilerNodeArgument * | getCompiler (void) const |
| Returns the base class instance's compiler detail class instance. More... | |
| bool | hasCompiler (void) const |
| Returns true if this base class instance has a compiler detail. More... | |
| void | setRenderer (VuoRendererPort *renderer) |
| Sets the base class instance's renderer detail class instance. More... | |
| VuoRendererPort * | getRenderer (void) const |
| Returns the base class instance's renderer detail class instance. More... | |
| bool | hasRenderer (void) const |
| Returns true if this base class instance has a renderer detail. More... | |
Constructor & Destructor Documentation
◆ VuoPublishedPort()
| VuoPublishedPort::VuoPublishedPort | ( | VuoPortClass * | portClass | ) |
Creates a published port that is not yet connected to any port in a running composition.
Definition at line 15 of file VuoPublishedPort.cc.
Member Function Documentation
◆ isProtocolPort()
| bool VuoPublishedPort::isProtocolPort | ( | void | ) |
Returns true if this port is part of any active protocol.
Definition at line 32 of file VuoPublishedPort.cc.
◆ setProtocolPort()
| void VuoPublishedPort::setProtocolPort | ( | bool | protocolPort | ) |
Sets whether this port is part of any active protocol.
Definition at line 24 of file VuoPublishedPort.cc.
The documentation for this class was generated from the following files:
- base/VuoPublishedPort.hh
- base/VuoPublishedPort.cc
