casacore::OrderedMapIterRep< key, value > Class Template Reference

OrderedMap iterator "letter". More...

#include <OrderedMap.h>

Public Types
enum	{ OrderedMapIterRepVersion }

Public Member Functions
Bool	isValid () const
	Checks to see if the iterator is in a valid state. More...
Bool	atEnd () const
	Checks to see if the iterator is at one of the map extremes, "atEnd()" or "atStart()". More...
Bool	atStart () const
void	toStart ()
	Move the iterator to the beginning of the Map. More...
void	operator++ ()
	Advance the iterator to the next key. More...
void	operator++ (int)
const key &	getKey () const
	Retrieve the key at the current iterator position. More...
const key &	getKey (uInt inx) const
value &	getVal (uInt inx)
	Retrieve the value at the given index in the internal block which stores the representation of the OrderedMap. More...
const value &	getVal () const
	Retrieve the value at the current iterator position. More...
const value &	getVal (uInt inx) const
value &	getVal ()
MapIterRep< key, value > *	Clone ()
void	notify (const Notice &)
	OrderedMapIterRep (OrderedMap< key, value > *st)
	These constructors allow a ListMapIter to be constructed from a ListMap. More...
	OrderedMapIterRep (OrderedMap< key, value > &st)

Protected Member Functions
void	thrownext () const
void	throwInvalidIter () const

Protected Attributes
OrderedMap< key, value > *	container
uInt	CurIndex

Detailed Description

template<class key, class value>
class casacore::OrderedMapIterRep< key, value >

OrderedMap iterator "letter".

Review Status

Reviewed By:

UNKNOWN

Date Reviewed:

before2004/08/25

This is the "letter" which when paired (Const)MapIter "envelope" allows traversal of "OrderedMap"s.

Definition at line 48 of file OrderedMap.h.

Member Enumeration Documentation

anonymous enum

template<class key , class value >

anonymous enum

Enumerator
OrderedMapIterRepVersion

Definition at line 422 of file OrderedMap.h.

Constructor & Destructor Documentation

OrderedMapIterRep() [1/2]

template<class key , class value >

casacore::OrderedMapIterRep< key, value >::OrderedMapIterRep ( OrderedMap< key, value > *  st )

inline

These constructors allow a ListMapIter to be constructed from a ListMap.

Definition at line 407 of file OrderedMap.h.

OrderedMapIterRep() [2/2]

template<class key , class value >

casacore::OrderedMapIterRep< key, value >::OrderedMapIterRep ( OrderedMap< key, value > &  st )

inline

Definition at line 414 of file OrderedMap.h.

Member Function Documentation

atEnd()

template<class key , class value >

Bool casacore::OrderedMapIterRep< key, value >::atEnd

(

)

const

Checks to see if the iterator is at one of the map extremes, "atEnd()" or "atStart()".

atStart()

template<class key , class value >

Bool casacore::OrderedMapIterRep< key, value >::atStart

(

)

const

Clone()

template<class key , class value >

MapIterRep<key,value>* casacore::OrderedMapIterRep< key, value >::Clone ( )

inline

Definition at line 388 of file OrderedMap.h.

References casacore::OrderedMapIterRep< key, value >::container.

getKey() [1/2]

template<class key , class value >

const key& casacore::OrderedMapIterRep< key, value >::getKey

(

)

const

Retrieve the key at the current iterator position.

getKey() [2/2]

template<class key , class value >

const key& casacore::OrderedMapIterRep< key, value >::getKey ( uInt  inx ) const

inline

Definition at line 352 of file OrderedMap.h.

References casacore::OrderedMapIterRep< key, value >::container, casacore::OrderedMapIterRep< key, value >::isValid(), and casacore::OrderedMapIterRep< key, value >::throwInvalidIter().

getVal() [1/4]

template<class key , class value >

value& casacore::OrderedMapIterRep< key, value >::getVal ( )

inline

Definition at line 384 of file OrderedMap.h.

References casacore::OrderedMapIterRep< key, value >::CurIndex, and casacore::OrderedMapIterRep< key, value >::getVal().

Referenced by casacore::OrderedMapIterRep< key, value >::getVal().

getVal() [2/4]

template<class key , class value >

const value& casacore::OrderedMapIterRep< key, value >::getVal

(

)

const

Retrieve the value at the current iterator position.

getVal() [3/4]

template<class key , class value >

value& casacore::OrderedMapIterRep< key, value >::getVal ( uInt  inx )

inline

Retrieve the value at the given index in the internal block which stores the representation of the OrderedMap.

Note: This should typically not be used;

Definition at line 366 of file OrderedMap.h.

References casacore::OrderedMapIterRep< key, value >::container, casacore::OrderedMapIterRep< key, value >::isValid(), and casacore::OrderedMapIterRep< key, value >::throwInvalidIter().

getVal() [4/4]

template<class key , class value >

const value& casacore::OrderedMapIterRep< key, value >::getVal ( uInt  inx ) const

inline

Definition at line 378 of file OrderedMap.h.

References casacore::OrderedMapIterRep< key, value >::container, casacore::OrderedMapIterRep< key, value >::isValid(), and casacore::OrderedMapIterRep< key, value >::throwInvalidIter().

isValid()

template<class key , class value >

Bool casacore::OrderedMapIterRep< key, value >::isValid

(

)

const

Checks to see if the iterator is in a valid state.

Referenced by casacore::OrderedMapIterRep< key, value >::getKey(), and casacore::OrderedMapIterRep< key, value >::getVal().

notify()

template<class key , class value >

void casacore::OrderedMapIterRep< key, value >::notify

(

const Notice &

)

operator++() [1/2]

template<class key , class value >

void casacore::OrderedMapIterRep< key, value >::operator++

(

)

Advance the iterator to the next key.

operator++() [2/2]

template<class key , class value >

void casacore::OrderedMapIterRep< key, value >::operator++

(

int

)

throwInvalidIter()

template<class key , class value >

void casacore::OrderedMapIterRep< key, value >::throwInvalidIter ( ) const

protected

Referenced by casacore::OrderedMapIterRep< key, value >::getKey(), and casacore::OrderedMapIterRep< key, value >::getVal().

thrownext()

template<class key , class value >

void casacore::OrderedMapIterRep< key, value >::thrownext ( ) const

protected

toStart()

template<class key , class value >

void casacore::OrderedMapIterRep< key, value >::toStart

(

)

Move the iterator to the beginning of the Map.

Member Data Documentation

container

template<class key , class value >

OrderedMap<key,value>* casacore::OrderedMapIterRep< key, value >::container

protected

Definition at line 314 of file OrderedMap.h.

Referenced by casacore::OrderedMapIterRep< key, value >::Clone(), casacore::OrderedMapIterRep< key, value >::getKey(), and casacore::OrderedMapIterRep< key, value >::getVal().

CurIndex

template<class key , class value >

uInt casacore::OrderedMapIterRep< key, value >::CurIndex

protected

Definition at line 316 of file OrderedMap.h.

Referenced by casacore::OrderedMapIterRep< key, value >::getVal().

---

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

• casa/Containers/OrderedMap.h