VuoCompilerCable Class Reference

Description

Represents a connection from a node's output port to a node's input port.

Public Member Functions
	VuoCompilerCable (VuoCompilerNode *fromNode, VuoCompilerPort *fromPort, VuoCompilerNode *toNode, VuoCompilerPort *toPort)
	Creates a cable from fromNode's fromPort to toNode's toPort.
void	setAlwaysEventOnly (bool isAlwaysEventOnly)
	Sets whether this cable is always event-only.
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.
void	setHidden (bool hidden)
	Sets whether this cable is a hidden ("wireless") cable.
bool	getHidden (void)
	Returns a boolean indicating whether this cable is a hidden ("wireless") cable.
string	getGraphvizDeclaration (void)
	Returns a string containing the declaration for this cable as it would appear in a .vuo (Graphviz dot format) file.
bool	carriesData (void)
	Returns a boolean indicating whether this cable carries data.
void	generateTransmission (Module *module, BasicBlock *block, Value *toNodeContextValue, Value *toPortContextValue, Value *outputDataValue, bool shouldTransmitEvent=true)
	Generates code to transmit the data (if any) and an event (if any) from an output port to an input port.
Public Member Functions inherited from VuoBaseDetail< VuoCable >
	VuoBaseDetail (string description, VuoCable *base)
	Creates a VuoCable detail class.
VuoCable *	getBase (void) const
	Returns the VuoCable detail class instance's base class instance.
void	setBase (VuoCable *base)
	Sets the VuoCable detail class instance's base class instance.

Constructor & Destructor Documentation

VuoCompilerCable::VuoCompilerCable	(	VuoCompilerNode *	fromNode,
		VuoCompilerPort *	fromPort,
		VuoCompilerNode *	toNode,
		VuoCompilerPort *	toPort
	)

Creates a cable from fromNode's fromPort to toNode's toPort.

Member Function Documentation

bool VuoCompilerCable::carriesData

(

void

)

Returns a boolean indicating whether this cable carries data.

void VuoCompilerCable::generateTransmission	(	Module *	module,
		BasicBlock *	block,
		Value *	toNodeContextValue,
		Value *	toPortContextValue,
		Value *	outputDataValue,
		bool	shouldTransmitEvent = true
	)

Generates code to transmit the data (if any) and an event (if any) from an output port to an input port.

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.

string VuoCompilerCable::getGraphvizDeclaration

(

void

)

Returns a string containing the declaration for this cable as it would appear in a .vuo (Graphviz dot format) file.

bool VuoCompilerCable::getHidden

(

void

)

Returns a boolean indicating whether this cable is a hidden ("wireless") cable.

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.

void VuoCompilerCable::setHidden

(

bool

hidden

)

Sets whether this cable is a hidden ("wireless") cable.

---

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

• compiler/VuoCompilerCable.hh
• compiler/VuoCompilerCable.cc