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::Schema::ClassCollection Class Reference

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

Inheritance diagram for OSGeo::FDO::Schema::ClassCollection:

[legend]
List of all members.

Detailed Description

The ClassCollection class represents a collection of ClassDefinition objects.


Public Member Functions

System::Int32 Add (ClassDefinition *value)
 Adds a ClassDefinition object into the collection.
 ClassCollection (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a ClassCollection object based on an unmanaged instance of the object.
 ClassCollection (OSGeo::FDO::Schema::SchemaElement *parent)
 Constructs a ClassCollection object
System::Void Clear ()
 Removes all elements from the collection.
System::Boolean Contains (String *name)
 Determines whether the collection contains a specific ClassDefinition object.
System::Boolean Contains (ClassDefinition *value)
 Determines whether the collection contains a specific ClassDefinition object.
System::Void CopyTo (ClassDefinition *array[], System::Int32 startAt)
 Copies the elements of the collection to an array.
__property System::Int32 get_Count (System::Void)
 Gets the count of items in collection.
__property ClassDefinitionget_Item (System::Int32 index)
 Gets an item in the collection.
__property ClassDefinitionget_RealTypeItem (System::String *index)
 Gets the item in the collection by name.
__property ClassDefinitionget_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 (String *name)
System::Int32 IndexOf (ClassDefinition *value)
 Determines the index of a specific ClassDefinition object.
System::Void Insert (System::Int32 index, ClassDefinition *value)
 Inserts a ClassDefinition object into the collection at the specified position.
System::Void Remove (ClassDefinition *value)
 Removes the first occurrence of a specific ClassDefinition object.
System::Void RemoveAt (System::Int32 index)
 Removes the index-th ClassDefinition from this collection.
__property System::Void set_Item (System::Int32 index, ClassDefinition *value)
 Sets the value of the item at the specified index.
__property System::Void set_RealTypeItem (System::Int32 index, ClassDefinition *value)
 Sets the value of the item at the specified index.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()

Constructor & Destructor Documentation

OSGeo::FDO::Schema::ClassCollection::ClassCollection OSGeo::FDO::Schema::SchemaElement parent  ) 
 

Constructs a ClassCollection object

Parameters:
parent Input A Pointer to the parent schema object of the collection

OSGeo::FDO::Schema::ClassCollection::ClassCollection System::IntPtr  unmanaged,
System::Boolean  autoDelete
[inline]
 

Constructs a ClassCollection object based on an unmanaged instance of the object.

Parameters:
unmanaged Input A Pointer to the unmanaged object.
autoDelete Input Indicates if the constructed object should be automatically deleted once it no longer referenced.

Member Function Documentation

System::Int32 OSGeo::FDO::Schema::ClassCollection::Add ClassDefinition value  ) 
 

Adds a ClassDefinition object into the collection.

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

System::Void OSGeo::FDO::Schema::ClassCollection::Clear  ) 
 

Removes all elements from the collection.

System::Boolean OSGeo::FDO::Schema::ClassCollection::Contains String *  name  ) 
 

Determines whether the collection contains a specific ClassDefinition object.

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

System::Boolean OSGeo::FDO::Schema::ClassCollection::Contains ClassDefinition value  ) 
 

Determines whether the collection contains a specific ClassDefinition object.

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

System::Void OSGeo::FDO::Schema::ClassCollection::CopyTo ClassDefinition array[],
System::Int32  startAt
 

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.
startAt Input an integer that represents the index in array at which copying begins.

__property System::Int32 OSGeo::FDO::Schema::ClassCollection::get_Count System::Void   ) 
 

Gets the count of items in collection.

Returns:
Returns the number of items in the collection.

__property ClassDefinition* OSGeo::FDO::Schema::ClassCollection::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 ClassDefinition* OSGeo::FDO::Schema::ClassCollection::get_RealTypeItem System::String *  index  ) 
 

Gets the item in the collection by name.

Parameters:
index The name of the item in the collection.
Returns:
Returns an instance of a the collected item.

__property ClassDefinition* OSGeo::FDO::Schema::ClassCollection::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::Schema::ClassCollection::GetEnumerator System::Void   ) 
 

Gets an enumerator that can iterate through a collection.

Returns:
Returns an enumerator on the dictionary.

System::Int32 OSGeo::FDO::Schema::ClassCollection::IndexOf String *  name  ) 
 

System::Int32 OSGeo::FDO::Schema::ClassCollection::IndexOf ClassDefinition value  ) 
 

Determines the index of a specific ClassDefinition object.

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

System::Void OSGeo::FDO::Schema::ClassCollection::Insert System::Int32  index,
ClassDefinition value
 

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

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

System::Void OSGeo::FDO::Schema::ClassCollection::ReleaseUnmanagedObject  )  [protected, virtual]
 

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

System::Void OSGeo::FDO::Schema::ClassCollection::Remove ClassDefinition value  ) 
 

Removes the first occurrence of a specific ClassDefinition object.

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

System::Void OSGeo::FDO::Schema::ClassCollection::RemoveAt System::Int32  index  ) 
 

Removes the index-th ClassDefinition from this collection.

Parameters:
index Input index of the element to remove.

__property System::Void OSGeo::FDO::Schema::ClassCollection::set_Item System::Int32  index,
ClassDefinition 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::Schema::ClassCollection::set_RealTypeItem System::Int32  index,
ClassDefinition 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.