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::Geometry::RingCollection Class Reference

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

Inheritance diagram for OSGeo::FDO::Geometry::RingCollection:

[legend]
List of all members.

Detailed Description

The RingCollection class is a collection of IRing objects.


Public Member Functions

System::Int32 Add (OSGeo::FDO::Geometry::IRing *value)
 Adds a IRing object into the collection.
System::Void Clear ()
 Removes all elements from the collection.
System::Boolean Contains (OSGeo::FDO::Geometry::IRing *value)
 Determines whether the collection contains a specific IRing object.
System::Void CopyTo (OSGeo::FDO::Geometry::IRing *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 OSGeo::FDO::Geometry::IRingget_Item (System::Int32 index)
 Gets an IPoint object in the collection.
__property OSGeo::FDO::Geometry::IRingget_RealTypeItem (System::Int32 index)
 Gets an ILineString object in the collection.
__sealed System::Collections::IEnumerator * GetEnumerator (System::Void)
 Gets an enumerator that can iterate through a collection.
System::Int32 IndexOf (OSGeo::FDO::Geometry::IRing *value)
 Determines the index of a specific IRing object.
System::Void Insert (System::Int32 index, OSGeo::FDO::Geometry::IRing *value)
 Inserts an IRing object to the collection at the specified position.
System::Void Remove (OSGeo::FDO::Geometry::IRing *value)
 Removes the first occurrence of a specific IRing object.
System::Void RemoveAt (System::Int32 index)
 Removes the index-th IRing from this collection.
 RingCollection ()
 Creates an instance of RingCollection with no contained elements.
 RingCollection (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a managed object based on an unmanaged instance of the object.
__property System::Void set_Item (System::Int32 index, OSGeo::FDO::Geometry::IRing *value)
 Sets the value of the IPoint object at the specified index.
__property System::Void set_RealTypeItem (System::Int32 index, OSGeo::FDO::Geometry::IRing *value)
 Sets the value of the ILineString object at the specified index.

Protected Member Functions

__sealed System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Geometry::RingCollection::RingCollection System::IntPtr  unmanaged,
System::Boolean  autoDelete
 

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

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

OSGeo::FDO::Geometry::RingCollection::RingCollection  ) 
 

Creates an instance of RingCollection with no contained elements.

Returns:
Returns an empty collection

Member Function Documentation

System::Int32 OSGeo::FDO::Geometry::RingCollection::Add OSGeo::FDO::Geometry::IRing value  ) 
 

Adds a IRing object into the collection.

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

System::Void OSGeo::FDO::Geometry::RingCollection::Clear  ) 
 

Removes all elements from the collection.

System::Boolean OSGeo::FDO::Geometry::RingCollection::Contains OSGeo::FDO::Geometry::IRing value  ) 
 

Determines whether the collection contains a specific IRing object.

Parameters:
value Input The IRing object to locate in the collection.
Returns:
True if the value is found in the collection; otherwise, false.

System::Void OSGeo::FDO::Geometry::RingCollection::CopyTo OSGeo::FDO::Geometry::IRing 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::Geometry::RingCollection::get_Count System::Void   ) 
 

Gets the count of items in collection.

Returns:
Returns the number of items in the collection.

__property OSGeo ::FDO ::Geometry ::IRing* OSGeo::FDO::Geometry::RingCollection::get_Item System::Int32  index  ) 
 

Gets an IPoint object in the collection.

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

__property OSGeo ::FDO ::Geometry ::IRing* OSGeo::FDO::Geometry::RingCollection::get_RealTypeItem System::Int32  index  ) 
 

Gets an ILineString object in the collection.

Parameters:
index Input index of the ILineString object to retrieve.

__sealed System::Collections::IEnumerator* OSGeo::FDO::Geometry::RingCollection::GetEnumerator System::Void   ) 
 

Gets an enumerator that can iterate through a collection.

Returns:
Returns an enumerator on the dictionary.

System::Int32 OSGeo::FDO::Geometry::RingCollection::IndexOf OSGeo::FDO::Geometry::IRing value  ) 
 

Determines the index of a specific IRing object.

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

System::Void OSGeo::FDO::Geometry::RingCollection::Insert System::Int32  index,
OSGeo::FDO::Geometry::IRing value
 

Inserts an IRing object to the collection at the specified position.

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

__sealed System::Void OSGeo::FDO::Geometry::RingCollection::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

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

System::Void OSGeo::FDO::Geometry::RingCollection::Remove OSGeo::FDO::Geometry::IRing value  ) 
 

Removes the first occurrence of a specific IRing object.

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

System::Void OSGeo::FDO::Geometry::RingCollection::RemoveAt System::Int32  index  ) 
 

Removes the index-th IRing from this collection.

Parameters:
index Input index of the element to remove.

__property System::Void OSGeo::FDO::Geometry::RingCollection::set_Item System::Int32  index,
OSGeo::FDO::Geometry::IRing value
 

Sets the value of the IPoint object at the specified index.

Parameters:
index Input index of the IPoint object to set.
value Input the value of the IPoint object

__property System::Void OSGeo::FDO::Geometry::RingCollection::set_RealTypeItem System::Int32  index,
OSGeo::FDO::Geometry::IRing value
 

Sets the value of the ILineString object at the specified index.

Parameters:
index Input index of the ILineString object to set.
value Input the value of the ILineString

Comments or suggestions? Send us feedback.