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::IdentifierCollection Class Reference

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

Inheritance diagram for OSGeo::FDO::Commands::IdentifierCollection:

[legend]
List of all members.

Detailed Description

The IdentifierCollection class represents a collection of FDO Identifier objects.


Public Member Functions

System::Int32 Add (OSGeo::FDO::Expression::Identifier *value)
 Adds a Identifier object into the collection.
System::Void Clear ()
 Removes all elements from the collection.
System::Boolean Contains (OSGeo::FDO::Expression::Identifier *value)
 Determines whether the collection contains a specific Identifier object.
System::Void CopyTo (OSGeo::FDO::Expression::Identifier *array[], System::Int32 index)
 Copies the elements of the collection to an array.
OSGeo::FDO::Expression::IdentifierFindItem (System::String *name)
 Finds the item in the collection with the specified name. Returns NULL if an item with the specified name does not exist in the collection.
__property System::Int32 get_Count (System::Void)
 Gets the count of items in collection.
__property OSGeo::FDO::Expression::Identifierget_Item (System::Int32 index)
 Gets an item in the collection.
__property OSGeo::FDO::Expression::Identifierget_RealTypeItem (System::Int32 index)
 Gets or sets a Identifier in the collection.
__sealed System::Collections::IEnumerator * GetEnumerator (System::Void)
 Gets an enumerator that can iterate through a collection.
OSGeo::FDO::Expression::IdentifierGetItem (System::Int32 index)
 Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range.
OSGeo::FDO::Expression::IdentifierGetItem (System::String *name)
 Gets the item in the collection with the specified name. Throws an invalid argument exception if an item with the specified name does not exist in the collection.
 IdentifierCollection ()
 Constructs a new empty string collection
System::Int32 IndexOf (OSGeo::FDO::Expression::Identifier *value)
 Determines the index of a specific Identifier object.
System::Void Insert (System::Int32 index, OSGeo::FDO::Expression::Identifier *value)
 Inserts a Identifier object into the collection at the specified position.
System::Void Remove (OSGeo::FDO::Expression::Identifier *value)
 Removes the first occurrence of a specific Identifier object.
System::Void RemoveAt (System::Int32 index)
 Removes the index-th Identifier from this collection.
__property System::Void set_Item (System::Int32 index, OSGeo::FDO::Expression::Identifier *value)
 Sets the value of the item at the specified index.
__property System::Void set_RealTypeItem (System::Int32 index, OSGeo::FDO::Expression::Identifier *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::IdentifierCollection::IdentifierCollection  ) 
 

Constructs a new empty string collection


Member Function Documentation

System::Int32 OSGeo::FDO::Commands::IdentifierCollection::Add OSGeo::FDO::Expression::Identifier value  ) 
 

Adds a Identifier object into the collection.

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

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

Removes all elements from the collection.

System::Boolean OSGeo::FDO::Commands::IdentifierCollection::Contains OSGeo::FDO::Expression::Identifier value  ) 
 

Determines whether the collection contains a specific Identifier object.

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

System::Void OSGeo::FDO::Commands::IdentifierCollection::CopyTo OSGeo::FDO::Expression::Identifier 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.

OSGeo ::FDO ::Expression ::Identifier* OSGeo::FDO::Commands::IdentifierCollection::FindItem System::String *  name  ) 
 

Finds the item in the collection with the specified name. Returns NULL if an item with the specified name does not exist in the collection.

Parameters:
name Input the item name
Returns:
Returns Identifier

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

Gets the count of items in collection.

Returns:
Returns the number of items in the collection.

__property OSGeo ::FDO ::Expression ::Identifier* OSGeo::FDO::Commands::IdentifierCollection::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 ::Expression ::Identifier* OSGeo::FDO::Commands::IdentifierCollection::get_RealTypeItem System::Int32  index  ) 
 

Gets or sets a Identifier in the collection.

Parameters:
index Input index of the Identifier to retrieve or set (System::Int32).

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

Gets an enumerator that can iterate through a collection.

Returns:
Returns a collection enumerator.

OSGeo ::FDO ::Expression ::Identifier* OSGeo::FDO::Commands::IdentifierCollection::GetItem System::Int32  index  ) 
 

Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range.

Parameters:
index Input index of item
Returns:
Returns Identifier

OSGeo ::FDO ::Expression ::Identifier* OSGeo::FDO::Commands::IdentifierCollection::GetItem System::String *  name  ) 
 

Gets the item in the collection with the specified name. Throws an invalid argument exception if an item with the specified name does not exist in the collection.

Parameters:
name Input the item name
Returns:
Returns Identifier

System::Int32 OSGeo::FDO::Commands::IdentifierCollection::IndexOf OSGeo::FDO::Expression::Identifier value  ) 
 

Determines the index of a specific Identifier object.

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

System::Void OSGeo::FDO::Commands::IdentifierCollection::Insert System::Int32  index,
OSGeo::FDO::Expression::Identifier value
 

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

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

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

DOXYGEN-IGNORE

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

System::Void OSGeo::FDO::Commands::IdentifierCollection::Remove OSGeo::FDO::Expression::Identifier value  ) 
 

Removes the first occurrence of a specific Identifier object.

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

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

Removes the index-th Identifier from this collection.

Parameters:
index Input index of the element to remove.

__property System::Void OSGeo::FDO::Commands::IdentifierCollection::set_Item System::Int32  index,
OSGeo::FDO::Expression::Identifier 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::IdentifierCollection::set_RealTypeItem System::Int32  index,
OSGeo::FDO::Expression::Identifier 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.