Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator Class Reference

Provides the common base functionality of all Enumerators used with an AvlDictionary<TKey,TValue>. More...

List of all members.

Public Member Functions

bool MoveNext ()
 Advances the enumerator to the next element of the AvlDictionary<TKey,TValue>.
void Reset ()
 Resets the enumerator of the AvlDictionary<TKey,TValue>.
void Dispose ()
 Disposes the enumerator of the AvlDictionary<TKey,TValue>.

Protected Member Functions

 AvlDictionaryBaseEnumerator (AvlDictionary< TKey, TValue > dictionary)
 Creates a new enumerator of the AvlDictionary<TKey,TValue>.

Properties

bool IsPositioned [get]
 Tests whether the enumerator is properly postioned.
KeyValuePair< TKey, TValue > CurrentPair [get]
 Gets the element at the current position of the enumerator.
TKey CurrentKey [get]
 Gets the key at the current position of the enumerator.
TValue CurrentValue [get]
 Gets the value at the current position of the enumerator.

Detailed Description

template<TKey, TValue>
class Com::Mission_Base::Pbl::AvlDictionary< TKey, TValue >::AvlDictionaryBaseEnumerator

Provides the common base functionality of all Enumerators used with an AvlDictionary<TKey,TValue>.


Constructor & Destructor Documentation

template<TKey , TValue >
Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.AvlDictionaryBaseEnumerator ( AvlDictionary< TKey, TValue >  dictionary  )  [protected]

Creates a new enumerator of the AvlDictionary<TKey,TValue>.

Parameters:
dictionary The AvlDictionary<TKey,TValue> the enumerator is created for.

Member Function Documentation

template<TKey , TValue >
void Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.Dispose (  ) 

Disposes the enumerator of the AvlDictionary<TKey,TValue>.

template<TKey , TValue >
bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.MoveNext (  ) 

Advances the enumerator to the next element of the AvlDictionary<TKey,TValue>.

Returns:
true if the enumerator was successfully advanced to the next element; false
Exceptions:
System.InvalidOperationException The AvlDictionary was modified after the enumerator was created.
template<TKey , TValue >
void Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.Reset (  ) 

Resets the enumerator of the AvlDictionary<TKey,TValue>.


Property Documentation

template<TKey , TValue >
TKey Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.CurrentKey [get, protected]

Gets the key at the current position of the enumerator.

Returns:
The key in the AvlDictionary<TKey,TValue>.KeyCollection at the current position of the enumerator.
template<TKey , TValue >
KeyValuePair<TKey, TValue> Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.CurrentPair [get, protected]

Gets the element at the current position of the enumerator.

Returns:
The KeyValuePair<TKey, TValue> in the AvlDictionary<TKey,TValue> at the current position of the enumerator.
template<TKey , TValue >
TValue Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.CurrentValue [get, protected]

Gets the value at the current position of the enumerator.

Returns:
The value in the AvlDictionary<TKey,TValue>.ValueCollection at the current position of the enumerator.
template<TKey , TValue >
bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.IsPositioned [get, protected]

Tests whether the enumerator is properly postioned.

Returns:
true if the enumerator is postioned; otherwise, false.

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

Generated on Thu Nov 26 15:25:33 2009 for AvlDictionary by  doxygen 1.6.1