Node Class Reference

Inheritance diagram for Node:

Public Member Functions
string	name (void)
void	setName (string)
int	id (void)
ParameterContainer *	paramContainer (void)
NodeGraph *	parentGraph (void)
NodeGraph *	rootGraph (void)
NodeGraph *	toNodeGraph (void)
NodeDescriptor *	descriptor (void)
TerminalList *	terminalList (void)
Terminal *	terminal (string name)

Detailed Description

Represents an element in a NodeGraph.

The Node class represents an element in a NodeGraph. As the NodeGraph class inherits from Node, a Node can possible also represent a NodeGraph class, to convert the Node to a NodeGraph, call toNodeGraph() (if possible). Nodes can be constructed via the NodeGraph::addNode() command. The type of a node is uniquely identified by it's path or uuid, both can be queried using the NodeDescriptor class. Once created, each node has a unique Node::id() inside the NodeGraph.

Member Function Documentation

NodeDescriptor* Node::descriptor

(

void

)

Returns the NodeDescriptor of the node which can be used to query specifics about the Node's type.

Returns

The NodeDescriptor of the Node.

int Node::id

(

void

)

Each Node or NodeGraph has a unique id inside the whole Graph hierarchy.

Returns

The id of the Node.

string Node::name

(

void

)

Returns the name of the Node.

Returns

The name of the Node.

ParameterContainer* Node::paramContainer

(

void

)

Returns the ParameterContainer of this Node. Each Node has a ParameterContainer specifying its attributes and settings.

Returns

The ParameterContainer of the Node.

NodeGraph* Node::parentGraph

(

void

)

Returns the parent NodeGraph this Node or NodeGraph resides in.

Returns

The parent NodeGraph.

NodeGraph* Node::rootGraph

(

void

)

Returns the root NodeGraph of this Graph hierarchy.

Returns

The root NodeGraph.

void Node::setName

(

string

)

Sets the name of the Node to the specified string.

Terminal* Node::terminal

(

string

name)

Returns the Terminal of the given name.

Parameters

The	name of the Terminal.

Returns

The Terminal or null if no terminal of the name could be found.

TerminalList* Node::terminalList

(

void

)

Returns a list of all Terminals of the Node.

Returns

The TerminalList of all Terminals of the Node.

NodeGraph* Node::toNodeGraph

(

void

)

If this Node actually represents a NodeGraph, returns the NodeGraph representation. Otherwise 0.

Returns

The NodeGraph or 0, if this Node does not represent a NodeGraph.