Isis::ControlNet::ControlVertex Class Reference

Encapsulation of a vertex in a minimum spanning tree. More...

Collaboration diagram for Isis::ControlNet::ControlVertex:

Public Member Functions
	ControlVertex (ControlCubeGraphNode *node)
	Construct a vertex from a Graph Node. More...
	ControlVertex (ControlPoint *point)
	Construct a vertex from a Control Point. More...
	~ControlVertex ()
	Does not own any of its private data. More...
void	setParent (ControlVertex *v)
	Set the parent vertex, removing the root node status. More...
ControlVertex *	getRoot ()
	Get the root node, or greatest ancestor. More...
ControlVertex *	getParent ()
	Get the parent node. A root node has no parent. More...
ControlCubeGraphNode *	getNode ()
	Get the node representation of this vertex. More...
ControlPoint *	getPoint ()
	Get the point representation of this vertex. More...

Static Public Member Functions
static void	join (ControlVertex *v1, ControlVertex *v2)
	Join two nodes by setting one root to be the other's parent. More...

Private Attributes
ControlCubeGraphNode *	m_node
	The possibly non-existant graph node. More...
ControlPoint *	m_point
	The possibly non-existant control point. More...
ControlVertex *	m_parent
	The possibly non-existant parent vertex. More...

Detailed Description

Encapsulation of a vertex in a minimum spanning tree.

Can be either a Control Point or a Graph Node. Each vertex is connected to another by a measure. A vertex without a parent vertex is considered a root node, or the base of its own tree.

Author

????-??-?? Unknown

Definition at line 363 of file ControlNet.h.

Constructor & Destructor Documentation

Isis::ControlNet::ControlVertex::ControlVertex ( ControlCubeGraphNode *  node )

inline

Construct a vertex from a Graph Node.

Definition at line 366 of file ControlNet.h.

References m_node, m_parent, and m_point.

Isis::ControlNet::ControlVertex::ControlVertex ( ControlPoint *  point )

inline

Construct a vertex from a Control Point.

Definition at line 373 of file ControlNet.h.

References m_node, m_parent, and m_point.

Isis::ControlNet::ControlVertex::~ControlVertex ( )

inline

Does not own any of its private data.

Definition at line 380 of file ControlNet.h.

Member Function Documentation

ControlCubeGraphNode* Isis::ControlNet::ControlVertex::getNode ( )

inline

Get the node representation of this vertex.

Definition at line 397 of file ControlNet.h.

References m_node.

ControlVertex* Isis::ControlNet::ControlVertex::getParent ( )

inline

Get the parent node. A root node has no parent.

Definition at line 394 of file ControlNet.h.

References m_parent.

Referenced by getRoot().

ControlPoint* Isis::ControlNet::ControlVertex::getPoint ( )

inline

Get the point representation of this vertex.

Definition at line 400 of file ControlNet.h.

References m_point.

Referenced by Isis::ControlNet::MinimumSpanningTree().

ControlVertex* Isis::ControlNet::ControlVertex::getRoot ( )

inline

Get the root node, or greatest ancestor.

Definition at line 386 of file ControlNet.h.

References getParent().

Referenced by join(), and Isis::ControlNet::MinimumSpanningTree().

static void Isis::ControlNet::ControlVertex::join ( ControlVertex *  v1, ControlVertex *  v2  )

inlinestatic

Join two nodes by setting one root to be the other's parent.

Definition at line 403 of file ControlNet.h.

References getRoot(), and setParent().

void Isis::ControlNet::ControlVertex::setParent ( ControlVertex *  v )

inline

Set the parent vertex, removing the root node status.

Definition at line 383 of file ControlNet.h.

References m_parent.

Referenced by join().

Member Data Documentation

ControlCubeGraphNode* Isis::ControlNet::ControlVertex::m_node

private

The possibly non-existant graph node.

Definition at line 409 of file ControlNet.h.

Referenced by ControlVertex(), and getNode().

ControlVertex* Isis::ControlNet::ControlVertex::m_parent

private

The possibly non-existant parent vertex.

Definition at line 415 of file ControlNet.h.

Referenced by ControlVertex(), getParent(), and setParent().

ControlPoint* Isis::ControlNet::ControlVertex::m_point

private

The possibly non-existant control point.

Definition at line 412 of file ControlNet.h.

Referenced by ControlVertex(), and getPoint().

---

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

• src/control/objs/ControlNet/ControlNet.h