Vuo  1.2.2
 All Classes Namespaces 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.

Public Member Functions

 VuoPublishedPort (VuoPortClass *portClass)
 Creates a published port that is not yet connected to any port in a running composition.
 
void setProtocolPort (bool protocolPort)
 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 VuoPort
 VuoPort (VuoPortClass *portClass)
 Creates a base port instance from a portClass.
 
virtual ~VuoPort (void)
 to make this class dynamic_cast-able
 
VuoPortClassgetClass (void)
 Returns the argument class of this argument.
 
vector< VuoCable * > getConnectedCables (bool includePublishedCables=true)
 Returns the cables connected to this port.
 
void addConnectedCable (VuoCable *cable)
 Adds a connected cable.
 
void removeConnectedCable (VuoCable *cable)
 Removes a connected cable.
 
VuoCablegetCableConnecting (VuoPort *otherPort)
 Returns the cable connecting this port to or from the provided otherPort, or NULL if no such cable exists.
 
VuoPortClass::EventThrottling getEventThrottling (void)
 Returns the event-throttling behavior of this port.
 
void setEventThrottling (VuoPortClass::EventThrottling eventThrottling)
 Sets the event-throttling behavior of this port.
 
void print (void)
 Prints info about this port, for debugging.
 
- Public Member Functions inherited from VuoBase< VuoCompilerNodeArgument, VuoRendererPort >
 VuoBase (string id)
 Creates a VuoPort base class.
 
void setCompiler (VuoCompilerNodeArgument *compiler)
 Sets the VuoPort base class instance's VuoCompilerNodeArgument detail class instance.
 
VuoCompilerNodeArgumentgetCompiler (void) const
 Returns the VuoPort base class instance's VuoCompilerNodeArgument detail class instance.
 
bool hasCompiler (void) const
 Returns true if this base class instance has a compiler detail.
 
void setRenderer (VuoRendererPort *renderer)
 Sets the VuoPort base class instance's VuoRendererPort detail class instance.
 
VuoRendererPortgetRenderer (void) const
 Returns the VuoPort base class instance's VuoRendererPort detail class instance.
 
bool hasRenderer (void) const
 Returns true if this base class instance has a renderer detail.
 

Constructor & Destructor Documentation

VuoPublishedPort::VuoPublishedPort ( VuoPortClass portClass)

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

Member Function Documentation

bool VuoPublishedPort::isProtocolPort ( void  )

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

void VuoPublishedPort::setProtocolPort ( bool  protocolPort)

Sets whether this port is part of any active protocol.


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