VuoCompilerDriver Class Reference

Description

This class represents a driver for a protocol.

Definition at line 20 of file VuoCompilerDriver.hh.

Public Member Functions
bool	isValidDriverForProtocol (VuoProtocol *protocol)
	Returns a boolean indicating whether this driver is valid for the provided protocol. More...
void	applyToComposition (VuoCompilerComposition *composition, VuoCompiler *compiler, bool canPublishedInputsBeEdited=true)
	Applies this driver to the provided composition. More...

Static Public Member Functions
static VuoCompilerDriver *	driverForProtocol (VuoCompiler *compiler, string protocolId)
	Creates a new driver for the specified protocol. More...

Member Function Documentation

applyToComposition()

void VuoCompilerDriver::applyToComposition	(	VuoCompilerComposition *	composition,
		VuoCompiler *	compiler,
		bool	canPublishedInputsBeEdited = true
	)

Applies this driver to the provided composition.

Bridges the driver with the composition by matching published output ports within the driver to identically named and typed published input ports within the composition, and vice versa, and re-routing their connected cables appropriately.

Definition at line 104 of file VuoCompilerDriver.cc.

driverForProtocol()

VuoCompilerDriver * VuoCompilerDriver::driverForProtocol ( VuoCompiler *  compiler, string  protocolId  )

static

Creates a new driver for the specified protocol.

Definition at line 29 of file VuoCompilerDriver.cc.

isValidDriverForProtocol()

bool VuoCompilerDriver::isValidDriverForProtocol

(

VuoProtocol *

protocol

)

Returns a boolean indicating whether this driver is valid for the provided protocol.

A driver is valid for a given protocol if, for each of the driver's published outputs, the protocol has a published input with the same name and type, and for each of the driver's published inputs, the protocol has a published output with the same name and type. The protocol may have additional published inputs and outputs and still be compatible with the driver.

Definition at line 60 of file VuoCompilerDriver.cc.

---

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

• compiler/VuoCompilerDriver.hh
• compiler/VuoCompilerDriver.cc