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

OrderedMap iterator "letter". More...

#include <OrderedMap.h>

Inheritance diagram for casacore::OrderedMapIterRep< key, value >:

List of all members.

Public Types
enum	{ OrderedMapIterRepVersion }
Public Member Functions
Bool	isValid () const
	Checks to see if the iterator is in a valid state.
Bool	atEnd () const
	Checks to see if the iterator is at one of the map extremes, "atEnd()" or "atStart()".
Bool	atStart () const
void	toStart ()
	Move the iterator to the beginning of the Map.
void	operator++ ()
	Advance the iterator to the next key.
void	operator++ (int)
const key &	getKey () const
	Retrieve the key at the current iterator position.
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.
const value &	getVal () const
	Retrieve the value at the current iterator position.
const value &	getVal (uInt inx) const
value &	getVal ()
	Return the value at the current location of the map iterator.
MapIterRep< key, value > *	Clone ()
	Duplicate a map iterator.
void	notify (const Notice &)
	Hook through which NoticeTargets are notified (by NoticeSources).
	OrderedMapIterRep (OrderedMap< key, value > *st)
	These constructors allow a ListMapIter to be constructed from a ListMap.
	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 298 of file OrderedMap.h.

---

Member Enumeration Documentation

template<class key, class value>

anonymous enum

Enumerator:

OrderedMapIterRepVersion

Definition at line 418 of file OrderedMap.h.

---

Constructor & Destructor Documentation

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 403 of file OrderedMap.h.

template<class key, class value>

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

(

OrderedMap< key, value > &

st

)

[inline]

Definition at line 410 of file OrderedMap.h.

---

Member Function Documentation

template<class key, class value>

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

(

)

const [virtual]

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

Implements casacore::MapIterRep< key, value >.

template<class key, class value>

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

(

)

const [virtual]

Implements casacore::MapIterRep< key, value >.

template<class key, class value>

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

(

)

[inline, virtual]

Duplicate a map iterator.

Implements casacore::MapIterRep< key, value >.

Definition at line 384 of file OrderedMap.h.

References casacore::MapIterRep< key, value >::container().

template<class key, class value>

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

(

uInt

inx

)

const [inline]

Definition at line 348 of file OrderedMap.h.

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

template<class key, class value>

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

(

)

const [virtual]

Retrieve the key at the current iterator position.

Implements casacore::MapIterRep< key, value >.

template<class key, class value>

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

(

)

[inline, virtual]

Return the value at the current location of the map iterator.

Should throw an exception if the iterator is "past the end of the Map" or if the iterator is invalid.

Implements casacore::MapIterRep< key, value >.

Definition at line 380 of file OrderedMap.h.

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

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

template<class key, class value>

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

(

uInt

inx

)

const [inline]

Definition at line 374 of file OrderedMap.h.

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

template<class key, class value>

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

(

)

const [virtual]

Retrieve the value at the current iterator position.

Implements casacore::MapIterRep< key, value >.

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 362 of file OrderedMap.h.

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

template<class key, class value>

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

(

)

const [virtual]

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

Implements casacore::MapIterRep< key, value >.

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

template<class key, class value>

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

(

const Notice &

)

[virtual]

Hook through which NoticeTargets are notified (by NoticeSources).

Implements casacore::NoticeTarget.

template<class key, class value>

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

(

int

)

[virtual]

Implements casacore::MapIterRep< key, value >.

template<class key, class value>

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

(

)

[virtual]

Advance the iterator to the next key.

Implements casacore::MapIterRep< key, value >.

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().

template<class key, class value>

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

(

)

const [protected]

template<class key, class value>

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

(

)

[virtual]

Move the iterator to the beginning of the Map.

Implements casacore::MapIterRep< key, value >.

---

Member Data Documentation

template<class key, class value>

OrderedMap<key,value>* casacore::OrderedMapIterRep< key, value >::container [protected]

Reimplemented from casacore::NoticeTarget.

Definition at line 310 of file OrderedMap.h.

template<class key, class value>

uInt casacore::OrderedMapIterRep< key, value >::CurIndex [protected]

Definition at line 312 of file OrderedMap.h.

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

---

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

• casacore/casa/Containers/OrderedMap.h