Vuo  1.1.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
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.
 
VuoTypegetType (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.
 
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 setProtocolPort (bool isProtocolPort)
 Sets whether this port is part of any active protocol.
 
bool isProtocolPort (void)
 Returns true if this port is part of any active protocol.
 
- 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.
 
VuoCompilerPublishedPortgetCompiler (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.
 
VuoRendererPublishedPortgetRenderer (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
nameThe published port's name.
typeThe published port's data type, or null if the port is event-only.
isOutputA boolean indicating whether the published port is an output port, as opposed to an input port.
connectedPortsThe 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.

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.

bool VuoPublishedPort::isProtocolPort ( void  )

Returns true if this port is part of any active protocol.

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::setName ( string  name)

Sets the published port's name.

void VuoPublishedPort::setProtocolPort ( bool  isProtocolPort)

Sets whether this port is part of any active protocol.

void VuoPublishedPort::setType ( VuoType type)

Sets the published port's type.


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