torc::router::RouteTreeNode Class Reference

An object that holds more complete path information for routing and tracing. More...

#include <RouteTreeNode.hpp>

Inheritance diagram for torc::router::RouteTreeNode:

Inheritance graph
[legend]
Collaboration diagram for torc::router::RouteTreeNode:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 RouteTreeNode ()
 Null Constructor.
 RouteTreeNode (Tilewire inSource, Tilewire inSink, boost::int32_t inCost, RouteTreeNode *inParent)
 Public Constructor.
 RouteTreeNode (Arc inArc, boost::int32_t inCost, RouteTreeNode *inParent)
 Public Constructor.
 ~RouteTreeNode ()
 Destructor.
void addChildren (const std::vector< RouteTreeNode * > &newChildren)
 Add children to the node.
void makeParent (const Tilewire &inSource, const Tilewire &inSink)
 Allocate a new node and make it the parent of this node.
boost::uint16_t getNumChildren ()
 Get the number of children.
RouteTreeNodegetChild (unsigned int index)
 Get a child by index, returns 0 for invalid index.
void normalizeDepth ()
 Normalize depth of nodes.

Protected Member Functions

void adjustDepth (int adjustment)
 Recursively adjust node depths.

Protected Attributes

RouteTreeNodemOnlyChild
 Pointer to a child node that is the only one.
std::vector< RouteTreeNode * > * mChildren
 Pointer to a vector of child nodes that is dynamically allocated.

Private Types

typedef std::vector
< RouteTreeNode * >::iterator 
RouteTreeNodeIterator


Detailed Description

An object that holds more complete path information for routing and tracing.

Definition at line 37 of file RouteTreeNode.hpp.


Constructor & Destructor Documentation

torc::router::RouteTreeNode::RouteTreeNode (  )  [inline]

Null Constructor.

Definition at line 50 of file RouteTreeNode.hpp.

torc::router::RouteTreeNode::RouteTreeNode ( Tilewire  inSource,
Tilewire  inSink,
boost::int32_t  inCost,
RouteTreeNode inParent 
) [inline]

Public Constructor.

Definition at line 52 of file RouteTreeNode.hpp.

torc::router::RouteTreeNode::RouteTreeNode ( Arc  inArc,
boost::int32_t  inCost,
RouteTreeNode inParent 
) [inline]

Public Constructor.

Definition at line 63 of file RouteTreeNode.hpp.

torc::router::RouteTreeNode::~RouteTreeNode (  )  [inline]

Destructor.

Definition at line 72 of file RouteTreeNode.hpp.


Member Function Documentation

void torc::router::RouteTreeNode::addChildren ( const std::vector< RouteTreeNode * > &  newChildren  )  [inline]

Add children to the node.

Definition at line 85 of file RouteTreeNode.hpp.

void torc::router::RouteTreeNode::makeParent ( const Tilewire inSource,
const Tilewire inSink 
) [inline]

Allocate a new node and make it the parent of this node.

Definition at line 115 of file RouteTreeNode.hpp.

boost::uint16_t torc::router::RouteTreeNode::getNumChildren (  )  [inline]

Get the number of children.

Definition at line 123 of file RouteTreeNode.hpp.

RouteTreeNode* torc::router::RouteTreeNode::getChild ( unsigned int  index  )  [inline]

Get a child by index, returns 0 for invalid index.

Definition at line 129 of file RouteTreeNode.hpp.

void torc::router::RouteTreeNode::normalizeDepth (  )  [inline]

Normalize depth of nodes.

Definition at line 135 of file RouteTreeNode.hpp.

void torc::router::RouteTreeNode::adjustDepth ( int  adjustment  )  [inline, protected]

Recursively adjust node depths.

Definition at line 143 of file RouteTreeNode.hpp.


Member Data Documentation

Pointer to a child node that is the only one.

Definition at line 43 of file RouteTreeNode.hpp.

Pointer to a vector of child nodes that is dynamically allocated.

Definition at line 45 of file RouteTreeNode.hpp.


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

Generated on Thu Oct 13 16:51:04 2011 for TORC by  doxygen 1.5.6