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

CTBmapBrowser Class Template Reference

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

#include <CTBmapIterator.hxx>

Inheritance diagram for CTBmapBrowser:

Inheritance graph
[legend]
Collaboration diagram for CTBmapBrowser:

Collaboration graph
[legend]
List of all members.

Public Types

typedef CTBmap< K, V, C > Map
typedef CTBmapNode< K, V, C > Node
typedef CTBmapBrowser< K,
V, C > 		Browser

Public Methods

 CTBmapBrowser ()
 CTBmapBrowser (const CTBmap< K, V, C > *p_map, const CTBmapNode< K, V, C > *p_node)
bool Next ()
bool Prev ()
bool Valid () const
bool IsFirst () const
bool IsLast () const
CTBint Rank () const
bool Equal (const CTBmapBrowser< K, V, C > &rhs) const
const CTBpair< const K, V > * Current () const
const K & Key () const
const V & Value () const
CTBmapBrowser< K, V, C > & operator++ ()
CTBmapBrowser< K, V, C > operator++ (int)
CTBmapBrowser< K, V, C > & operator-- ()
CTBmapBrowser< K, V, C > operator-- (int)
const CTBpair< const K, V > & operator[] (CTBint i_offset)
const CTBpair< const K, V > * operator-> ()
const CTBpair< const K, V > & operator * ()
CTBmapBrowser< K, V, C > & operator+= (CTBint i_offset)
CTBmapBrowser< K, V, C > & operator-= (CTBint i_offset)
 operator const CTBpair () const
 operator bool () const
 operator const CTBmapNode () const

Protected Attributes

Map * mp_map
Node * mp_node

Related Functions

(Note that these are not member functions.)

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

Detailed Description

template<class K, class V, class C>
class CTBmapBrowser< K, V, C >

Read-only iterator for CTBmap. **.

Definition at line 17 of file CTBmapIterator.hxx.

Member Typedef Documentation

template<class K, class V, class C>
typedef CTBmap<K,V,C> CTBmapBrowser::Map
 

Definition at line 20 of file CTBmapIterator.hxx.

template<class K, class V, class C>
typedef CTBmapNode<K,V,C> CTBmapBrowser::Node
 

Definition at line 21 of file CTBmapIterator.hxx.

template<class K, class V, class C>
typedef CTBmapBrowser<K,V,C> CTBmapBrowser::Browser
 

Definition at line 22 of file CTBmapIterator.hxx.

Constructor & Destructor Documentation

template<class K, class V, class C>
CTBmapBrowser< K, V, C >::CTBmapBrowser (  )  [inline]
 

Default constructor.

Definition at line 23 of file CTBmapIterator.icc.

template<class K, class V, class C>
CTBmapBrowser< K, V, C >::CTBmapBrowser (  const CTBmap< K, V, C > * p_map,
const CTBmapNode< K, V, C > * p_node
)  [inline]
 

Construct from map and node.

Definition at line 32 of file CTBmapIterator.icc.

Member Function Documentation

template<class K, class V, class C>
bool CTBmapBrowser< K, V, C >::Next (  )  [inline]
 

Advance to next entry.

Definition at line 42 of file CTBmapIterator.icc.

template<class K, class V, class C>
bool CTBmapBrowser< K, V, C >::Prev (  )  [inline]
 

Advance to previous entry.

Definition at line 53 of file CTBmapIterator.icc.

template<class K, class V, class C>
bool CTBmapBrowser< K, V, C >::Valid (  )  const [inline]
 

Returns true if points to a valid entry.

Definition at line 64 of file CTBmapIterator.icc.

template<class K, class V, class C>
bool CTBmapBrowser< K, V, C >::IsFirst (  )  const [inline]
 

Returns true if points to first entry in map.

Definition at line 73 of file CTBmapIterator.icc.

template<class K, class V, class C>
bool CTBmapBrowser< K, V, C >::IsLast (  )  const [inline]
 

Returns true if points to last entry in map.

Definition at line 82 of file CTBmapIterator.icc.

template<class K, class V, class C>
CTBint CTBmapBrowser< K, V, C >::Rank (  )  const [inline]
 

Returns rank of entry.

Definition at line 91 of file CTBmapIterator.icc.

Referenced by operator-(), and CTBgsetBrowser::operator-().

template<class K, class V, class C>
bool CTBmapBrowser< K, V, C >::Equal (  const CTBmapBrowser< K, V, C > & rhs )  const [inline]
 

Returns true if points to same entry as browser rhs.

Definition at line 100 of file CTBmapIterator.icc.

Referenced by operator==().

