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`.

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 *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.

bool VuoCompilerCable::carriesData ( void )

Returns a boolean indicating whether this cable carries data.

void VuoCompilerCable::generateTransmission	(	Module *	module,
		BasicBlock *	block,
		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.

string VuoCompilerCable::getGraphvizDeclaration ( void )

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

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