Const associative array iterator. More...

#include <Map.h>

Inheritance diagram for casa::ConstMapIter< key, value >:

Public Types
enum	{ ConstMapIterVersion }
Public Member Functions
virtual void	toStart ()
	Move the iterator to the start of the Map.
virtual void	operator++ ()
	Advance to the next element of the Map.
virtual void	operator++ (int)
virtual const key &	getKey () const
	Get the key or value for the current position in the Map.
virtual const value &	getVal () const
virtual Bool	atEnd () const
	Check to see if the iterator position is at the end or beginning of the Map.
virtual Bool	atStart () const
virtual Bool	isValid () const
	Check to see if the iterator is in a valid state.
	ConstMapIter (const Map< key, value > *st)
	Constructs a Map iterator from a Map (with reference semantics).
	ConstMapIter (const Map< key, value > &st)
virtual ConstMapIter< key, value > &	operator= (const Map< key, value > &other)
	Assign one map iterator to a map (with reference semantics).
virtual ConstMapIter< key, value > &	operator= (const Map< key, value > *other)
	ConstMapIter (const ConstMapIter< key, value > *st)
	Constructs a Map iterator from another iterator (with reference semantics).
	ConstMapIter (const ConstMapIter< key, value > &st)
virtual ConstMapIter< key, value > &	operator= (const ConstMapIter< key, value > &other)
	Assign one map iterator to another iterator (with reference semantics).
virtual ConstMapIter< key, value > &	operator= (const ConstMapIter< key, value > *other)
	ConstMapIter ()
	Default constructor creates an invalid Map iterator.
const value &	defaultVal () const
	Returns the default value for the Map on which this iterator is operating if it is a valid iterator, otherwise it throws an exception.
const value &	operator() (const key &ky) const
	Allows mapping functions to be performed with the map on which this iterator operates.
const value *	isDefined (const key &ky) const
	Allows one to check to see if a given key is defined in the map which this iterator tracks.
uInt	ndefined () const
	Returns the number of user defined mappings.
const Map< key, value > &	container () const
	Returns the container on which this iterator is operating.
virtual	~ConstMapIter ()
Protected Member Functions
	ConstMapIter (MapIterRep< key, value > *st)
	Dummy used to initialization by derived classes.
void	SetRep (MapIterRep< key, value > *st)
	Always DELETES Rep if necessary.
Protected Attributes
MapIterRep< key, value > *	Rep

Detailed Description

template<class key, class value>
class casa::ConstMapIter< key, value >

Const associative array iterator.

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

This class implements the mechanism for traversing constant
associative arrays, i.e. "Map"s. This allows one to move
the cursor to the beginning of the map and serially traverse
the map. The key and value elements can be extracted at
each position in the Map. For example:
<code>
  template<class key,class value> void print(const Map<key,value> &xx){
    ConstMapIter<key,value> x(xx);
    x.toStart();
    while (!x.atEnd()) {
      cout << "(" << x.getKey() << "," << x.getVal() << ")" << " ";
      x++;
    }
    cout << endl;
 }
</code>
This example declares a templated function which accepts a const
Map as a parameter, and iterates through the map displaying the
key/value pairs at each positon.

Definition at line 438 of file Map.h.