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

Represents the collection of values 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>.ValueCollection. This class cannot be inherited. More...

Public Member Functions

void Add (TValue item)
 Because the ValueCollection is read only, this method always throws a System.NotSupportedException.
void Clear ()
 Because the ValueCollection is read only, this method always throws a System.NotSupportedException.
bool Contains (TValue item)
 Determines whether the AvlDictionary.ValueCollection contains a specific value.
void CopyTo (TValue[] array, int arrayIndex)
 Copies the elements of the AvlDictionary.ValueCollection to an existing one-dimensional TValue[], starting at the specified array index.
bool Remove (TValue item)
 Because the ValueCollection is read only, this method always throws a System.NotSupportedException.
IEnumerator< TValue > GetEnumerator ()
 Returns an enumerator that iterates through the AvlDictionary.ValueCollection.
void CopyTo (Array array, int index)
 Copies the elements of the AvlDictionary.ValueCollection 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.ValueCollection is read-only.
bool IsSynchronized [get]
 Gets a value indicating whether access to the AvlDictionary.ValueCollection 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 >::ValueCollection

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

Member Function Documentation

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

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

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

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

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

Determines whether the AvlDictionary.ValueCollection contains a specific value.

Parameters:
item The TValue to locate in the AvlDictionary.ValueCollection.

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

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

Copies the elements of the AvlDictionary.ValueCollection 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.ValueCollection. 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.ValueCollection 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 >.ValueCollection.CopyTo ( TValue[]  array,
int  arrayIndex 
)

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

Parameters:
array The one-dimensional TValue[] that is the destination of the elements copied from AvlDictionary.ValueCollection. 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.ValueCollection is greater than the available space from arrayIndex to the end of the destination array.
template<TKey , TValue >
IEnumerator<TValue> Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.GetEnumerator (  ) 

Returns an enumerator that iterates through the AvlDictionary.ValueCollection.

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

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

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

Property Documentation

template<TKey , TValue >
int Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.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 >.ValueCollection.IsReadOnly [get]

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

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

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

Returns:
false.
template<TKey , TValue >
object Com.Mission_Base.Pbl.AvlDictionary< TKey, TValue >.ValueCollection.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