casacore::ConstHashMapIter< key, val > Class Template Reference

#include <HashMapIter.h>

Inheritance diagram for casacore::ConstHashMapIter< key, val >:

List of all members.

Public Member Functions
void	toStart ()
	Move the iterator to the start of the Map.
void	operator++ ()
	Advance to the next element of the Map.
void	operator++ (int)
const key &	getKey () const
	Get the key or value for the current position in the Map.
const val &	getVal () const
Bool	atEnd () const
	Check to see if the iterator position is at the end or beginning of the Map.
Bool	atStart () const
Bool	isValid () const
	Check to see if the iterator is in a valid state.
	ConstHashMapIter (const HashMap< key, val > &st)
	Constructs a Map iterator from a Map (with reference semantics).
virtual ConstHashMapIter< key, val > &	operator= (const HashMap< key, val > &other)
	Assign one map iterator to a map (with reference semantics).
	ConstHashMapIter (const ConstHashMapIter< key, val > &st)
	Constructs a Map iterator from another iterator (with reference semantics).
virtual ConstHashMapIter< key, val > &	operator= (const ConstHashMapIter< key, val > &other)
	Assign one map iterator to another iterator (with reference semantics).
	ConstHashMapIter ()
	Default constructor creates an invalid Map iterator.
const val &	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 val &	operator() (const key &ky) const
	Allows mapping functions to be performed with the map on which this iterator operates.
Bool	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 HashMap< key, val > &	container () const
	Returns the container on which this iterator is operating.
virtual	~ConstHashMapIter ()
	dtor
Protected Member Functions
void	step ()
Protected Attributes
ListIter< OrderedPair< key, val > >	iter
HashMap< key, val > *	Container
uInt	curBucket
Bool	atEnd_

---

Detailed Description

template<class key, class val>
class casacore::ConstHashMapIter< key, val >

Definition at line 82 of file HashMapIter.h.

---

Constructor & Destructor Documentation

template<class key, class val>

casacore::ConstHashMapIter< key, val >::ConstHashMapIter

(

const HashMap< key, val > &

st

)

Constructs a Map iterator from a Map (with reference semantics).

template<class key, class val>

casacore::ConstHashMapIter< key, val >::ConstHashMapIter

(

const ConstHashMapIter< key, val > &

st

)

Constructs a Map iterator from another iterator (with reference semantics).

template<class key, class val>

casacore::ConstHashMapIter< key, val >::ConstHashMapIter

(

)

[inline]

Default constructor creates an invalid Map iterator.

Definition at line 144 of file HashMapIter.h.

template<class key, class val>

virtual casacore::ConstHashMapIter< key, val >::~ConstHashMapIter

(

)

[virtual]

dtor

---

Member Function Documentation

template<class key, class val>

Bool casacore::ConstHashMapIter< key, val >::atEnd

(

)

const [inline]

Check to see if the iterator position is at the end or beginning of the Map.

Definition at line 112 of file HashMapIter.h.

References casacore::ConstHashMapIter< key, val >::atEnd_.

template<class key, class val>

Bool casacore::ConstHashMapIter< key, val >::atStart

(

)

const

template<class key, class val>

const HashMap<key,val>& casacore::ConstHashMapIter< key, val >::container

(

)

const [inline]

Returns the container on which this iterator is operating.

Reimplemented in casacore::HashMapIter< key, val >.

Definition at line 193 of file HashMapIter.h.

References casacore::ConstHashMapIter< key, val >::Container, casacore::ConstHashMapIter< key, val >::isValid(), and casacore::throw_invalid_hashmapiter_error().

template<class key, class val>

const val& casacore::ConstHashMapIter< key, val >::defaultVal

(

)

const [inline]

Returns the default value for the Map on which this iterator is operating if it is a valid iterator, otherwise it throws an exception.

Reimplemented in casacore::HashMapIter< key, val >.

Definition at line 152 of file HashMapIter.h.

References casacore::ConstHashMapIter< key, val >::Container, casacore::ConstHashMapIter< key, val >::isValid(), and casacore::throw_invalid_hashmapiter_error().

template<class key, class val>

const key& casacore::ConstHashMapIter< key, val >::getKey

(

)

const

Get the key or value for the current position in the Map.

template<class key, class val>

const val& casacore::ConstHashMapIter< key, val >::getVal

(

)

const

Reimplemented in casacore::HashMapIter< key, val >.

template<class key, class val>

Bool casacore::ConstHashMapIter< key, val >::isDefined

(

const key &

ky

)

const [inline]

Allows one to check to see if a given key is defined in the map which this iterator tracks.

If this iterator is invalid, then an exception will be thrown.

Definition at line 174 of file HashMapIter.h.

