VuoPublishedPort Class Reference

Description

This class represents a published port in a composition.

Published ports are visible to clients of the composition, for example to a VuoRunner running the composition or to another composition in which this composition is a subcomposition.

See Also

VuoCompilerPublishedPort

VuoRendererPublishedPort

Public Member Functions
	VuoPublishedPort (string name, VuoType *type, bool isOutput, set< VuoPort * > connectedPorts=set< VuoPort * >())
	Creates a published port that is not yet connected to any port in a running composition.
string	getName (void)
	Returns the published port's name.
VuoType *	getType (void)
	Returns the published port's type, or null if the port is event-only.
bool	getInput (void) const
	Returns a boolean indicating whether this published port is an input port.
bool	getOutput (void) const
	Returns a boolean indicating whether this published port is an output port.
string	getInitialValue (void) const
	Returns the string representation of the initial value of the published port data.
set< VuoPort * >	getConnectedPorts (void)
	Returns the set of pointers to VuoCompilerPort objects for which this published port is an alias.
bool	hasConnectedPort (VuoPort *port)
	Returns a boolean indicating whether the published port is an alias for the given internal port.
void	addConnectedPort (VuoPort *port)
	Adds the specified port to the list of internal ports for which this published port is an alias.
void	removeConnectedPort (VuoPort *port)
	Removes the specified port from the list of internal ports for which this published port is an alias.
void	setName (string name)
	Sets the published port's name.
void	setType (VuoType *type)
	Sets the published port's type.
void	setInitialValue (string initialValueAsString)
	Sets the initial value of the published port data.
Public Member Functions inherited from VuoBase< VuoCompilerPublishedPort, VuoRendererPublishedPort >
	VuoBase (string id)
	Creates a VuoPublishedPort base class.
void	setCompiler (VuoCompilerPublishedPort *compiler)
	Sets the VuoPublishedPort base class instance's VuoCompilerPublishedPort detail class instance.
VuoCompilerPublishedPort *	getCompiler (void) const
	Returns the VuoPublishedPort base class instance's VuoCompilerPublishedPort detail class instance.
bool	hasCompiler (void) const
	Returns true if this base class instance has a compiler detail.
void	setRenderer (VuoRendererPublishedPort *renderer)
	Sets the VuoPublishedPort base class instance's VuoRendererPublishedPort detail class instance.
VuoRendererPublishedPort *	getRenderer (void) const
	Returns the VuoPublishedPort base class instance's VuoRendererPublishedPort detail class instance.
bool	hasRenderer (void) const
	Returns true if this base class instance has a renderer detail.

Constructor & Destructor Documentation

VuoPublishedPort::VuoPublishedPort	(	string	name,
		VuoType *	type,
		bool	isOutput,
		set< VuoPort * >	connectedPorts = set<VuoPort *>()
	)

Creates a published port that is not yet connected to any port in a running composition.

Parameters

name	The published port's name.
type	The published port's data type, or null if the port is event-only.
isOutput	A boolean indicating whether the published port is an output port, as opposed to an input port.
connectedPorts	The set of ports within the composition for which this published port is an alias.

Member Function Documentation

void VuoPublishedPort::addConnectedPort

(

VuoPort *

port

)

Adds the specified port to the list of internal ports for which this published port is an alias.

set< VuoPort * > VuoPublishedPort::getConnectedPorts

(

void

)

Returns the set of pointers to VuoCompilerPort objects for which this published port is an alias.

string VuoPublishedPort::getInitialValue

(

void

)

const

Returns the string representation of the initial value of the published port data.

bool VuoPublishedPort::getInput

(

void

)

const

Returns a boolean indicating whether this published port is an input port.

string VuoPublishedPort::getName

(

void

)

Returns the published port's name.

bool VuoPublishedPort::getOutput

(

void

)

const

Returns a boolean indicating whether this published port is an output port.

VuoType * VuoPublishedPort::getType

(

void

)

Returns the published port's type, or null if the port is event-only.

bool VuoPublishedPort::hasConnectedPort

(

VuoPort *

port

)

Returns a boolean indicating whether the published port is an alias for the given internal port.

void VuoPublishedPort::removeConnectedPort

(

VuoPort *

port

)

Removes the specified port from the list of internal ports for which this published port is an alias.

void VuoPublishedPort::setInitialValue

(

string

initialValueAsString

)

Sets the initial value of the published port data.

This is the value it has from the time that the composition begins executing until the first time the port data is overwritten.

Parameters

initialValueAsString

String representation of the initial value.

void VuoPublishedPort::setName

(

string

name

)

Sets the published port's name.

void VuoPublishedPort::setType

(

VuoType *

type

)

Sets the published port's type.

---

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

• base/VuoPublishedPort.hh
• base/VuoPublishedPort.cc