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

Represents the collection of keys in an AvlDictionary<TKey,TValue>. This class cannot be inherited. More...

List of all members.

Classes

class  Enumerator
 Enumerates the elements of an AvlDictionary<TKey,TValue>.KeyCollection. This class cannot be inherited. More...

Public Member Functions

void Add (TKey item)
 Because the KeyCollection is read only, this method always throws a System.NotSupportedException.
void Clear ()
 Because the KeyCollection is read only, this method always throws a System.NotSupportedException.
bool Contains (TKey item)
 Determines whether the AvlDictionary.KeyCollection contains a specific item.
void CopyTo (TKey[] array, int arrayIndex)
 Copies the elements of the AvlDictionary.KeyCollection to an existing one-dimensional TKey[], starting at the specified array index.
bool Remove (TKey item)
 Because the KeyCollection is read only, this method always throws a System.NotSupportedException.
IEnumerator< TKey > GetEnumerator ()
 Returns an enumerator that iterates through the AvlDictionary.KeyCollection.
void CopyTo (Array array, int index)
 Copies the elements of the AvlDictionary.KeyCollection to an existing one-dimensional Array, starting at the specified array index.

Properties

int Count [get]
 Gets the number of elements contained in the AvlDictionary.
bool IsReadOnly [get]
 Gets a value indicating whether the AvlDictionary.KeyCollection is read-only.
bool IsSynchronized [get]
 Gets a value indicating whether access to the AvlDictionary.KeyCollection is synchronized (thread safe).
object SyncRoot [get]
 Gets an object that can be used to synchronize access to the AvlDictionary.

Detailed Description

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

Represents the collection of keys in an AvlDictionary<TKey,TValue>. This class cannot be inherited.

Member Function Documentation

template<TKey , TValue >
void Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.Add ( TKey  item  ) 

Because the KeyCollection is read only, this method always throws a System.NotSupportedException.

Exceptions:
System.NotSupportedException The AvlDictionary.KeyCollection is read-only.
template<TKey , TValue >
void Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.Clear (  ) 

Because the KeyCollection is read only, this method always throws a System.NotSupportedException.

Exceptions:
System.NotSupportedException The AvlDictionary.KeyCollection is read-only.
template<TKey , TValue >
bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.Contains ( TKey  item  ) 

Determines whether the AvlDictionary.KeyCollection contains a specific item.

Parameters:
item The TKey to locate in the AvlDictionary.KeyCollection.

This method is an O(log N) operation, where N is the number of elements in the AvlDictionary.KeyCollection.

Returns:
true if item is found in the AvlDictionary.KeyCollection; otherwise, false.
template<TKey , TValue >
void Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.CopyTo ( Array  array,
int  index 
)

Copies the elements of the AvlDictionary.KeyCollection to an existing one-dimensional Array, starting at the specified array index.

Parameters:
array The one-dimensional Array that is the destination of the elements copied from AvlDictionary.KeyCollection. The array must have zero-based indexing.
index The zero-based index in array at which copying begins.
Exceptions:
System.ArgumentNullException array is null.
System.ArgumentOutOfRangeException index is less than zero.
System.ArgumentException index is equal to or greater than the length of array. -or- The number of elements in the source AvlDictionary.KeyCollection is greater than the available space from index to the end of the destination array.
template<TKey , TValue >
void Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.CopyTo ( TKey[]  array,
int  arrayIndex 
)

Copies the elements of the AvlDictionary.KeyCollection to an existing one-dimensional TKey[], starting at the specified array index.

Parameters:
array The one-dimensional TKey[] that is the destination of the elements copied from AvlDictionary.KeyCollection. The array must have zero-based indexing.
arrayIndex The zero-based index in array at which copying begins.
Exceptions:
System.ArgumentNullException array is null.
System.ArgumentOutOfRangeException arrayIndex is less than zero.
System.ArgumentException arrayIndex is equal to or greater than the length of array. -or- The number of elements in the source AvlDictionary.KeyCollection is greater than the available space from arrayIndex to the end of the destination array.
template<TKey , TValue >
IEnumerator<TKey> Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.GetEnumerator (  ) 

Returns an enumerator that iterates through the AvlDictionary.KeyCollection.

Returns:
An IEnumerator<TKey> enumerator for the AvlDictionary.KeyCollection.
template<TKey , TValue >
bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.Remove ( TKey  item  ) 

Because the KeyCollection is read only, this method always throws a System.NotSupportedException.

Exceptions:
System.NotSupportedException The AvlDictionary.KeyCollection is read-only.

Property Documentation

template<TKey , TValue >
int Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.Count [get]

Gets the number of elements contained in the AvlDictionary.

Returns:
The number of elements contained in the AvlDictionary. Retrieving the value of this property is an O(1) operation.
template<TKey , TValue >
bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.IsReadOnly [get]

Gets a value indicating whether the AvlDictionary.KeyCollection is read-only.

Returns:
true.
template<TKey , TValue >
bool Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.IsSynchronized [get]

Gets a value indicating whether access to the AvlDictionary.KeyCollection is synchronized (thread safe).

Returns:
false.
template<TKey , TValue >
object Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.KeyCollection.SyncRoot [get]

Gets an object that can be used to synchronize access to the AvlDictionary.

Returns:
An object that can be used to synchronize access to the AvlDictionary.
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