Description

This class represents a protocol.

A protocol consists of an ordered list of published port names and their associated types.

Public Member Functions
	VuoProtocol (string protocolName)
	Creates a protocol.

string	getName (void)
	Returns the name of the protocol.

vector< pair< string, VuoType * > >	getInputPortNamesAndTypes (void)
	Returns an ordered list of the published input port names associated with this protocol, along with their types.

vector< pair< string, VuoType * > >	getOutputPortNamesAndTypes (void)
	Returns an ordered list of the published output port names associated with this protocol, along with their types.

bool	hasInputPort (string portName)
	Returns a boolean indicating whether the protocol has an input port with the provided `portName`.

bool	hasOutputPort (string portName)
	Returns a boolean indicating whether the protocol has an output port with the provided `portName`.

VuoType *	getTypeForInputPort (string portName)
	Returns the type associated with the input port that has the provided `portName`.

VuoType *	getTypeForOutputPort (string portName)
	Returns the type associated with the output port that has the provided `portName`.

void	addInputPort (string portName, VuoType *portType)
	Adds a published input port to the protocol.

void	addOutputPort (string portName, VuoType *portType)
	Adds a published output port to the protocol.

Constructor & Destructor Documentation

VuoProtocol::VuoProtocol ( string protocolName )

Creates a protocol.

Parameters

protocolName The name of the protocol, for display purposes.

void VuoProtocol::addInputPort	(	string	portName,
		VuoType *	portType
	)

Adds a published input port to the protocol.

Parameters

portName	The name of the input port.
portType	The type of the input port.

void VuoProtocol::addOutputPort	(	string	portName,
		VuoType *	portType
	)

Adds a published output port to the protocol.

Parameters

portName	The name of the output port.
portType	The type of the output port.

vector< pair< string, VuoType * > > VuoProtocol::getInputPortNamesAndTypes ( void )

Returns an ordered list of the published input port names associated with this protocol, along with their types.

string VuoProtocol::getName ( void )

Returns the name of the protocol.

vector< pair< string, VuoType * > > VuoProtocol::getOutputPortNamesAndTypes ( void )

Returns an ordered list of the published output port names associated with this protocol, along with their types.

VuoType * VuoProtocol::getTypeForInputPort ( string portName )

Returns the type associated with the input port that has the provided portName.

VuoType * VuoProtocol::getTypeForOutputPort ( string portName )

Returns the type associated with the output port that has the provided portName.

bool VuoProtocol::hasInputPort ( string portName )

Returns a boolean indicating whether the protocol has an input port with the provided portName.

bool VuoProtocol::hasOutputPort ( string portName )

Returns a boolean indicating whether the protocol has an output port with the provided portName.

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