Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages   Examples  

CTBgsetBrowser Class Template Reference

Read-only iterator for CTBgset. **. More...

#include <CTBgsetIterator.hxx>

Inheritance diagram for CTBgsetBrowser:

Inheritance graph
[legend]
Collaboration diagram for CTBgsetBrowser:

Collaboration graph
[legend]
List of all members.

Public Types

typedef CTBgset< K, V, C,
T, AK, AV > 		Gset
typedef CTBgsetNode< K, V,
C, T, AK, AV > 		Node
typedef CTBgsetBrowser< K,
V, C, T, AK, AV > 		Browser

Public Methods

 CTBgsetBrowser ()
 CTBgsetBrowser (const CTBgset< K, V, C, T, AK, AV > *p_gset, const CTBgsetNode< K, V, C, T, AK, AV > *p_node)
bool Next ()
bool Prev ()
bool Valid () const
bool IsFirst () const
bool IsLast () const
CTBint Rank () const
bool Equal (const CTBgsetBrowser< K, V, C, T, AK, AV > &rhs) const
const K & Key () const
const V & Value () const
const T & Object () const
CTBgsetBrowser< K, V, C, T,
AK, AV > & 		operator++ ()
CTBgsetBrowser< K, V, C, T,
AK, AV > 		operator++ (int)
CTBgsetBrowser< K, V, C, T,
AK, AV > & 		operator-- ()
CTBgsetBrowser< K, V, C, T,
AK, AV > 		operator-- (int)
const T & operator[] (CTBint i_offset)
const T * operator-> ()
const T & operator * ()
CTBgsetBrowser< K, V, C, T,
AK, AV > & 		operator+= (CTBint i_offset)
CTBgsetBrowser< K, V, C, T,
AK, AV > & 		operator-= (CTBint i_offset)
 operator const T * () const
 operator bool () const
 operator const CTBgsetNode () const

Protected Attributes

Gset * mp_gset
Node * mp_node

Related Functions

(Note that these are not member functions.)

CTBgsetBrowser< K, V, C, T,
AK, AV > 		operator+ (const CTBgsetBrowser< K, V, C, T, AK, AV > &lhs, CTBint i_offset)
CTBgsetBrowser< K, V, C, T,
AK, AV > 		operator- (const CTBgsetBrowser< K, V, C, T, AK, AV > &lhs, CTBint i_offset)
CTBint operator- (const CTBgsetBrowser< K, V, C, T, AK, AV > &lhs, const CTBgsetBrowser< K, V, C, T, AK, AV > &rhs)
bool operator== (const CTBgsetBrowser< K, V, C, T, AK, AV > &lhs, const CTBgsetBrowser< K, V, C, T, AK, AV > &rhs)
ostream & operator<< (ostream &os, const CTBgsetBrowser< K, V, C, T, AK, AV > &obj)

Detailed Description

template<class K, class V, class C, class T, class AK, class AV>
class CTBgsetBrowser< K, V, C, T, AK, AV >

Read-only iterator for CTBgset. **.

Definition at line 17 of file CTBgsetIterator.hxx.

Member Typedef Documentation

template<class K, class V, class C, class T, class AK, class AV>
typedef CTBgset<K,V,C,T,AK,AV> CTBgsetBrowser::Gset
 

Definition at line 20 of file CTBgsetIterator.hxx.

template<class K, class V, class C, class T, class AK, class AV>
typedef CTBgsetNode<K,V,C,T,AK,AV> CTBgsetBrowser::Node
 

Definition at line 21 of file CTBgsetIterator.hxx.

template<class K, class V, class C, class T, class AK, class AV>
typedef CTBgsetBrowser<K,V,C,T,AK,AV> CTBgsetBrowser::Browser
 

Definition at line 22 of file CTBgsetIterator.hxx.

Constructor & Destructor Documentation

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV >::CTBgsetBrowser (  )  [inline]
 

Default constructor.

Definition at line 23 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV >::CTBgsetBrowser (  const CTBgset< K, V, C, T, AK, AV > * p_gset,
const CTBgsetNode< K, V, C, T, AK, AV > * p_node
)  [inline]
 

Construct from gset and node.

Definition at line 32 of file CTBgsetIterator.icc.

Member Function Documentation

template<class K, class V, class C, class T, class AK, class AV>
bool CTBgsetBrowser< K, V, C, T, AK, AV >::Next (  )  [inline]
 

Advance to next entry.

Definition at line 43 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
bool CTBgsetBrowser< K, V, C, T, AK, AV >::Prev (  )  [inline]
 

Advance to previous entry.

Definition at line 54 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
bool CTBgsetBrowser< K, V, C, T, AK, AV >::Valid (  )  const [inline]
 

Returns true if points to a valid entry.

Definition at line 65 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
bool CTBgsetBrowser< K, V, C, T, AK, AV >::IsFirst (  )  const [inline]
 

Returns true if points to first entry in gset.

Definition at line 74 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
bool CTBgsetBrowser< K, V, C, T, AK, AV >::IsLast (  )  const [inline]
 

Returns true if points to last entry in gset.

Definition at line 83 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBint CTBgsetBrowser< K, V, C, T, AK, AV >::Rank (  )  const [inline]
 

Returns rank of entry.

