NavItr Class Reference

#include <NavItr.h>

Inheritance diagram for NavItr:

List of all members.

Public Types
typedef NavKey(*	KeyFunc )(void *)
typedef Bool_t(*	SelFunc )(void *)
enum	ESide { kLeft = Nav::kLeft, kRight = Nav::kRight }
Public Member Functions
virtual	~NavItr ()
Int_t	GetIndex () const
NavKey	GetNavKey () const
NavSet *	GetSet () const
void	GetZone (Int_t &lo, Int_t &hi) const
Bool_t	IsValid () const
Bool_t	IsValid (Int_t index) const
void	NotReady (const char *mem) const
void *	operator * () const
void *	Ptr (Bool_t warnIfNull=kFALSE) const
UInt_t	Size () const
UInt_t	SizeSelect () const
Bool_t	Decrement ()
Bool_t	Increment ()
Bool_t	Jump (Int_t index)
void *	Map (const void *far)
Bool_t	Next ()
Bool_t	NextKey ()
NavItr &	operator= (const NavItr &from)
Bool_t	Prev ()
Bool_t	PrevKey ()
void	Reset ()
void	ResetFirst ()
void	ResetLast ()
void	ResetSet ()
	.....................................................................
void	SetDirection (Int_t dir)
Bool_t	SetIndex (Int_t index)
Bool_t	SetIndex (void *obj)
void *	Step (Int_t dir=0)
Protected Member Functions
	NavItr ()
	NavItr (const NavItr &from, Bool_t subSlice=kFALSE)
	NavItr (const Text_t *classname, Int_t offset=0)
	NavItr (const TCollection *source, const Text_t *classname, Int_t offset=0)
	NavItr (const TIter *sourceItr, const Text_t *classname, Int_t offset=0)
	NavItr (const Text_t *classname, const Text_t *farclass, Int_t rship=0)
	NavItr (const Lattice *source, const Text_t *classname, ESide side)
void	Attach (const TCollection *source, const Text_t *classname, Int_t offset=0)
NavItr &	Copy (const NavItr &from)
void	SubSlice (const NavItr &parent)
Private Member Functions
void	GetZone () const
void	Connect ()
void	Disconnect ()
void	Init (NavSet *set=0)
Private Attributes
Short_t	fDefaultStep
Int_t	fIndex
Int_t	fLimLo
Int_t	fLimHi
Short_t	fRank
NavSet *	fSet
Int_t	fZoneLo
Int_t	fZoneHi
Friends
class	NavValidate

---

Member Typedef Documentation

typedef NavKey(* NavItr::KeyFunc)(void *)

Definition at line 31 of file NavItr.h.

typedef Bool_t(* NavItr::SelFunc)(void *)

Definition at line 32 of file NavItr.h.

---

Member Enumeration Documentation

enum NavItr::ESide

Enumeration values: kLeft  kRight  Definition at line 33 of file NavItr.h. { kLeft = Nav::kLeft, kRight = Nav::kRight };

---

Constructor & Destructor Documentation

NavItr::~NavItr (   )  [virtual]

