Description
A port instance on a VuoNode instance.
- See also
- VuoCompilerPort
- VuoRendererPort
Definition at line 25 of file VuoPort.hh.
Public Member Functions | |
| 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
◆ VuoPort()
| VuoPort::VuoPort | ( | VuoPortClass * | portClass | ) |
Creates a base port instance from a portClass.
Definition at line 19 of file VuoPort.cc.
◆ ~VuoPort()
|
virtual |
to make this class dynamic_cast-able
Definition at line 26 of file VuoPort.cc.
Member Function Documentation
◆ addConnectedCable()
| void VuoPort::addConnectedCable | ( | VuoCable * | cable | ) |
Adds a connected cable.
This method is called by the VuoCable constructor as well as VuoCable::setTo / VuoCable::setFrom, and should not normally need to be called otherwise.
Definition at line 77 of file VuoPort.cc.
◆ getCableConnecting()
Returns the cable connecting this port to or from the provided otherPort, or NULL if no such cable exists.
Definition at line 60 of file VuoPort.cc.
◆ getClass()
| VuoPortClass * VuoPort::getClass | ( | void | ) |
Returns the argument class of this argument.
Definition at line 33 of file VuoPort.cc.
◆ getConnectedCables()
| vector< VuoCable * > VuoPort::getConnectedCables | ( | bool | includePublishedCables = true | ) |
Returns the cables connected to this port.
The cables are in the order in which they were added, from least to most recent. The input includePublishedCables determines whether cables connected to externally visible published ports are included in the list of returned cables.
Definition at line 44 of file VuoPort.cc.
◆ getEventThrottling()
| VuoPortClass::EventThrottling VuoPort::getEventThrottling | ( | void | ) |
Returns the event-throttling behavior of this port.
Only applies to trigger ports.
Definition at line 95 of file VuoPort.cc.
◆ getRawInitialValue()
| string VuoPort::getRawInitialValue | ( | void | ) |
Returns the port's original initial value found when parsing it from a Graphviz-formatted composition string.
This is useful for preserving the constant value when the port is on a node that lacks a VuoCompilerNode. It is not useful for checking the current constant value of a port when the VuoCompilerNode is present; see VuoCompilerInputEventPort.
Definition at line 122 of file VuoPort.cc.
◆ print()
| void VuoPort::print | ( | void | ) |
Prints info about this port, for debugging.
Definition at line 130 of file VuoPort.cc.
◆ removeConnectedCable()
| void VuoPort::removeConnectedCable | ( | VuoCable * | cable | ) |
Removes a connected cable.
This method is called by VuoCable::setTo / VuoCable::setFrom, and should not normally need to be called otherwise.
Definition at line 87 of file VuoPort.cc.
◆ setEventThrottling()
| void VuoPort::setEventThrottling | ( | VuoPortClass::EventThrottling | eventThrottling | ) |
Sets the event-throttling behavior of this port.
Only applies to trigger ports.
Definition at line 103 of file VuoPort.cc.
◆ setRawInitialValue()
| void VuoPort::setRawInitialValue | ( | const string & | rawInitialValue | ) |
Stores the port's original initial value found when parsing it from a Graphviz-formatted composition string.
Definition at line 111 of file VuoPort.cc.
The documentation for this class was generated from the following files:
- base/VuoPort.hh
- base/VuoPort.cc