Definition at line 92 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
bool CTBgsetBrowser< K, V, C, T, AK, AV >::Equal (  const CTBgsetBrowser< K, V, C, T, AK, AV > & rhs )  const [inline]
 

Returns true if points to same entry as browser rhs.

Definition at line 101 of file CTBgsetIterator.icc.

Referenced by operator==().

template<class K, class V, class C, class T, class AK, class AV>
const K & CTBgsetBrowser< K, V, C, T, AK, AV >::Key (  )  const [inline]
 

Access key.

Definition at line 111 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
const V & CTBgsetBrowser< K, V, C, T, AK, AV >::Value (  )  const [inline]
 

Access value.

Reimplemented in CTBgsetIterator.

Definition at line 120 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
const T & CTBgsetBrowser< K, V, C, T, AK, AV >::Object (  )  const [inline]
 

Access object.

Reimplemented in CTBgsetIterator.

Definition at line 129 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV > & CTBgsetBrowser< K, V, C, T, AK, AV >::operator++ (  )  [inline]
 

Pre-increment browser.

Reimplemented in CTBgsetIterator.

Definition at line 138 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV > CTBgsetBrowser< K, V, C, T, AK, AV >::operator++ (  int )  [inline]
 

Post-increment browser.

Reimplemented in CTBgsetIterator.

Definition at line 148 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV > & CTBgsetBrowser< K, V, C, T, AK, AV >::operator-- (  )  [inline]
 

Pre-decrement browser.

Reimplemented in CTBgsetIterator.

Definition at line 159 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV > CTBgsetBrowser< K, V, C, T, AK, AV >::operator-- (  int )  [inline]
 

Post-decrement browser.

Reimplemented in CTBgsetIterator.

Definition at line 169 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
const T & CTBgsetBrowser< K, V, C, T, AK, AV >::operator[] (  CTBint i_offset )  [inline]
 

Access entry at relative offset i_offset.

Reimplemented in CTBgsetIterator.

Definition at line 180 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
const T * CTBgsetBrowser< K, V, C, T, AK, AV >::operator-> (  )  [inline]
 

Dereference.

Reimplemented in CTBgsetIterator.

Definition at line 190 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
const T & CTBgsetBrowser< K, V, C, T, AK, AV >::operator * (  )  [inline]
 

Dereference.

Reimplemented in CTBgsetIterator.

Definition at line 199 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV > & CTBgsetBrowser< K, V, C, T, AK, AV >::operator+= (  CTBint i_offset )  [inline]
 

Advance toward higher keys by i_offset entries.

Reimplemented in CTBgsetIterator.

Definition at line 208 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV > & CTBgsetBrowser< K, V, C, T, AK, AV >::operator-= (  CTBint i_offset )  [inline]
 

Advance toward lower keys by i_offset entries.

Reimplemented in CTBgsetIterator.

Definition at line 219 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV >::operator const T * (  )  const [inline]
 

Convert brower to T pointer.

Definition at line 230 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV >::operator bool (  )  const [inline]
 

true if points to valid entry.

Reimplemented in CTBgsetIterator.

Definition at line 239 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV >::operator const CTBgsetNode< K, V, C, T, AK, AV > * (  )  const [inline]
 

Convert browser to CTBnode pointer.

Definition at line 248 of file CTBgsetIterator.icc.

Friends And Related Function Documentation

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV > operator+ (  const CTBgsetBrowser< K, V, C, T, AK, AV > & lhs,
CTBint i_offset
)  [related]
 

Advance toward higher keys by i_offset entries.

Definition at line 260 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBgsetBrowser< K, V, C, T, AK, AV > operator- (  const CTBgsetBrowser< K, V, C, T, AK, AV > & lhs,
CTBint i_offset
)  [related]
 

Advance toward lower keys by i_offset entries.

Definition at line 277 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
CTBint operator- (  const CTBgsetBrowser< K, V, C, T, AK, AV > & lhs,
const CTBgsetBrowser< K, V, C, T, AK, AV > & rhs
)  [related]
 

Calculates rank difference of two browsers.

Definition at line 294 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
bool operator== (  const CTBgsetBrowser< K, V, C, T, AK, AV > & lhs,
const CTBgsetBrowser< K, V, C, T, AK, AV > & rhs
)  [related]
 

Is true if both browsers point to same entry.

Definition at line 310 of file CTBgsetIterator.icc.

template<class K, class V, class C, class T, class AK, class AV>
ostream & operator<< (  ostream & os,
const CTBgsetBrowser< K, V, C, T, AK, AV > & obj
)  [related]
 

ostream insertion.

Definition at line 323 of file CTBgsetIterator.icc.

Member Data Documentation

template<class K, class V, class C, class T, class AK, class AV>
Gset* CTBgsetBrowser::mp_gset [protected]
 

gset pointer.

Definition at line 63 of file CTBgsetIterator.hxx.

template<class K, class V, class C, class T, class AK, class AV>
Node* CTBgsetBrowser::mp_node [protected]
 

node pointer.

Definition at line 64 of file CTBgsetIterator.hxx.

The documentation for this class was generated from the following files:
Generated at Fri Oct 24 18:13:50 2003 for CTBbase by doxygen1.2.9-20010812 written by Dimitri van Heesch, © 1997-2001