template<class K, class V, class C>
const CTBpair< const K, V > * CTBmapBrowser< K, V, C >::Current (  )  const [inline]
 

Access entry as pair.

Reimplemented in CTBmapIterator.

Definition at line 109 of file CTBmapIterator.icc.

template<class K, class V, class C>
const K & CTBmapBrowser< K, V, C >::Key (  )  const [inline]
 

Access key.

Definition at line 118 of file CTBmapIterator.icc.

template<class K, class V, class C>
const V & CTBmapBrowser< K, V, C >::Value (  )  const [inline]
 

Access value.

Reimplemented in CTBmapIterator.

Definition at line 127 of file CTBmapIterator.icc.

template<class K, class V, class C>
CTBmapBrowser< K, V, C > & CTBmapBrowser< K, V, C >::operator++ (  )  [inline]
 

Pre-increment browser.

Reimplemented in CTBmapIterator.

Definition at line 136 of file CTBmapIterator.icc.

template<class K, class V, class C>
CTBmapBrowser< K, V, C > CTBmapBrowser< K, V, C >::operator++ (  int )  [inline]
 

Post-increment browser.

Reimplemented in CTBmapIterator.

Definition at line 146 of file CTBmapIterator.icc.

template<class K, class V, class C>
CTBmapBrowser< K, V, C > & CTBmapBrowser< K, V, C >::operator-- (  )  [inline]
 

Pre-decrement browser.

Reimplemented in CTBmapIterator.

Definition at line 157 of file CTBmapIterator.icc.

template<class K, class V, class C>
CTBmapBrowser< K, V, C > CTBmapBrowser< K, V, C >::operator-- (  int )  [inline]
 

Post-decrement browser.

Reimplemented in CTBmapIterator.

Definition at line 167 of file CTBmapIterator.icc.

template<class K, class V, class C>
const CTBpair< const K, V > & CTBmapBrowser< K, V, C >::operator[] (  CTBint i_offset )  [inline]
 

Access entry at relative offset i_offset.

Reimplemented in CTBmapIterator.

Definition at line 178 of file CTBmapIterator.icc.

template<class K, class V, class C>
const CTBpair< const K, V > * CTBmapBrowser< K, V, C >::operator-> (  )  [inline]
 

Dereference.

Reimplemented in CTBmapIterator.

Definition at line 189 of file CTBmapIterator.icc.

template<class K, class V, class C>
const CTBpair< const K, V > & CTBmapBrowser< K, V, C >::operator * (  )  [inline]
 

Dereference.

Reimplemented in CTBmapIterator.

Definition at line 198 of file CTBmapIterator.icc.

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

Advance toward higher keys by i_offset entries.

Reimplemented in CTBmapIterator.

Definition at line 207 of file CTBmapIterator.icc.

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

Advance toward lower keys by i_offset entries.

Reimplemented in CTBmapIterator.

Definition at line 217 of file CTBmapIterator.icc.

template<class K, class V, class C>
CTBmapBrowser< K, V, C >::operator const CTBpair< const K, V > * (  )  const [inline]
 

Convert brower to CTBpair pointer.

Definition at line 227 of file CTBmapIterator.icc.

template<class K, class V, class C>
CTBmapBrowser< K, V, C >::operator bool (  )  const [inline]
 

true if points to valid entry.

Reimplemented in CTBmapIterator.

Definition at line 236 of file CTBmapIterator.icc.

template<class K, class V, class C>
CTBmapBrowser< K, V, C >::operator const CTBmapNode< K, V, C > * (  )  const [inline]
 

Convert browser to CTBnode pointer.

Definition at line 245 of file CTBmapIterator.icc.

Friends And Related Function Documentation

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

Advance toward higher keys by i_offset entries.

Definition at line 257 of file CTBmapIterator.icc.

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

Advance toward lower keys by i_offset entries.

Definition at line 273 of file CTBmapIterator.icc.

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

Calculates rank difference of two browsers.

Definition at line 289 of file CTBmapIterator.icc.

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

Is true if both browsers point to same entry.

Definition at line 305 of file CTBmapIterator.icc.

template<class K, class V, class C>
ostream & operator<< (  ostream & os,
const CTBmapBrowser< K, V, C > & obj
)  [related]
 

ostream insertion.

Definition at line 318 of file CTBmapIterator.icc.

Member Data Documentation

template<class K, class V, class C>
Map* CTBmapBrowser::mp_map [protected]
 

map pointer.

Definition at line 64 of file CTBmapIterator.hxx.

template<class K, class V, class C>
Node* CTBmapBrowser::mp_node [protected]
 

node pointer.

Definition at line 65 of file CTBmapIterator.hxx.

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