VuoPort Class Reference

Description

A port instance on a VuoNode instance.

See Also

VuoCompilerPort

VuoRendererPort

Public Member Functions
	VuoPort (VuoPortClass *portClass)
	Creates a base port instance from a portClass.
virtual	~VuoPort (void)
	to make this class dynamic_cast-able
VuoPortClass *	getClass (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.
VuoCable *	getCableConnecting (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.
VuoCompilerNodeArgument *	getCompiler (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.
VuoRendererPort *	getRenderer (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

VuoPort::VuoPort

(

VuoPortClass *

portClass

)

Creates a base port instance from a portClass.

VuoPort::~VuoPort ( void  )

virtual

to make this class dynamic_cast-able

Member Function Documentation

void VuoPort::addConnectedCable

(

VuoCable *

cable

)

Adds a connected cable.

This method is called by the VuoCable constructor as well as VuoCable::setTo / VuoCable::setFrom, and should not normally need to be called otherwise.

VuoCable * VuoPort::getCableConnecting

(

VuoPort *

otherPort

)

Returns the cable connecting this port to or from the provided otherPort, or NULL if no such cable exists.

VuoPortClass * VuoPort::getClass

(

void

)

Returns the argument class of this argument.

vector< VuoCable * > VuoPort::getConnectedCables

(

bool

includePublishedCables = true

)

Returns the cables connected to this port.

The cables are in the order in which they were added, from least to most recent. The input includePublishedCables determines whether cables connected to externally visible published ports are included in the list of returned cables.

VuoPortClass::EventThrottling VuoPort::getEventThrottling

(

void

)

Returns the event-throttling behavior of this port.

Only applies to trigger ports.

void VuoPort::print

(

void

)

Prints info about this port, for debugging.

void VuoPort::removeConnectedCable

(

VuoCable *

cable

)

Removes a connected cable.

This method is called by VuoCable::setTo / VuoCable::setFrom, and should not normally need to be called otherwise.

void VuoPort::setEventThrottling

(

VuoPortClass::EventThrottling

eventThrottling

)

Sets the event-throttling behavior of this port.

Only applies to trigger ports.

---

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

• base/VuoPort.hh
• base/VuoPort.cc