PBL - The program base library
C# AvlDictionary and Priority Queue implementation
 All Classes Namespaces Files Functions Properties
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...

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

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

Definition at line 65 of file AvlDictionary.cs.

Constructor & Destructor Documentation

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

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

Parameters
dictionaryThe AvlDictionary<TKey,TValue> the enumerator is created for.

Definition at line 79 of file AvlDictionary.cs.

Member Function Documentation

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

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

Definition at line 209 of file AvlDictionary.cs.

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.InvalidOperationExceptionThe AvlDictionary was modified after the enumerator was created.

Definition at line 166 of file AvlDictionary.cs.

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

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

Definition at line 197 of file AvlDictionary.cs.

Property Documentation

TKey Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.CurrentKey
getprotected

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.

Definition at line 126 of file AvlDictionary.cs.

KeyValuePair<TKey, TValue> Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.CurrentPair
getprotected

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.

Definition at line 107 of file AvlDictionary.cs.

TValue Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.CurrentValue
getprotected

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.

Definition at line 145 of file AvlDictionary.cs.

bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.AvlDictionaryBaseEnumerator.IsPositioned
getprotected

Tests whether the enumerator is properly postioned.

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

Definition at line 95 of file AvlDictionary.cs.


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