Description

A port type on a VuoNodeClass.

Public Types
enum	PortType { notAPort, dataAndEventPort, eventOnlyPort, triggerPort }
	Possible port types. More...

enum	EventBlocking { EventBlocking_None, EventBlocking_Door, EventBlocking_Wall }
	Possible options for event-blocking behavior. 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.

EventBlocking	getEventBlocking (void)
	Returns this port's event-blocking behavior.

void	setEventBlocking (EventBlocking eventBlocking)
	Sets this port's event-blocking behavior.

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.

VuoCompilerNodeArgumentClass *	getCompiler (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 options for event-blocking behavior.

Enumerator
EventBlocking_None	An event received by this input port is transmitted to all output ports.
EventBlocking_Door	An event received by this input port may be transmitted to all, some, or none of the output ports.
EventBlocking_Wall	An event received by this input port is never transmitted 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 `VuoInputEvent` and `VuoOutputEvent`.
triggerPort	See `VuoOutputTrigger`.

Creates a base port class.

VuoPortClass::EventBlocking VuoPortClass::getEventBlocking ( void )

Returns this port's event-blocking behavior.

string VuoPortClass::getName ( void )

Returns the name of this port class.

VuoPortClass::PortType VuoPortClass::getPortType ( void )

Returns this port's type.

void VuoPortClass::print ( void )

Prints info about this port class, for debugging.

void VuoPortClass::setEventBlocking ( VuoPortClass::EventBlocking eventBlocking )

Sets this port's event-blocking behavior.

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