References casacore::ConstHashMapIter< key, val >::Container, casacore::ConstHashMapIter< key, val >::isValid(), and casacore::throw_invalid_hashmapiter_error().

template<class key, class val>

Bool casacore::ConstHashMapIter< key, val >::isValid

(

)

const [inline]

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

Definition at line 119 of file HashMapIter.h.

References casacore::ConstHashMapIter< key, val >::Container, casacore::False, and casacore::True.

Referenced by casacore::HashMapIter< key, val >::clear(), casacore::ConstHashMapIter< key, val >::container(), casacore::HashMapIter< key, val >::container(), casacore::ConstHashMapIter< key, val >::defaultVal(), casacore::HashMapIter< key, val >::defaultVal(), casacore::HashMapIter< key, val >::define(), casacore::ConstHashMapIter< key, val >::isDefined(), casacore::ConstHashMapIter< key, val >::ndefined(), casacore::HashMapIter< key, val >::operator()(), casacore::ConstHashMapIter< key, val >::operator()(), and casacore::HashMapIter< key, val >::remove().

template<class key, class val>

uInt casacore::ConstHashMapIter< key, val >::ndefined

(

)

const [inline]

Returns the number of user defined mappings.

Definition at line 183 of file HashMapIter.h.

References casacore::ConstHashMapIter< key, val >::Container, casacore::ConstHashMapIter< key, val >::isValid(), and casacore::throw_invalid_hashmapiter_error().

template<class key, class val>

const val& casacore::ConstHashMapIter< key, val >::operator()

(

const key &

ky

)

const [inline]

Allows mapping functions to be performed with the map on which this iterator operates.

If this iterator is invalid, then an exception will be thrown.

Reimplemented in casacore::HashMapIter< key, val >.

Definition at line 163 of file HashMapIter.h.

References casacore::ConstHashMapIter< key, val >::Container, casacore::ConstHashMapIter< key, val >::isValid(), and casacore::throw_invalid_hashmapiter_error().

template<class key, class val>

void casacore::ConstHashMapIter< key, val >::operator++

(

int

)

[inline]

Definition at line 95 of file HashMapIter.h.

References casacore::ConstHashMapIter< key, val >::step().

template<class key, class val>

void casacore::ConstHashMapIter< key, val >::operator++

(

)

[inline]

Advance to the next element of the Map.

Definition at line 94 of file HashMapIter.h.

References casacore::ConstHashMapIter< key, val >::step().

template<class key, class val>

virtual ConstHashMapIter<key,val>& casacore::ConstHashMapIter< key, val >::operator=

(

const ConstHashMapIter< key, val > &

other

)

[virtual]

Assign one map iterator to another iterator (with reference semantics).

Reimplemented in casacore::HashMapIter< key, val >.

template<class key, class val>

virtual ConstHashMapIter<key,val>& casacore::ConstHashMapIter< key, val >::operator=

(

const HashMap< key, val > &

other

)

[virtual]

Assign one map iterator to a map (with reference semantics).

Reimplemented in casacore::HashMapIter< key, val >.

template<class key, class val>

void casacore::ConstHashMapIter< key, val >::step

(

)

[protected]

Referenced by casacore::ConstHashMapIter< key, val >::operator++().

template<class key, class val>

void casacore::ConstHashMapIter< key, val >::toStart

(

)

Move the iterator to the start of the Map.

---

Member Data Documentation

template<class key, class val>

Bool casacore::ConstHashMapIter< key, val >::atEnd_ [protected]

Definition at line 209 of file HashMapIter.h.

Referenced by casacore::ConstHashMapIter< key, val >::atEnd().

template<class key, class val>

HashMap<key,val>* casacore::ConstHashMapIter< key, val >::Container [protected]

Definition at line 207 of file HashMapIter.h.

Referenced by casacore::HashMapIter< key, val >::clear(), casacore::ConstHashMapIter< key, val >::container(), casacore::HashMapIter< key, val >::container(), casacore::ConstHashMapIter< key, val >::defaultVal(), casacore::HashMapIter< key, val >::defaultVal(), casacore::HashMapIter< key, val >::define(), casacore::ConstHashMapIter< key, val >::isDefined(), casacore::ConstHashMapIter< key, val >::isValid(), casacore::ConstHashMapIter< key, val >::ndefined(), casacore::HashMapIter< key, val >::operator()(), casacore::ConstHashMapIter< key, val >::operator()(), and casacore::HashMapIter< key, val >::remove().

template<class key, class val>

uInt casacore::ConstHashMapIter< key, val >::curBucket [protected]

Definition at line 208 of file HashMapIter.h.

template<class key, class val>

ListIter<OrderedPair<key,val> > casacore::ConstHashMapIter< key, val >::iter [protected]

Definition at line 206 of file HashMapIter.h.

---

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

• casacore/casa/Containers/HashMapIter.h