VuoCompilerPublishedPort Class Reference

Description

The compiler detail class for VuoPublishedPort.

Public Member Functions
	~VuoCompilerPublishedPort (void)
	Destructor.
set< string >	getConnectedPortIdentifiers (void)
	Returns the identifiers of the internal ports for which this published port is an alias.
virtual VuoPort *	getVuoPseudoPort (void)=0
	Returns the associated port belonging to the composition's published ("vuo.in" or "vuo.out") pseudo-node.
json_object *	getDetails (void)
	Returns details for this published port, such as "suggestedMin".
void	setDetail (string key, string value)
	Sets the value of a detail for this published port.
void	unsetDetail (string key)
	Unsets the value of a detail for this published port.
string	getGraphvizAttributes (void)
	Returns a string representation of this published port's type and details, as they would appear in the attributes list of a published node declaration within a .vuo (Graphviz DOT format) file.
Public Member Functions inherited from VuoBaseDetail< VuoPublishedPort >
	VuoBaseDetail (string description, VuoPublishedPort *base)
	Creates a VuoPublishedPort detail class.
VuoPublishedPort *	getBase (void) const
	Returns the VuoPublishedPort detail class instance's base class instance.
void	setBase (VuoPublishedPort *base)
	Sets the VuoPublishedPort detail class instance's base class instance.

Protected Member Functions
	VuoCompilerPublishedPort (string name, VuoType *type, bool isOutput, const set< VuoCompilerPort * > &connectedPorts=set< VuoCompilerPort * >())
	Creates a published port that is not connected to any port in a running composition.

Protected Attributes
struct json_object *	details
	Metadata specified in the serialized composition, such as the default value.

Constructor & Destructor Documentation

VuoCompilerPublishedPort::~VuoCompilerPublishedPort

(

void

)

Destructor.

VuoCompilerPublishedPort::VuoCompilerPublishedPort ( string  name, VuoType *  type, bool  isOutput, const set< VuoCompilerPort * > &  connectedPorts = set<VuoCompilerPort *>()  )

protected

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

Parameters

name	A name for the published port.
type	A type for the published port.
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

set< string > VuoCompilerPublishedPort::getConnectedPortIdentifiers

(

void

)

Returns the identifiers of the internal ports for which this published port is an alias.

Assumes generateAllocation has been called on each VuoCompilerPort that was passed to the constructor.

json_object * VuoCompilerPublishedPort::getDetails

(

void

)

Returns details for this published port, such as "suggestedMin".

If the detail was set by a call to setDetail(), then that value is used. Otherwise, the detail's value is coalesced across all connected ports.

Todo:

https://b33p.net/kosada/node/7317

Todo:

https://b33p.net/kosada/node/7317

Todo:

https://b33p.net/kosada/node/7317

string VuoCompilerPublishedPort::getGraphvizAttributes

(

void

)

Returns a string representation of this published port's type and details, as they would appear in the attributes list of a published node declaration within a .vuo (Graphviz DOT format) file.

virtual VuoPort* VuoCompilerPublishedPort::getVuoPseudoPort ( void  )

pure virtual

Returns the associated port belonging to the composition's published ("vuo.in" or "vuo.out") pseudo-node.

Implemented in VuoCompilerPublishedInputPort, and VuoCompilerPublishedOutputPort.

void VuoCompilerPublishedPort::setDetail	(	string	key,
		string	value
	)

Sets the value of a detail for this published port.

The previous detail value for key (if any) is replaced by value.

void VuoCompilerPublishedPort::unsetDetail

(

string

key

)

Unsets the value of a detail for this published port.

The previous detail value for key (if any) is removed.

Member Data Documentation

struct json_object* VuoCompilerPublishedPort::details

protected

Metadata specified in the serialized composition, such as the default value.

---

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

• compiler/VuoCompilerPublishedPort.hh
• compiler/VuoCompilerPublishedPort.cc