Vuo  0.4
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
VuoPortClass Class Reference

Description

A port type on a VuoNodeClass.

See Also
VuoCompilerPortClass

Public Types

enum  PortType { notAPort, dataAndEventPort, eventOnlyPort, triggerPort }
 Possible port types. More...
 
enum  Conductivity { alwaysConducts, mayConduct, neverConducts }
 Possible conductivity options. More...
 

Public Member Functions

 VuoPortClass (string name, enum PortType portType)
 Creates a base port class.
 
string getName (void)
 Returns the name of this port class.
 
PortType getPortType (void)
 Returns this port's type.
 
Conductivity getConductivity (void)
 Returns this port's conductivity.
 
void setConductivity (Conductivity conductivity)
 Sets this port's conductivity.
 
void print (void)
 Prints info about this port class, for debugging.
 
- Public Member Functions inherited from VuoBase< VuoCompilerNodeArgumentClass, void >
 VuoBase (string id)
 Creates a VuoPortClass base class.
 
void setCompiler (VuoCompilerNodeArgumentClass *compiler)
 Sets the VuoPortClass base class instance's VuoCompilerNodeArgumentClass detail class instance.
 
VuoCompilerNodeArgumentClassgetCompiler (void) const
 Returns the VuoPortClass base class instance's VuoCompilerNodeArgumentClass detail class instance.
 
bool hasCompiler (void) const
 Returns true if this base class instance has a compiler detail.
 
void setRenderer (void *renderer)
 Does nothing.
 
void * getRenderer (void) const
 Does nothing.
 
bool hasRenderer (void) const
 Returns false.
 

Member Enumeration Documentation

Possible conductivity options.

See VuoPortConductivity in node.h.

Enumerator
alwaysConducts 

An event received by this input port is conducted to all output ports.

mayConduct 

An event received by this input port may be conducted to all, some, or none of the output ports.

neverConducts 

An event received by this input port is never conducted to any output port.

Possible port types.

Enumerator
notAPort 

Represents a dummy port, or a VuoCompilerNodeArgumentClass subclass that isn't a port (such as instance data or port data).

dataAndEventPort 

See VuoInputData and VuoOutputData.

eventOnlyPort 

See VuoInputConductor and VuoOutputConductor, and VuoInputReceptor.

triggerPort 

See VuoOutputTrigger.


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