Definition at line 693 of file NavItr.cxx. References Disconnect(), and LEA_DTOR. { // // // Purpose: Destructor. // // Arguments: // None. // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Destructor. // Program Notes:- // ============= // None. LEA_DTOR //Leak Checker Disconnect(); }

NavItr::NavItr (   )  [protected]

Definition at line 454 of file NavItr.cxx. References Init(), and LEA_CTOR. { // // // Purpose: Default constructor. // // Arguments: // None. // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Default constructor. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker Init(); }

NavItr::NavItr (  const NavItr &  from, Bool_t  subSlice = kFALSE )  [protected]

Definition at line 483 of file NavItr.cxx. References Copy(), Init(), LEA_CTOR, and SubSlice(). { // // // Purpose: Copy or sub-slice constructor. // // Arguments: // from in Iterator to be copied from // subSlice in = kFALSE (default) to make copy // = kTRUE to form a subslice // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Copy or sub-slice constructor. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker Init(); if ( subSlice) SubSlice(from); else Copy(from); }

NavItr::NavItr (  const Text_t *  classname, Int_t  offset = 0 )  [protected]

Definition at line 414 of file NavItr.cxx. References Connect(), fSet, Init(), NavPrimer::Instance(), and LEA_CTOR. { // // // Purpose: Construct iterator over TCollection. // // Arguments: // classname in Name of class associated with NavItr. // offset in Pointer offset: Object adr - TObject adr // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Ask NavPrimer for the default TCollection for this type of // object. // // o Create new NavSet derived from a TCollection and attach it. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker Init(); const TCollection* source = NavPrimer::Instance()-> FindTCollection(classname); if ( source ) { fSet = new NavSet(source, classname, offset); Connect(); } }

NavItr::NavItr (  const TCollection *  source, const Text_t *  classname, Int_t  offset = 0 )  [protected]

Definition at line 557 of file NavItr.cxx. References Attach(), fSet, and LEA_CTOR. { // // // Purpose: Construct iterator over TCollection. // // Arguments: // source in source set for iterator. // classname in Name of class associated with NavItr. // offset in Pointer offset: Object adr - TObject adr // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Create new NavSet derived from a TCollection and attach it. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker // Clear fSet (Attach only assumes this data member is defined) fSet = 0; Attach(source,classname,offset); }

NavItr::NavItr (  const TIter *  sourceItr, const Text_t *  classname, Int_t  offset = 0 )  [protected]

Definition at line 516 of file NavItr.cxx. References Connect(), fSet, Init(), and LEA_CTOR. { // // // Purpose: Construct iterator over TCollection. // // Arguments: // sourceItr in source set TIter for iterator. // classname in Name of class associated with NavItr. // offset in Pointer offset: Object adr - TObject adr // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Create new NavSet derived from a TCollection and attach it. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker Init(); // NavSet will check that the supplied TCollection really does // exist and contains the correct class. const TCollection* source = sourceItr->GetCollection(); fSet = new NavSet(source, classname, offset); Connect(); }

NavItr::NavItr (  const Text_t *  classname, const Text_t *  farclass, Int_t  rship = 0 )  [protected]

Definition at line 595 of file NavItr.cxx. References Connect(), NavPrimer::FindLattice(), fSet, Init(), NavPrimer::Instance(), LEA_CTOR, and MSG. { // // // Purpose: Construct iterator over Lattice. // // Arguments: // classname in Name of class associated with NavItr. // farclass in Name of class on far side of Lattice. // rship in Relationship number or 0. // // Return: // // Contact: N. West // // Specification:- // ============= // // o Ask NavPrimer for the default Lattice for this type of object // in specified relationship with farclass objects. // // o Create new NavSet derived from one side of a Lattice and attach it. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker Init(); NavPrimer* primer = NavPrimer::Instance(); NavSet::ESide side = NavSet::kLeft; const Lattice* source = primer ->FindLattice(classname, farclass, rship); // If cannot find Lattice with class on left, try on right. if ( ! source ) { side = NavSet::kRight; source = primer->FindLattice(farclass, classname, rship); } if ( source ) { fSet = new NavSet(source, (NavSet::ESide) side); Connect(); } else { MSG("Nav", Msg::kWarning) << "Cannot find Lattice for" << classname << ":" << farclass << endl; } }

NavItr::NavItr (  const Lattice *  source, const Text_t *  classname, ESide  side )  [protected]

Definition at line 653 of file NavItr.cxx. References Connect(), fSet, Init(), LEA_CTOR, and MSG. { // // // Purpose: Construct iterator over Lattice. // // Arguments: // source in Source relationship set // classname in Name of class associated with NavItr. // side in Side of reltionship (either kLeft or kRight). // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Create new NavSet derived from one side of a Lattice and attach it. // Program Notes:- // ============= // None. LEA_CTOR //Leak Checker MSG("Nav", Msg::kVerbose) << "Creating iterator over Lattice for" << classname << endl; Init(); fSet = new NavSet(source, (NavSet::ESide) side); Connect(); }

---

Member Function Documentation

void NavItr::Attach (  const TCollection *  source, const Text_t *  classname, Int_t  offset = 0 )  [protected]

Definition at line 45 of file NavItr.cxx. Referenced by NavItrT< T >::Attach(), and NavItr(). { // // // Purpose: Attach iterator to TCollection. // // Arguments: // source in source set for iterator. // classname in Name of class associated with NavItr. // offset in Pointer offset: Object adr - TObject adr // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Disconnect any existing collection. // // o Create new NavSet derived from a TCollection and attach it. // Program Notes:- // ============= // Can be called from ctor so long as fSet has been set to zero. Disconnect(); Init(); // NavSet will check that the supplied TCollection really does // exist and contains the correct class. fSet = new NavSet(source, classname, offset); Connect(); }

void NavItr::Connect (   )  [private]

Definition at line 87 of file NavItr.cxx. References NavSet::Attach(), fSet, and Init(). Referenced by Copy(), NavItr(), and SubSlice(). { // // // Purpose: Connect to current NavSet (if any) // // Arguments: n/a // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o If current NavSet exists connect to it. // // o Set up as a rank 0 iterator. // Program Notes:- // ============= // None. if ( fSet ) fSet->Attach(this); Init(fSet); }

NavItr & NavItr::Copy (  const NavItr &  from  )  [protected]

Definition at line 117 of file NavItr.cxx. References Connect(), Disconnect(), fDefaultStep, fIndex, fLimHi, fLimLo, fRank, fSet, fZoneHi, and fZoneLo. Referenced by NavItr(), and NavItrT< T >::operator=(). { // // // Purpose: Replace current state with from object. // // Arguments: // from in Object whose state is to be copied. // // Return: // // Contact: N. West // // Specification:- // ============= // // o Detach object from current NavSet (if any). // // o Copy state from input object and reconnect to new NavSet. // Program Notes:- // ============= // None. Disconnect(); fSet = from.fSet; Connect(); fDefaultStep = from.fDefaultStep; fIndex = from.fIndex; fLimLo = from.fLimLo; fLimHi = from.fLimHi; fRank = from.fRank; fZoneLo = from.fZoneLo; fZoneHi = from.fZoneHi; return *this; }

Bool_t NavItr::Decrement (   )

Definition at line 158 of file NavItr.cxx. References fIndex, and IsValid(). Referenced by NavItrT< T >::operator--(), NavItrT< T >::PrevPtr(), and Step(). { // // // Purpose: Decrement pointer skipping unwanted objects. // // Arguments: None. // // Return: kTRUE if pointer is positioned on a valid object. // // Contact: N. West // // Specification:- // ============= // // o Decrement pointer skipping unwanted objects. // Program Notes:- // ============= // None. fIndex--; return IsValid(); }

void NavItr::Disconnect (   )  [private]

Definition at line 185 of file NavItr.cxx. References NavSet::Detach(), fSet, and Init(). Referenced by Copy(), SubSlice(), and ~NavItr(). { // // // Purpose: Disconnect from current NavSet (if any) // // Arguments: n/a // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o If connected to a NavSet, and disconnecting leave it ownerless // then delete it. // Program Notes:- // ============= // A single NavSet can be shared by any number of NavItrs, hence // this reference counting logic. if ( fSet && ! fSet->Detach(this) ) delete fSet; Init(); }

Int_t NavItr::GetIndex (   )  const [inline]

Definition at line 41 of file NavItr.h. { return fIndex; }

NavKey NavItr::GetNavKey (   )  const

Definition at line 216 of file NavItr.cxx. References fIndex, fRank, fSet, NavSet::GetNavKey(), and IsValid(). { // // // Purpose: Return associated NavKey. // // Arguments: None. // // Return: Return associated NavKey or NavKey(0) if none. // // Contact: N. West // // Specification:- // ============= // // o Return associated NavKey or NavKey(0) if none. // Program Notes:- // ============= // None. return ( fSet && IsValid() ) ? fSet->GetNavKey(fIndex,fRank) : 0; }

NavSet* NavItr::GetSet (   )  const [inline]

Definition at line 43 of file NavItr.h. { return fSet; }

void NavItr::GetZone (   )  const [private]

Definition at line 243 of file NavItr.cxx. References fIndex, fLimHi, fLimLo, fRank, fSet, fZoneHi, fZoneLo, and NavSet::GetZone(). Referenced by NextKey(), and PrevKey(). { // // // Purpose: Get zone limits into fZoneLo, fZoneHi cache. // // Arguments: none. // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Get zone limits into fZoneLo, fZoneHi cache. // Program Notes:- // ============= // The zone limits is the range of indeces containing the current // index and bounded by (fLimLo,fLimHi) within which the associated // NavKey has a single value. Finding zone limits is an expensive // operation so they are cached in fZoneLo, fZoneHi and reused if // possible. Consequently these members are not really true state // but just an optimisation so this const member function is allowed // to modify them. if ( fZoneLo <= fIndex && fZoneHi >= fIndex ) return; Int_t lo = fLimLo; Int_t hi = fLimHi; if ( fSet ) fSet->GetZone(fLimLo,fLimHi,fIndex,fRank,lo,hi); // Allow write access (see Program Notes). NavItr* itr = const_cast<NavItr*>(this); itr->fZoneLo = lo; itr->fZoneHi = hi; }

void NavItr::GetZone (  Int_t &  lo, Int_t &  hi )  const [inline]

Definition at line 44 of file NavItr.h. Referenced by SubSlice(). { GetZone(); lo = fZoneLo; hi = fZoneHi; }

Bool_t NavItr::Increment (   )

Definition at line 286 of file NavItr.cxx. References fIndex, and IsValid(). Referenced by NavItrT< T >::NextPtr(), NavItrT< T >::operator++(), and Step(). { // // // Purpose: Increment pointer skipping unwanted objects. // // Arguments: None. // // Return: kTRUE if pointer is positioned on a valid object. // // Contact: N. West // // Specification:- // ============= // // o Increment pointer skipping unwanted objects. // Program Notes:- // ============= // None. fIndex++; return IsValid(); }

void NavItr::Init (  NavSet *  set = 0  )  [private]

Definition at line 313 of file NavItr.cxx. References fDefaultStep, fIndex, fLimHi, fLimLo, fRank, fSet, fZoneHi, fZoneLo, and NavSet::GetMaxIndex(). Referenced by Connect(), Disconnect(), NavItr(), and ResetSet(). { // // // Purpose: Initialise an empty object. // // Arguments: // set in Associated NavSet (if any). // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Initialise an empty object. // Program Notes:- // ============= // None. fIndex = 0; fLimLo = 0; if ( set ) fLimHi = fSet->GetMaxIndex(); else fLimHi = -1; fSet = set; fRank = 0; fZoneLo = 0; fZoneHi = -1; fDefaultStep = 1; }

Bool_t NavItr::IsValid (  Int_t  index  )  const

Definition at line 348 of file NavItr.cxx. References fLimLo. { // Purpose: Check if index is valid (i.e. within selected range). // // Arguments: // index in Index to be checked. // // Return: // // Contact: N. West // // Specification:- // ============= // // o Check if index is valid. // Program Notes:- // ============= // None. return index >= fLimLo && index <= fLimHi; }

Bool_t NavItr::IsValid (   )  const [inline]

Definition at line 46 of file NavItr.h. Referenced by Decrement(), GetNavKey(), Increment(), NextKey(), operator *(), PrevKey(), Ptr(), SetIndex(), and Step(). { return IsValid(fIndex); }

Bool_t NavItr::Jump (  Int_t  index  )  [inline]

Definition at line 57 of file NavItr.h. Referenced by NavItrT< T >::JumpPtr(). { return SetIndex(index); }

void * NavItr::Map (  const void *  far  )

Reimplemented in NavItrT< T >. Definition at line 376 of file NavItr.cxx. References fSet, NavSet::Map(), and Ptr(). Referenced by NavItrT< T >::Map(). { // Purpose: Select objects associated with supplied object // on far side of Lattice. // // Arguments: // far in Far side object. // // Return: First object in the set or = 0 if none. // // Contact: N. West // // Specification:- // ============= // // o Select the objects associated with the Lattice far object and // return the first of them. // Program Notes:- // ============= // CAUTION: This member function directly effects the associated // NavSet and causes all its iterators to reposition at // start of their range. This would be more apparent if // the user did the longer equivalent:- // // XxxItr* myItr; // myItr->GetSet()->Map(far); // Xxx* myObj = myItrPtr(); fSet->Map(far); return Ptr(); }

Bool_t NavItr::Next (   )  [inline]

Definition at line 59 of file NavItr.h. { Increment(); return IsValid(); }

Bool_t NavItr::NextKey (   )

Definition at line 722 of file NavItr.cxx. References fIndex, fZoneHi, GetZone(), and IsValid(). { // // // Purpose: Increment pointer skipping unwanted objects until // associated NavKey changes value. // // Arguments: None. // // Return: kTRUE if pointer is positioned on a valid object. // // Contact: N. West // // Specification:- // ============= // // o Increment pointer skipping unwanted objects until // associated NavKey changes value. // Program Notes:- // ============= // None. GetZone(); fIndex = fZoneHi+1; return IsValid(); }

void NavItr::NotReady (  const char *  mem  )  const

Definition at line 753 of file NavItr.cxx. References MSG. { // // // Purpose: Warning for unimplemented member functions. // // Arguments: // mem in Member function name. // // Return: // // Contact: N. West // // Specification:- // ============= // // o Display error message giving name of unimplemented member // function. // Program Notes:- // ============= // None. MSG("Nav", Msg::kError) << "Sorry, member function NavItr:::" << mem << " is not yet ready" << endl; }

void * NavItr::operator * (   )  const

Reimplemented in NavItrT< T >. Definition at line 782 of file NavItr.cxx. References NavSet::At(), fIndex, fSet, and IsValid(). Referenced by NavItrT< T >::operator *(). { // // // Purpose: Return object pointer at current index if valid. // // Arguments: None // // Return: Object pointer, or 0 if current index invalid. // // Contact: N. West // // Specification:- // ============= // // o // Program Notes:- // ============= // None. return ( IsValid() ) ? fSet->At(fIndex) : 0; }

NavItr& NavItr::operator= (  const NavItr &  from  )  [inline]

Definition at line 61 of file NavItr.h. { return Copy(from); }

Bool_t NavItr::Prev (   )  [inline]

Definition at line 62 of file NavItr.h. { Decrement(); return IsValid(); }

Bool_t NavItr::PrevKey (   )

Definition at line 808 of file NavItr.cxx. References fIndex, fZoneLo, GetZone(), and IsValid(). { // // // Purpose: Decrement pointer skipping unwanted objects until // associated NavKey changes value. // // Arguments: None. // // Return: kTRUE if pointer is positioned on a valid object. // // Contact: N. West // // Specification:- // ============= // // o Decrement pointer skipping unwanted objects until // associated NavKey changes value. // Program Notes:- // ============= // None. GetZone(); fIndex = fZoneLo-1; return IsValid(); }

void * NavItr::Ptr (  Bool_t  warnIfNull = kFALSE  )  const

Definition at line 839 of file NavItr.cxx. References NavSet::At(), fIndex, fSet, IsValid(), and MSG. Referenced by Map(), NavItrT< T >::Ptr(), and Step(). { // // // Purpose: Return pointer to object at current index. // // Arguments: // warnIfNull in = kTRUE to give warning if null. // // Return: Object pointer, or 0 if current index invalid. // // Contact: N. West // // Specification:- // ============= // // o Return pointer to object at current index. If required issue // warning if pointer is null. // Program Notes:- // ============= // None. void* ptr = ( IsValid() ) ? fSet->At(fIndex) : 0; if ( ! ptr && warnIfNull ) MSG("Nav", Msg::kError) << "There is no object at index: " << fIndex << "! The code will attempt to create an object." << endl << "At the very least this will be a memory leak!" << endl; return ptr; }

void NavItr::Reset (   )

Definition at line 874 of file NavItr.cxx. References fDefaultStep, ResetFirst(), and ResetLast(). { // // // Purpose: Set to first valid entry in the default direction. // // Arguments: None. // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Move to first valid entry. // Program Notes:- // ============= // None. if ( fDefaultStep > 0 ) ResetFirst(); else ResetLast(); }

void NavItr::ResetFirst (   )

Definition at line 901 of file NavItr.cxx. References fDefaultStep, and fIndex. Referenced by Reset(). { // // // Purpose: Set to first valid entry and set default direction to // forwards. // // Arguments: None. // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Move to last valid entry or to 0 if none. // Program Notes:- // ============= // None. fIndex = fLimLo; fDefaultStep = +1; }

void NavItr::ResetLast (   )

Definition at line 929 of file NavItr.cxx. References fDefaultStep, and fIndex. Referenced by Reset(). { // // // Purpose: Set to last valid entry and set default direction to // backwards. // // Arguments: None. // // Return: n/a // // Contact: N. West // // Specification:- // ============= // o Move to last valid entry or to 0 if none. // Program Notes:- // ============= // None. fIndex = fLimHi; fDefaultStep = -1; }

void NavItr::ResetSet (   )

..................................................................... Definition at line 957 of file NavItr.cxx. References fSet, and Init(). { // // // Purpose: Reset after change in underlying set. // // Arguments: None. // // Return: n/a // // Contact: N. West // // Specification:- // ============= // Reset after change in underlying set. // Program Notes:- // ============= // None. Init(fSet); }

void NavItr::SetDirection (  Int_t  dir  )

Definition at line 983 of file NavItr.cxx. References fDefaultStep. { // // // Purpose: Set default direction. // // Arguments: // dir in Direction: > 0 Forwards // < 0 Backwards // = 0 Leave default direction. // // Return: // // Contact: N. West // // Specification:- // ============= // // o Set default direction. // Program Notes:- // ============= // None. if ( dir > 0 ) fDefaultStep = 1; if ( dir < 0 ) fDefaultStep = -1; }

Bool_t NavItr::SetIndex (  void *  obj  )  [inline]

Definition at line 70 of file NavItr.h. {NotReady("SetIndex"); return obj == 0;}

Bool_t NavItr::SetIndex (  Int_t  index  )

Definition at line 1014 of file NavItr.cxx. References fIndex, and IsValid(). { // // // Purpose: Set index if valid. // // Arguments: // index in Required position. // // Return: kTRUE if index is valid. // // Contact: N. West // // Specification:- // ============= // // o If new index valid update iterator, otherwise leave where it is // even if this is also invalid. // Program Notes:- // ============= // None. if ( IsValid(index) ) { fIndex = index; return kTRUE; } return kFALSE; }

UInt_t NavItr::Size (   )  const

Definition at line 1048 of file NavItr.cxx. References fSet, and NavSet::Size(). Referenced by NavValidate::Test_1(). { // // // Purpose: Return current size of set. // // Arguments: None. // // Return: Current size of set // // Contact: N. West // // Specification:- // ============= // // o Return current size of set. // Program Notes:- // ============= // None. return ( fSet ) ? fSet->Size() : 0; }

UInt_t NavItr::SizeSelect (   )  const

Definition at line 1074 of file NavItr.cxx. References fSet, and NavSet::SizeSelect(). { // // // Purpose: Return current size of selected set. // // Arguments: None. // // Return: Current size of selected set // // Contact: N. West // // Specification:- // ============= // // o Return current size of selected set. // Program Notes:- // ============= // None. return ( fSet ) ? fSet->SizeSelect() : 0; }

void * NavItr::Step (  Int_t  dir = 0  )

Definition at line 1100 of file NavItr.cxx. References Decrement(), fIndex, Increment(), IsValid(), and Ptr(). Referenced by NavItrT< T >::operator()(). { // // // Purpose: Step iterator in required direction and return object pointed // before the step. // // Arguments: // dir in Direction: > 0 Forwards // < 0 Backwards // = 0 Default direction. // // Return: // // Contact: N. West // // Specification:- // ============= // // o Step iterator in required direction and return object pointed // before the step. // Program Notes:- // ============= // Returning the object in the old position allows this access // method to be handled consistantly with the Ptr() and // Obj() methods. In all cases Reset() can move to the first valid. void* old = Ptr(); if ( dir > 0 ) Increment(); if ( dir < 0 ) Decrement(); if ( dir == 0 && IsValid() ) fIndex += fDefaultStep; return old; }

void NavItr::SubSlice (  const NavItr &  parent  )  [protected]

Definition at line 1141 of file NavItr.cxx. References Connect(), Disconnect(), fDefaultStep, fIndex, fLimHi, fLimLo, fRank, fSet, fZoneHi, fZoneLo, and GetZone(). Referenced by NavItr(). { // // // Purpose: Set up iterator over sub-slice of supplied parent iterator. // // Arguments: // parent in The parent iterator defining the sub-slice. // // Return: n/a // // Contact: N. West // // Specification:- // ============= // // o Set up iterator to be one rank higher than the supplied parent // and set its range to be the current parent zone. // Program Notes:- // ============= // By setting the this iterator's range to be the current zone of its // parent means that this iterator is limits to the range in which // the parent has a constant NavKey value. Disconnect(); fSet = parent.fSet; Connect(); fDefaultStep = parent.fDefaultStep; parent.GetZone(fLimLo,fLimHi); fIndex = (fDefaultStep > 0 ) ? fLimLo : fLimHi; fRank = parent.fRank+1; fZoneLo = 0; fZoneHi = -1; }

---

Friends And Related Function Documentation

friend class NavValidate [friend]

Definition at line 27 of file NavItr.h.

---

Member Data Documentation

Short_t NavItr::fDefaultStep [private]

Definition at line 114 of file NavItr.h. Referenced by Copy(), Init(), Reset(), ResetFirst(), ResetLast(), SetDirection(), and SubSlice().

Int_t NavItr::fIndex [private]

Definition at line 115 of file NavItr.h. Referenced by Copy(), Decrement(), GetNavKey(), GetZone(), Increment(), Init(), NextKey(), operator *(), PrevKey(), Ptr(), ResetFirst(), ResetLast(), SetIndex(), Step(), and SubSlice().

Int_t NavItr::fLimHi [private]

Definition at line 117 of file NavItr.h. Referenced by Copy(), GetZone(), Init(), and SubSlice().

Int_t NavItr::fLimLo [private]

Definition at line 116 of file NavItr.h. Referenced by Copy(), GetZone(), Init(), IsValid(), and SubSlice().

Short_t NavItr::fRank [private]

Definition at line 118 of file NavItr.h. Referenced by Copy(), GetNavKey(), GetZone(), Init(), and SubSlice().

NavSet* NavItr::fSet [private]

Definition at line 119 of file NavItr.h. Referenced by Connect(), Copy(), Disconnect(), GetNavKey(), GetZone(), Init(), Map(), NavItr(), operator *(), Ptr(), ResetSet(), Size(), SizeSelect(), and SubSlice().

Int_t NavItr::fZoneHi [private]

Definition at line 121 of file NavItr.h. Referenced by Copy(), GetZone(), Init(), NextKey(), and SubSlice().

Int_t NavItr::fZoneLo [private]

Definition at line 120 of file NavItr.h. Referenced by Copy(), GetZone(), Init(), PrevKey(), and SubSlice().

---

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

• NavItr.h
• NavItr.cxx

---