Description

A port type on a VuoNodeClass.

See also: VuoCompilerPortClass

Definition at line 21 of file VuoPortClass.hh.

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

enum	EventBlocking { EventBlocking_None , EventBlocking_Door , EventBlocking_Wall }
	Options for event-blocking behavior. More...

enum	EventThrottling { EventThrottling_Enqueue , EventThrottling_Drop }
	Options for event-throttling behavior. More...

Public Member Functions
	VuoPortClass (string name, enum PortType portType)
	Creates a base port class. More...

string	getName (void)
	Returns the name of this port class. More...

void	setName (string name)
	Sets the name of this port class. More...

PortType	getPortType (void)
	Returns this port's type. More...

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

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

bool	hasPortAction (void)
	Returns true if this port has a port action (causes something special to happen when it receives an event). More...

void	setPortAction (bool portAction)
	Sets whether this port has a port action. More...

EventThrottling	getDefaultEventThrottling (void)
	Returns the default event-throttling behavior of ports of this port class. More...

void	setDefaultEventThrottling (EventThrottling eventThrottling)
	Sets the default event-throttling behavior of ports of this port class. More...

void	print (void)
	Prints info about this port class, for debugging. More...

Public Member Functions inherited from VuoBase< VuoCompilerNodeArgumentClass, void >
	VuoBase (string id)
	Creates a base class. More...

void	setCompiler (VuoCompilerNodeArgumentClass *compiler)
	Sets the base class instance's compiler detail class instance. More...

VuoCompilerNodeArgumentClass *	getCompiler (void) const
	Returns the base class instance's compiler detail class instance. More...

bool	hasCompiler (void) const
	Returns true if this base class instance has a compiler detail. More...

void	setRenderer (void *renderer)
	Sets the base class instance's renderer detail class instance. More...

void *	getRenderer (void) const
	Returns the base class instance's renderer detail class instance. More...

bool	hasRenderer (void) const
	Returns true if this base class instance has a renderer detail. More...

Member Enumeration Documentation

◆ EventBlocking

enum VuoPortClass::EventBlocking

Options for event-blocking behavior.

See VuoInputEvent in node.h.

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.

Definition at line 38 of file VuoPortClass.hh.

◆ EventThrottling

enum VuoPortClass::EventThrottling

Options for event-throttling behavior.

See VuoOutputTrigger in node.h.

Enumerator
EventThrottling_Enqueue	An event fired from this port is eventually transmitted downstream.
EventThrottling_Drop	An event fired from this port is dropped if it would have to wait on nodes downstream.

Definition at line 48 of file VuoPortClass.hh.

◆ PortType

enum VuoPortClass::PortType

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`.

Definition at line 27 of file VuoPortClass.hh.

Constructor & Destructor Documentation

◆ VuoPortClass()

VuoPortClass::VuoPortClass	(	string	name,
		enum PortType	portType
	)

Creates a base port class.

Definition at line 15 of file VuoPortClass.cc.

Member Function Documentation

◆ getDefaultEventThrottling()

VuoPortClass::EventThrottling VuoPortClass::getDefaultEventThrottling ( void )

Returns the default event-throttling behavior of ports of this port class.

Only applies to trigger ports. A port may override this.

Definition at line 86 of file VuoPortClass.cc.

◆ getEventBlocking()

VuoPortClass::EventBlocking VuoPortClass::getEventBlocking ( void )

Returns this port's event-blocking behavior.

Definition at line 52 of file VuoPortClass.cc.

◆ getName()

string VuoPortClass::getName ( void )

Returns the name of this port class.

Definition at line 28 of file VuoPortClass.cc.

◆ getPortType()

VuoPortClass::PortType VuoPortClass::getPortType ( void )

Returns this port's type.

Definition at line 44 of file VuoPortClass.cc.

◆ hasPortAction()

bool VuoPortClass::hasPortAction ( void )

Returns true if this port has a port action (causes something special to happen when it receives an event).

Only applies to input ports.

Definition at line 69 of file VuoPortClass.cc.

◆ print()

void VuoPortClass::print ( void )

Prints info about this port class, for debugging.

Definition at line 103 of file VuoPortClass.cc.

◆ setDefaultEventThrottling()

void VuoPortClass::setDefaultEventThrottling ( VuoPortClass::EventThrottling eventThrottling )

Sets the default event-throttling behavior of ports of this port class.

Only applies to trigger ports. A port may override this.

Definition at line 95 of file VuoPortClass.cc.

◆ setEventBlocking()

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

Sets this port's event-blocking behavior.

Definition at line 60 of file VuoPortClass.cc.

◆ setName()

void VuoPortClass::setName ( string name )

Sets the name of this port class.

Definition at line 36 of file VuoPortClass.cc.

◆ setPortAction()

void VuoPortClass::setPortAction ( bool portAction )

Sets whether this port has a port action.