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.
VuoPortClass *	getClass (void)
	Returns the argument class of this argument.
vector< VuoCable * >	getConnectedCables (bool includePublishedCables)
	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.
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.

Member Function Documentation

void VuoPort::addConnectedCable

(

VuoCable *

cable

)

Adds a connected cable.

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

)

Returns the cables connected to this port.

The input includePublishedCables determines whether cables connected to externally visible published ports are included in the list of returned cables.

void VuoPort::print

(

void

)

Prints info about this port, for debugging.

void VuoPort::removeConnectedCable

(

VuoCable *

cable

)

Removes a connected cable.

---

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

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