Vuo  1.2.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Friends | List of all members
VuoRunner::Port Class Reference

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

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.
 
string getName (void)
 Returns the published port's name.
 
string getType (void)
 Returns the published port's type name, or an empty string if the port is event-only.
 
json_objectgetDetails (void)
 Returns the published port's details.
 

Friends

class VuoRunner
 

Constructor & Destructor Documentation

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
nameThe published port's name.
typeThe published port's data type name, or an empty string if the port is event-only.
detailsThe published port's details (see VuoInputData).

Member Function Documentation

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 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 types:

string VuoRunner::Port::getName ( void  )

Returns the published port's name.

string VuoRunner::Port::getType ( void  )

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


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