SUIT_DataObjectIterator Class Reference

#include <SUIT_DataObjectIterator.h>

Inheritance diagram for SUIT_DataObjectIterator:

Public Types
enum	DetourType {   DepthLeft, DepthRight, BreadthLeft, BreadthRight,   User }
Public Member Functions
	SUIT_DataObjectIterator (SUIT_DataObject *root, const int det, const bool fromTrueRoot=false)
virtual void	operator++ ()
SUIT_DataObject *	current () const
int	depth () const
int	detour () const
Protected Member Functions
SUIT_DataObject *	parent (SUIT_DataObject *) const
SUIT_DataObject *	extreme (DataObjectList &, bool FromLeft) const
SUIT_DataObject *	globalSibling (SUIT_DataObject *, bool next) const
Protected Attributes
SUIT_DataObject *	myRoot
SUIT_DataObject *	myCurrent
Private Attributes
SUIT_DataObject *	myExtremeChild
int	myDetourType
int	myCurrentLevel

---

Detailed Description

Provides functionality of SUIT tree detour It is possible to use "to-depth" or "to-breadth" detour and to control level detour (from left or from right)

Provides functionality of SUIT tree detour between certain levels Only "to-breadth" detour is used

---

Member Enumeration Documentation

enum SUIT_DataObjectIterator::DetourType

Enumerator:

DepthLeft
DepthRight
BreadthLeft
BreadthRight
User

---

Constructor & Destructor Documentation

SUIT_DataObjectIterator::SUIT_DataObjectIterator	(	SUIT_DataObject *	root,
		const int	det,
		const bool	fromTrueRoot = false
	)

Constructor.

References myCurrent, myExtremeChild, myRoot, and SUIT_DataObject.root().

---

Member Function Documentation

void SUIT_DataObjectIterator::operator++

(

)

[virtual]

Increment operator.

Reimplemented in SUIT_DataObjectLevelIterator.

References BreadthLeft, BreadthRight, DepthLeft, DepthRight, extreme(), globalSibling(), SUIT_DataObject.myChildren, myCurrent, myCurrentLevel, myDetourType, myExtremeChild, and parent().

SUIT_DataObject * SUIT_DataObjectIterator::current

(

)

const

Gets current data object.

References myCurrent.

int SUIT_DataObjectIterator::depth

(

)

const

Gets depth of current lavel.

References myCurrentLevel.

int SUIT_DataObjectIterator::detour

(

)

const

Gets detour type.

References myDetourType.

SUIT_DataObject * SUIT_DataObjectIterator::parent

(

SUIT_DataObject *

obj

)

const [protected]

Gets parent for object obj.

References myRoot, and SUIT_DataObject.parent().

SUIT_DataObject * SUIT_DataObjectIterator::extreme	(	DataObjectList &	aList,
		bool	FromLeft
	)		const [protected]

Gets first or last data object from list. Get firls, if FromLeft == true, else last.

SUIT_DataObject * SUIT_DataObjectIterator::globalSibling	(	SUIT_DataObject *	obj,
		bool	next
	)		const [protected]

Gets global sibling for object obj

References extreme(), SUIT_DataObject.myChildren, and parent().

---

Field Documentation

SUIT_DataObject* SUIT_DataObjectIterator.myRoot [protected]

SUIT_DataObject* SUIT_DataObjectIterator.myCurrent [protected]

SUIT_DataObject* SUIT_DataObjectIterator.myExtremeChild [private]

int SUIT_DataObjectIterator.myDetourType [private]

int SUIT_DataObjectIterator.myCurrentLevel [private]