VR-Forces 4.1 Class Documentation
List of all members | Signals | Public Member Functions | Protected Slots | Protected Attributes | Private Member Functions
DtEchelonHierarchyNode Class Reference

class DtEchelonHierarchyNode: More...

Inheritance diagram for DtEchelonHierarchyNode:
Inheritance graph
[legend]

Signals

void parentChanged (const DtModelKey &myKey)
 Emitted whenever the parent pointer is changed.

Public Member Functions

 DtEchelonHierarchyNode (const DtModelKey &key)
 default constructor
virtual ~DtEchelonHierarchyNode ()
 destructor
virtual const DtPtrQList
< DtEchelonHierarchyNode * > & 
childList () const
virtual const DtPtrQList
< DtEchelonHierarchyNode * > & 
previousChildList () const
virtual void addChild (DtEchelonHierarchyNode *child)
virtual void removeChild (DtEchelonHierarchyNode *child)
virtual void removeAllChildren ()
virtual const
DtEchelonHierarchyNode
parent () const
virtual DtEchelonHierarchyNodeparent ()
virtual void setParent (DtEchelonHierarchyNode *parent)
 Sets the parent pointer.
virtual void invalidateParent ()
 Sets the parentValid flag to false.
virtual bool parentValid () const
 Returns the parentValid flag.
virtual void setHeight (int value)
 Set/Get the height of this node in the hierarchy.
virtual int height () const
virtual int parentHeight () const
 Get the parent height of this node in the hierarchy.
virtual const DtModelKeymodelKey () const
virtual void setModelKey (const DtModelKey &key)
virtual bool isLeaf () const
virtual bool isRoot () const
virtual const
DtEchelonHierarchyNode
root () const
virtual DtEchelonHierarchyNoderoot ()
virtual bool hasChild (const DtModelKey &) const
 Returns true if the supplied key is in the immediate or other children of this object.

Protected Slots

virtual void parentDestroyed ()

Protected Attributes

DtModelKey myModelKey
int myHeight
 Key to model data.
DtEchelonHierarchyNodemyParent
bool myParentValid
DtPtrQList
< DtEchelonHierarchyNode * > 
myChildren
DtPtrQList
< DtEchelonHierarchyNode * > 
myPreviousChildren

Private Member Functions

 DtEchelonHierarchyNode (const DtEchelonHierarchyNode &orig)
 copy constructor
DtEchelonHierarchyNodeoperator= (const DtEchelonHierarchyNode &orig)
 assignment operator

Detailed Description

class DtEchelonHierarchyNode:

Instances of DtEchelonHierarchyNode are used to represent the objects in an echelon hierarchy.

Constructor & Destructor Documentation

DtEchelonHierarchyNode::DtEchelonHierarchyNode ( const DtModelKey key)

default constructor

virtual DtEchelonHierarchyNode::~DtEchelonHierarchyNode ( )
virtual

destructor

DtEchelonHierarchyNode::DtEchelonHierarchyNode ( const DtEchelonHierarchyNode orig)
private

copy constructor

Member Function Documentation

virtual const DtPtrQList<DtEchelonHierarchyNode*>& DtEchelonHierarchyNode::childList ( ) const
virtual
virtual const DtPtrQList<DtEchelonHierarchyNode*>& DtEchelonHierarchyNode::previousChildList ( ) const
virtual
virtual void DtEchelonHierarchyNode::addChild ( DtEchelonHierarchyNode child)
virtual
virtual void DtEchelonHierarchyNode::removeChild ( DtEchelonHierarchyNode child)
virtual
virtual void DtEchelonHierarchyNode::removeAllChildren ( )
virtual
virtual const DtEchelonHierarchyNode* DtEchelonHierarchyNode::parent ( ) const
virtual
virtual DtEchelonHierarchyNode* DtEchelonHierarchyNode::parent ( )
virtual
virtual void DtEchelonHierarchyNode::setParent ( DtEchelonHierarchyNode parent)
virtual

Sets the parent pointer.

Emits parentChanged if parent is different from original value. Sets the parentValid flag to true.

virtual void DtEchelonHierarchyNode::invalidateParent ( )
virtual

Sets the parentValid flag to false.

Setting the parent will set the flag to true.

virtual bool DtEchelonHierarchyNode::parentValid ( ) const
virtual

Returns the parentValid flag.

virtual void DtEchelonHierarchyNode::setHeight ( int  value)
virtual

Set/Get the height of this node in the hierarchy.

A height of zero indicates a leaf node.

virtual int DtEchelonHierarchyNode::height ( ) const
virtual
virtual int DtEchelonHierarchyNode::parentHeight ( ) const
virtual

Get the parent height of this node in the hierarchy.

If the parent height is equal to the height then this node has no parent and is a root node.

virtual const DtModelKey& DtEchelonHierarchyNode::modelKey ( ) const
virtual
virtual void DtEchelonHierarchyNode::setModelKey ( const DtModelKey key)
virtual
virtual bool DtEchelonHierarchyNode::isLeaf ( ) const
virtual
virtual bool DtEchelonHierarchyNode::isRoot ( ) const
virtual
virtual const DtEchelonHierarchyNode* DtEchelonHierarchyNode::root ( ) const
virtual
virtual DtEchelonHierarchyNode* DtEchelonHierarchyNode::root ( )
virtual
virtual bool DtEchelonHierarchyNode::hasChild ( const DtModelKey ) const
virtual

Returns true if the supplied key is in the immediate or other children of this object.

virtual void DtEchelonHierarchyNode::parentDestroyed ( )
protectedvirtualslot
void DtEchelonHierarchyNode::parentChanged ( const DtModelKey myKey)
signal

Emitted whenever the parent pointer is changed.

myKey is the key of THIS node, not the parent.

DtEchelonHierarchyNode& DtEchelonHierarchyNode::operator= ( const DtEchelonHierarchyNode orig)
private

assignment operator

Member Data Documentation

DtModelKey DtEchelonHierarchyNode::myModelKey
protected
int DtEchelonHierarchyNode::myHeight
protected

Key to model data.

DtEchelonHierarchyNode* DtEchelonHierarchyNode::myParent
protected
bool DtEchelonHierarchyNode::myParentValid
protected
DtPtrQList<DtEchelonHierarchyNode*> DtEchelonHierarchyNode::myChildren
protected
DtPtrQList<DtEchelonHierarchyNode*> DtEchelonHierarchyNode::myPreviousChildren
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)