FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Commands::BatchParameterValueCollection Class Reference

Inherits OSGeo::FDO::Runtime::Disposable.

Inheritance diagram for OSGeo::FDO::Commands::BatchParameterValueCollection:

[legend]
List of all members.

Detailed Description

The BatchParameterValueCollection class represents a collection of parameter value collections that is used for optimized batch inserts.


Public Member Functions

System::Int32 Add (OSGeo::FDO::Commands::ParameterValueCollection *value)
 Adds a ParameterValueCollection object into the collection.
 BatchParameterValueCollection ()
 Constructs a new empty string collection
System::Void Clear ()
 Removes all elements from the collection.
System::Boolean Contains (OSGeo::FDO::Commands::ParameterValueCollection *value)
 Determines whether the collection contains a specific ParameterValueCollection object.
System::Void CopyTo (OSGeo::FDO::Commands::ParameterValueCollection *array[], System::Int32 index)
 Copies the elements of the collection to an array.
__property System::Int32 get_Count (System::Void)
 Gets the count of items in collection.
__property OSGeo::FDO::Commands::ParameterValueCollectionget_Item (System::Int32 index)
 Gets an item in the collection.
__property OSGeo::FDO::Commands::ParameterValueCollectionget_RealTypeItem (System::Int32 index)
 Gets the item in the collection at the specified index.
__sealed System::Collections::IEnumerator * GetEnumerator (System::Void)
 Gets an enumerator that can iterate through a collection.
System::Int32 IndexOf (OSGeo::FDO::Commands::ParameterValueCollection *value)
 Determines the index of a specific ParameterValueCollection object.
System::Void Insert (System::Int32 index, OSGeo::FDO::Commands::ParameterValueCollection *value)
 Inserts a ParameterValueCollection object into the collection at the specified position.
System::Void Remove (OSGeo::FDO::Commands::ParameterValueCollection *value)
 Removes the first occurrence of a specific ParameterValueCollection object.
System::Void RemoveAt (System::Int32 index)
 Removes the index-th ParameterValueCollection from this collection.
__property System::Void set_Item (System::Int32 index, OSGeo::FDO::Commands::ParameterValueCollection *value)
 Sets the value of the item at the specified index.
__property System::Void set_RealTypeItem (System::Int32 index, OSGeo::FDO::Commands::ParameterValueCollection *value)
 Sets the value of the item at the specified index.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Commands::BatchParameterValueCollection::BatchParameterValueCollection  ) 
 

Constructs a new empty string collection

Returns:
Returns StringCollection

Member Function Documentation

System::Int32 OSGeo::FDO::Commands::BatchParameterValueCollection::Add OSGeo::FDO::Commands::ParameterValueCollection value  ) 
 

Adds a ParameterValueCollection object into the collection.

Parameters:
value Input the ParameterValueCollection object to add.
Returns:
Returns the position into which the new element was inserted.

System::Void OSGeo::FDO::Commands::BatchParameterValueCollection::Clear  ) 
 

Removes all elements from the collection.

System::Boolean OSGeo::FDO::Commands::BatchParameterValueCollection::Contains OSGeo::FDO::Commands::ParameterValueCollection value  ) 
 

Determines whether the collection contains a specific ParameterValueCollection object.

Parameters:
value Input The ParameterValueCollection object to search in the collection.
Returns:
Returns true if the value is found in the collection; otherwise, false.

System::Void OSGeo::FDO::Commands::BatchParameterValueCollection::CopyTo OSGeo::FDO::Commands::ParameterValueCollection array[],
System::Int32  index
 

Copies the elements of the collection to an array.

Parameters:
array Output the one-dimensional Array that is the destination of the elements copied from this collection.
index Input an integer that represents the index in array at which copying begins.

__property System::Int32 OSGeo::FDO::Commands::BatchParameterValueCollection::get_Count System::Void   ) 
 

Gets the count of items in collection.

Returns:
Returns the number of items in the collection.

__property OSGeo ::FDO ::Commands ::ParameterValueCollection* OSGeo::FDO::Commands::BatchParameterValueCollection::get_Item System::Int32  index  ) 
 

Gets an item in the collection.

Parameters:
index Input index of the item to retrieve.
Returns:
Returns the item at the specified index

__property OSGeo ::FDO ::Commands ::ParameterValueCollection* OSGeo::FDO::Commands::BatchParameterValueCollection::get_RealTypeItem System::Int32  index  ) 
 

Gets the item in the collection at the specified index.

Parameters:
index The index of the item in the collection. The index is 0 based.
Returns:
Returns an instance of a the collected item. Throws an instance of Exception if the index is out of range or an error occurs.

__sealed System::Collections::IEnumerator* OSGeo::FDO::Commands::BatchParameterValueCollection::GetEnumerator System::Void   ) 
 

Gets an enumerator that can iterate through a collection.

Returns:
Returns a collection enumerator.

System::Int32 OSGeo::FDO::Commands::BatchParameterValueCollection::IndexOf OSGeo::FDO::Commands::ParameterValueCollection value  ) 
 

Determines the index of a specific ParameterValueCollection object.

Parameters:
value Input the ParameterValueCollection object to locate in the collection.
Returns:
The index of value if found in the collection; otherwise, -1.

System::Void OSGeo::FDO::Commands::BatchParameterValueCollection::Insert System::Int32  index,
OSGeo::FDO::Commands::ParameterValueCollection value
 

Inserts a ParameterValueCollection object into the collection at the specified position.

Parameters:
index Input the zero-based index at which value should be inserted.
value Input the ParameterValueCollection object to insert.

System::Void OSGeo::FDO::Commands::BatchParameterValueCollection::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Runtime::Disposable.

System::Void OSGeo::FDO::Commands::BatchParameterValueCollection::Remove OSGeo::FDO::Commands::ParameterValueCollection value  ) 
 

Removes the first occurrence of a specific ParameterValueCollection object.

Parameters:
value Input the ParameterValueCollection object to remove from the collection.

System::Void OSGeo::FDO::Commands::BatchParameterValueCollection::RemoveAt System::Int32  index  ) 
 

Removes the index-th ParameterValueCollection from this collection.

Parameters:
index Input index of the element to remove.

__property System::Void OSGeo::FDO::Commands::BatchParameterValueCollection::set_Item System::Int32  index,
OSGeo::FDO::Commands::ParameterValueCollection value
 

Sets the value of the item at the specified index.

Parameters:
index Input index of the item to set.
value Input the value of the item

__property System::Void OSGeo::FDO::Commands::BatchParameterValueCollection::set_RealTypeItem System::Int32  index,
OSGeo::FDO::Commands::ParameterValueCollection value
 

Sets the value of the item at the specified index.

Parameters:
index Input index of the item to set.
value Input the value of the item

Comments or suggestions? Send us feedback.