Terminal Class Reference

Public Member Functions
string	name (void)
TerminalList *	connectedList (void)
bool	connect (Terminal &connectTo)
void	disconnect (Terminal &disconnectFrom)
void	disconnectAll (void)
unsigned int	inConnectFlags (void)
unsigned int	outConnectFlags (void)

Detailed Description

The Terminal class represents an input or output Terminal of a Node. Terminals can be connected to other Terminals of other Nodes, thus specifying the properties of the NodeGraph.

Member Function Documentation

bool Terminal::connect

(

Terminal &

connectTo)

Connects this Terminal to the specified Terminal.

Parameters

connectTo

The Terminal to connect to.

Returns

True if successful, false otherwise.

TerminalList* Terminal::connectedList

(

void

)

Returns a list of all Terminals this Terminal is connected to.

Returns

A list of Terminals connected to this Terminal.

void Terminal::disconnect

(

Terminal &

disconnectFrom)

Disconnect this Terminal from the specified Terminal.

Parameters

disconnectFrom

The Terminal to disconnect from.

void Terminal::disconnectAll

(

void

)

Disconnects all connections of the Terminal.

unsigned int Terminal::inConnectFlags

(

void

)

Returns the in connection flags, if this flag is non zero, this terminal is a left sided Terminal of the Node (i.e. an input Terminal).

Returns

The in connect flags.

string Terminal::name

(

void

)

Returns the name of the Terminal.

Returns

The name of the Terminal.

unsigned int Terminal::outConnectFlags

(

void

)

Returns the out connection flags, if this flag is non zero, this terminal is a right sided Terminal of the Node (i.e. an output Terminal).

Returns

The out connect flags.