TCollection_BasicMapIterator Class Reference

This class provides basic services for the iterators on Maps. The iterators are inherited from this one. More...

#include <TCollection_BasicMapIterator.hxx>

Inheritance diagram for TCollection_BasicMapIterator:

Public Member Functions
void	Reset ()
	Resets the iterator to the first node. More...
Standard_Boolean	More () const
	Returns true if there is a current entry for this iterator in the map. Use the function Next to set this iterator to the position of the next entry, if it exists. More...
void	Next ()
	Sets this iterator to the position of the next entry of the map. Nothing is changed if there is no more entry to explore in the map: this iterator is always positioned on the last entry of the map but the function More returns false. More...

Protected Member Functions
	TCollection_BasicMapIterator ()
	Creates an empty iterator. More...
	TCollection_BasicMapIterator (const TCollection_BasicMap &M)
	Initialize on the first node in the buckets. More...
void	Initialize (const TCollection_BasicMap &M)
	Initialize on the first node in the buckets. More...

Protected Attributes
Standard_Address	myNode

Detailed Description

This class provides basic services for the iterators on Maps. The iterators are inherited from this one.

The iterator contains an array of pointers (buckets). Each bucket is a pointer on a node. A node contains a pointer on the next node.

This class provides also basic services for the implementation of Maps. A map iterator provides a step by step exploration of all entries of a map. After initialization of a concrete derived iterator, use in a loop:

• the function More to know if there is a current entry for the iterator in the map,
• then the functions which read data on an entry of the map (these functions are provided by each type of map),
• then the function Next to set the iterator to the next entry of the map. Warning
• A map is a non-ordered data structure. The order in which entries of a map are explored by the iterator depends on its contents, and change when the map is edited.
• It is not recommended to modify the contents of a map during iteration: the result is unpredictable.

Constructor & Destructor Documentation

TCollection_BasicMapIterator() [1/2]

TCollection_BasicMapIterator::TCollection_BasicMapIterator ( )

protected

Creates an empty iterator.

TCollection_BasicMapIterator() [2/2]

TCollection_BasicMapIterator::TCollection_BasicMapIterator ( const TCollection_BasicMap &  M )

protected

Initialize on the first node in the buckets.

Member Function Documentation

Initialize()

void TCollection_BasicMapIterator::Initialize ( const TCollection_BasicMap &  M )

protected

Initialize on the first node in the buckets.

More()

Standard_Boolean TCollection_BasicMapIterator::More

(

)

const

Returns true if there is a current entry for this iterator in the map. Use the function Next to set this iterator to the position of the next entry, if it exists.

Next()

void TCollection_BasicMapIterator::Next

(

)

Sets this iterator to the position of the next entry of the map. Nothing is changed if there is no more entry to explore in the map: this iterator is always positioned on the last entry of the map but the function More returns false.

Reset()

void TCollection_BasicMapIterator::Reset

(

)

Resets the iterator to the first node.

Field Documentation

myNode

Standard_Address TCollection_BasicMapIterator::myNode

protected

---

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

• TCollection_BasicMapIterator.hxx