Description
Represents a connection from a node's output port to a node's input port.
Definition at line 22 of file VuoCompilerCable.hh.
Public Member Functions | |
| VuoCompilerCable (VuoCompilerNode *fromNode, VuoCompilerPort *fromPort, VuoCompilerNode *toNode, VuoCompilerPort *toPort, bool addCableToPorts=true) | |
Creates a cable from fromNode's fromPort to toNode's toPort. More... | |
| void | setAlwaysEventOnly (bool isAlwaysEventOnly) |
| Sets whether this cable is always event-only. More... | |
| bool | getAlwaysEventOnly (void) |
| Returns a boolean indicating whether this cable is always event-only, regardless of the data-carrying status of its from-port and to-port. More... | |
| void | setHidden (bool hidden) |
| Sets whether this cable is a hidden ("wireless") cable. More... | |
| bool | getHidden (void) |
| Returns a boolean indicating whether this cable is a hidden ("wireless") cable. More... | |
| string | getGraphvizDeclaration (void) |
| Returns a string containing the declaration for this cable as it would appear in a .vuo (Graphviz dot format) file. More... | |
| bool | carriesData (void) |
| Returns a boolean indicating whether this cable carries data. More... | |
| void | generateTransmission (Module *module, BasicBlock *block, Value *toNodeContextValue, Value *toPortContextValue, Value *outputDataPointer, bool shouldTransmitEvent=true) |
| Generates code to transmit the data (if any) and an event (if any) from an output port to an input port. More... | |
 Public Member Functions inherited from VuoBaseDetail< VuoCable > | |
| VuoBaseDetail (string description, VuoCable *base) | |
| Creates a detail class. More... | |
| VuoCable * | getBase (void) const |
| Returns the detail class instance's base class instance. More... | |
| void | setBase (VuoCable *base) |
| Sets the detail class instance's base class instance. More... | |
Constructor & Destructor Documentation
◆ VuoCompilerCable()
| VuoCompilerCable::VuoCompilerCable | ( | VuoCompilerNode * | fromNode, |
| VuoCompilerPort * | fromPort, | ||
| VuoCompilerNode * | toNode, | ||
| VuoCompilerPort * | toPort, | ||
| bool | addCableToPorts = true |
||
| ) |
Creates a cable from fromNode's fromPort to toNode's toPort.
Definition at line 25 of file VuoCompilerCable.cc.
Member Function Documentation
◆ carriesData()
| bool VuoCompilerCable::carriesData | ( | void | ) |
Returns a boolean indicating whether this cable carries data.
Definition at line 140 of file VuoCompilerCable.cc.
◆ generateTransmission()
| void VuoCompilerCable::generateTransmission | ( | Module * | module, |
| BasicBlock * | block, | ||
| Value * | toNodeContextValue, | ||
| Value * | toPortContextValue, | ||
| Value * | outputDataPointer, | ||
| bool | shouldTransmitEvent = true |
||
| ) |
Generates code to transmit the data (if any) and an event (if any) from an output port to an input port.
Definition at line 167 of file VuoCompilerCable.cc.
◆ getAlwaysEventOnly()
| bool VuoCompilerCable::getAlwaysEventOnly | ( | void | ) |
Returns a boolean indicating whether this cable is always event-only, regardless of the data-carrying status of its from-port and to-port.
Definition at line 51 of file VuoCompilerCable.cc.
◆ getGraphvizDeclaration()
| string VuoCompilerCable::getGraphvizDeclaration | ( | void | ) |
Returns a string containing the declaration for this cable as it would appear in a .vuo (Graphviz dot format) file.
Definition at line 86 of file VuoCompilerCable.cc.
◆ getHidden()
| bool VuoCompilerCable::getHidden | ( | void | ) |
Returns a boolean indicating whether this cable is a hidden ("wireless") cable.
Definition at line 67 of file VuoCompilerCable.cc.
◆ setAlwaysEventOnly()
| void VuoCompilerCable::setAlwaysEventOnly | ( | bool | isEventOnly | ) |
Sets whether this cable is always event-only.
If true, the cable is always event-only, even if its from-port and to-port can both carry data. If false, the cable is event-only only if its from-port and/or to-port is event-only.
Definition at line 42 of file VuoCompilerCable.cc.
◆ setHidden()
| void VuoCompilerCable::setHidden | ( | bool | hidden | ) |
Sets whether this cable is a hidden ("wireless") cable.
Definition at line 59 of file VuoCompilerCable.cc.
The documentation for this class was generated from the following files:
- compiler/VuoCompilerCable.hh
- compiler/VuoCompilerCable.cc
