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.
Definition at line 147 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 |
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.
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 2680 of file VuoRunner.cc.
json_object * VuoRunner::Port::getDetails | ( | void | ) |
Returns the published port's details.
Keys include:
default
— the port's default valuemenuItems
— an array where each element is an object with 2 keys: value
(string: identifier) and name
(string: display name)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 type
s:
Definition at line 2727 of file VuoRunner.cc.
string VuoRunner::Port::getName | ( | void | ) |
Returns the published port's name.
Definition at line 2690 of file VuoRunner.cc.
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 2698 of file VuoRunner.cc.