Description

This class represents a published port in a composition.

It maintains a list of the identifiers of internal ports within the composition for which the published port is an alias, but in contrast to a VuoPublishedPort object, does not maintain pointers to the actual port objects.

See also: VuoPublishedPort

Definition at line 142 of file VuoRunner.hh.

Public Member Functions
	Port (string name, string type, json_object *details)
	Creates a dummy published port that is not yet connected to any port in a running composition. More...

string	getName (void)
	Returns the published port's name. More...

string	getType (void)
	Returns the published port's type name, or an empty string if the port is event-only. More...

json_object *	getDetails (void)
	Returns the published port's details. More...

Friends
class	VuoRunner

Constructor & Destructor Documentation

◆ Port()

VuoRunner::Port::Port	(	string	name,
		string	type,
		json_object *	details
	)

Creates a dummy 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 name, or an empty string if the port is event-only.
details	The published port's details (see VuoInputData).

Definition at line 2795 of file VuoRunner.cc.

Member Function Documentation

◆ getDetails()

json_object * VuoRunner::Port::getDetails ( void )

Returns the published port's details.

Keys include:

default — the port's default value
menuItems — an array where each element is one of the following:
- an object with 2 keys: value (string or number: identifier) and name (string: display name)
- the string --- — a menu separator line
- any other string — a non-selectable menu label, for labeling multiple sections within the menu
suggestedMin — the port's suggested minimum value (for use on UI sliders and spinboxes)
suggestedMax — the port's suggested maximum value (for use on UI sliders and spinboxes)
suggestedStep — the port's suggested step (the amount the value changes with each click of a spinbox)

If menuItems contains any values, the host application should display a select widget. Otherwise, the host application should use type to determine the kind of widget to display. Host applications are encouraged to provide widgets for the following specific types:

Definition at line 2845 of file VuoRunner.cc.

◆ getName()

string VuoRunner::Port::getName ( void )

Returns the published port's name.

Definition at line 2805 of file VuoRunner.cc.

◆ getType()

string VuoRunner::Port::getType ( void )

Returns the published port's type name, or an empty string if the port is event-only.

Definition at line 2813 of file VuoRunner.cc.

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

base/VuoRunner.hh
base/VuoRunner.cc