[fdo-commits] r698 - branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Wed Jan 31 20:48:48 EST 2007
Author: gregboone
Date: 2007-01-31 20:48:47 -0500 (Wed, 31 Jan 2007)
New Revision: 698
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgDirectPositionImpl.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgEnvelopeImpl.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgFgfGeometryFactory.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgGeometryFactoryAbstract.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIArcSegmentAbstractImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICircularArcSegmentImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveAbstract.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveAbstractImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurvePolygonImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveSegmentAbstract.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveSegmentAbstractImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveStringImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPosition.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPositionImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelope.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelopeImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometricAggregateAbstractImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometry.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometryImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineString.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringSegment.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringSegmentImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRing.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRingImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiCurvePolygonImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiCurveStringImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiGeometryImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiLineStringImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiPointImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiPolygonImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPoint.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPointImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPolygonImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingAbstract.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingAbstractImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgISurfaceAbstractImp.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/stdafx.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgDirectPositionImpl.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgDirectPositionImpl.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgDirectPositionImpl.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -32,54 +32,57 @@
public __gc class DirectPositionImpl : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_GEOMETRY::IDirectPosition
{
public:
+ /// \brief
+ /// InEquality function for DirectPositionImpl.
+ ///
+ /// \param right
+ /// Input envelope for comparison (right-hand-side of equation)
+ ///
+ /// \param left
+ /// Input envelope for comparison (left-hand-side of equation)
+ ///
+ /// \return
+ /// Returns true if all ordinates and dimensionality are not exactly equal.
+ ///
static System::Boolean op_Inequality(DirectPositionImpl *left, DirectPositionImpl *right);
/// \brief
/// Constructs a default instance of a DirectPositionImpl object.
///
/// \remarks
- /// Ordinate values default to System::Double::NaN.
+ /// Ordinate values default to System::Double::NaN.
/// Dimensionality defaults to Dimensionality_XY.
///
- /// \return
- /// Returns nothing
- ///
DirectPositionImpl();
/// \brief
/// Constructs a 2D DirectPositionImpl object from X and Y ordinates.
///
/// \remarks
- /// Z and M ordinate values default to System::Double::NaN.
+ /// Z and M ordinate values default to System::Double::NaN.
/// Dimensionality is set to Dimensionality_XY.
///
- /// \param x
+ /// \param coordinateX
/// Input X ordinate value
- /// \param y
+ /// \param coordinateY
/// Input Y ordinate value
///
- /// \return
- /// Returns nothing
- ///
DirectPositionImpl(System::Double coordinateX, System::Double coordinateY);
/// \brief
/// Constructs a 3D DirectPositionImpl object from X, Y and Z ordinates.
///
/// \remarks
- /// M ordinate value defaults to System::Double::NaN.
+ /// M ordinate value defaults to System::Double::NaN.
/// Dimensionality is set to Dimensionality_XYZ.
///
- /// \param x
+ /// \param coordinateX
/// Input X ordinate value
- /// \param y
+ /// \param coordinateY
/// Input Y ordinate value
- /// \param z
+ /// \param coordinateZ
/// Input Z ordinate value
///
- /// \return
- /// Returns nothing
- ///
DirectPositionImpl(System::Double coordinateX, System::Double coordinateY, System::Double coordinateZ);
/// \brief
@@ -88,18 +91,15 @@
/// \remarks
/// Dimensionality is set to Dimensionality_XYZ|Dimensionality_M.
///
- /// \param x
+ /// \param coordinateX
/// Input X ordinate value
- /// \param y
+ /// \param coordinateY
/// Input Y ordinate value
- /// \param z
+ /// \param coordinateZ
/// Input Z ordinate value
- /// \param m
+ /// \param coordinateM
/// Input M ordinate value
///
- /// \return
- /// Returns nothing
- ///
DirectPositionImpl(System::Double coordinateX, System::Double coordinateY, System::Double coordinateZ, System::Double coordinateM);
/// \brief
@@ -108,9 +108,6 @@
/// \param position
/// Input position to copy
///
- /// \return
- /// Returns nothing
- ///
DirectPositionImpl(DirectPositionImpl *position);
/// \brief
@@ -120,43 +117,54 @@
/// Copies position data using only public methods of IDirectPosition,
/// thus supporting conversion from any implementation of the interface.
///
- /// \param pos
+ /// \param position
/// Input position to copy
///
- /// \return
- /// Returns nothing
- ///
DirectPositionImpl(NAMESPACE_OSGEO_GEOMETRY::IDirectPosition *position);
/// \brief
- /// Assignment operator for DirectPositionImpl.
+ /// Assignment function for DirectPositionImpl.
///
- /// \param position
- /// Input position to copy
+ /// \param left
+ /// Input Source position to copy
///
- /// \return
- /// Returns a position
+ /// \param right
+ /// Input Destination position
///
static System::Void op_Assign(DirectPositionImpl *left, DirectPositionImpl *right);
/// \brief
- /// Assignment operator for DirectPositionImpl from a IDirectPosition, using public methods.
+ /// Assignment function for DirectPositionImpl from a IDirectPosition, using public methods.
///
- /// \param position
- /// Input position to copy
+ /// \param left
+ /// Input Source position to copy
///
- /// \return
- /// Returns a position
+ /// \param right
+ /// Input Destination position
///
static System::Void op_Assign(DirectPositionImpl *left, IDirectPosition *right);
+ /// \brief
+ /// Equality function for FdoDirectPositionImpl.
+ ///
+ /// \param obj
+ /// Input position for comparison (right-hand-side of equation)
+ ///
+ /// \return
+ /// Returns true if all ordinates and dimensionality are exactly equal.
+ ///
System::Boolean Equals(System::Object* obj);
+/// \cond DOXYGEN-IGNORE
System::Int32 GetHashCode();
+/// \endcond
/// \brief
- /// Equality operator for DirectPositionImpl.
+ /// Equality function for DirectPositionImpl.
///
+ /// \param left
+ /// Input position for comparison (left-hand-side of equation)
+ ///
/// \param right
/// Input position for comparison (right-hand-side of equation)
///
@@ -176,7 +184,7 @@
/// \brief
/// Sets the X ordinate.
///
- /// \param x
+ /// \param value
/// Input X ordinate value
///
/// \return
@@ -195,7 +203,7 @@
/// \brief
/// Sets the Y ordinate.
///
- /// \param y
+ /// \param value
/// Input Y ordinate value
///
/// \return
@@ -233,7 +241,7 @@
/// \brief
/// Sets the M ordinate.
///
- /// \param m
+ /// \param value
/// Input M ordinate value
///
/// \return
@@ -257,9 +265,9 @@
/// Sets the dimensionality.
///
/// \remarks
- /// Use values (including bitwise combinations) from the Dimensionality enumeration.
+ /// Use values (including bitwise combinations) from the Dimensionality enumeration.
///
- /// \param dimensionality
+ /// \param value
/// Input dimensionality value
///
/// \return
@@ -268,13 +276,25 @@
__property System::Void set_Dimensionality(System::Int32 value);
public:
+ /// \brief
+ /// Constructs an Position based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
DirectPositionImpl(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
public private:
FdoDirectPositionImpl *GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_GEOMETRY
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgEnvelopeImpl.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgEnvelopeImpl.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgEnvelopeImpl.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -37,13 +37,25 @@
public __gc class EnvelopeImpl : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_GEOMETRY::IEnvelope
{
public:
+ /// \brief
+ /// InEquality function for EnvelopeImpl.
+ ///
+ /// \param right
+ /// Input envelope for comparison (right-hand-side of equation)
+ ///
+ /// \param left
+ /// Input envelope for comparison (left-hand-side of equation)
+ ///
+ /// \return
+ /// Returns true if the envelope ordinates are not equal.
+ ///
static System::Boolean op_Inequality(EnvelopeImpl *left, EnvelopeImpl* right);
/// \brief
/// Constructs a default instance of a EnvelopeImpl object.
///
/// \remarks
- /// Ordinate values default to System::Double::NaN.
+ /// Ordinate values default to System::Double::NaN.
///
/// \return
/// Returns nothing
@@ -54,7 +66,7 @@
/// Constructs a 2D EnvelopeImpl object from X and Y ordinates.
///
/// \remarks
- /// Z ordinate value defaults to System::Double::NaN.
+ /// Z ordinate value defaults to System::Double::NaN.
///
/// \param minX
/// Input Lower-left X ordinate
@@ -118,7 +130,7 @@
EnvelopeImpl(NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* lowerLeft, NAMESPACE_OSGEO_GEOMETRY::IDirectPosition * upperRight);
/// \brief
- /// Constructs a EnvelopeImpl object by copying from an array of ordinates.
+ /// Constructs a EnvelopeImpl object by copying from an array of ordinates.
///
/// \param dimensionType
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -131,19 +143,33 @@
EnvelopeImpl(System::Int32 dimensionType, System::Double ordinates __gc[]);
/// \brief
- /// Equality operator for EnvelopeImpl.
+ /// Equality function for EnvelopeImpl.
///
/// \param right
/// Input envelope for comparison (right-hand-side of equation)
///
+ /// \param left
+ /// Input envelope for comparison (left-hand-side of equation)
+ ///
/// \return
/// Returns true if all non-NaN ordinates exactly equal. All NaN values compare as equal to each other.
///
static System::Boolean op_Equality(EnvelopeImpl *left, EnvelopeImpl* right);
+ /// \brief
+ /// Equality function for EnvelopeImpl.
+ ///
+ /// \param obj
+ /// Input envelope for comparison (right-hand-side of equation)
+ ///
+ /// \return
+ /// Returns true if all non-NaN ordinates exactly equal to this instance. All NaN values compare as equal to each other.
+ ///
System::Boolean Equals(System::Object* obj);
+/// \cond DOXYGEN-IGNORE
System::Int32 GetHashCode();
+/// \endcond
/// \brief
/// Gets the minimum X coordinate value.
@@ -228,6 +254,7 @@
/// Returns the maximum Y ordinate; numeric_limits<double>::quiet_NaN() by default
///
__property System::Double get_MaxY();
+
/// \brief
/// Sets the maximum Y coordinate value.
///
@@ -289,13 +316,25 @@
System::Void Expand(NAMESPACE_OSGEO_GEOMETRY::IEnvelope* envelope);
public:
+ /// \brief
+ /// Constructs an Envelope based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
EnvelopeImpl(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
public private:
FdoEnvelopeImpl* GetImpObj();
+/// \endcond
};
END_NAMESPACE_OSGEO_GEOMETRY
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgFgfGeometryFactory.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgFgfGeometryFactory.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgFgfGeometryFactory.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -57,26 +57,32 @@
BEGIN_NAMESPACE_OSGEO_GEOMETRY
/// \brief
-/// The FdoFgfGeometryFactory class is an FGF-based Geometry factory, a concrete class that
-/// implements all the members from FdoGeometryFactoryAbstract
+/// The FgfGeometryFactory class is an FGF-based Geometry factory, a concrete class that
+/// implements all the members from GeometryFactoryAbstract
public __gc class FgfGeometryFactory : public GeometryFactoryAbstract
{
public:
+ /// \brief
+ /// Constructs an FgfGeometryFactory based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
FgfGeometryFactory(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
FdoFgfGeometryFactory *GetImpObj();
+/// \endcond
public:
/// \brief
- /// Instantiates an object of this class.
+ /// Instantiates an FgfGeometryFactory object.
///
- /// \remarks
- /// This class is its own factory. Use this instead of a constructor.
- ///
- /// \return
- /// Returns a FdoFgfGeometryFactory object
- ///
FgfGeometryFactory();
/// \brief
@@ -86,7 +92,7 @@
/// Input FGF data that defines the Geometry.
///
/// \return
- /// Returns a Geometry
+ /// Returns an instance of IGeometry
///
NAMESPACE_OSGEO_GEOMETRY::IGeometry * CreateGeometryFromFgf(System::Byte bytes[]);
@@ -101,7 +107,7 @@
/// Input Number of bytes of FGF data.
///
/// \return
- /// Returns a Geometry
+ /// Returns an instance of IGeometry
///
NAMESPACE_OSGEO_GEOMETRY::IGeometry * CreateGeometryFromFgf(System::Byte bytes[], Int32 count);
@@ -141,7 +147,7 @@
/// Methods from GeometryFactoryAbstract
/// \brief
- /// Creates a LineString object by copying from a collection of positions.
+ /// Creates a LineString object by copying from a collection of positions.
///
/// \param positions
/// Input collection of positions to copy
@@ -153,7 +159,7 @@
NAMESPACE_OSGEO_GEOMETRY::DirectPositionCollection * positions);
/// \brief
- /// Creates a LineString object by copying from an array of ordinates.
+ /// Creates a LineString object by copying from an array of ordinates.
///
/// \param dimensionType
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -171,10 +177,10 @@
System::Double ordinates[]);
/// \brief
- /// Creates a Geometry object by copying from another Geometry.
+ /// Creates a Geometry object by copying from another Geometry.
///
/// \remarks
- /// This is a pseudo-copy-constructor.
+ /// This is a pseudo-copy-constructor.
/// It is required that any implementation use only public methods on the underlying
/// Geometry object, thus enabling conversion from Geometries of the same, or any
/// other, implementation of this Geometry package. Thus, this implementation creates
@@ -184,27 +190,27 @@
/// Input Source geometry
///
/// \return
- /// Returns an envelope
+ /// Returns an instance of IGeometry
///
NAMESPACE_OSGEO_GEOMETRY::IGeometry * CreateGeometry(
NAMESPACE_OSGEO_GEOMETRY::IGeometry * geometry);
/// \brief
- /// Creates a Geometry object by converting from a text string.
+ /// Creates a Geometry object by converting from a text string.
///
/// \param text
/// Input Source geometry
///
/// \return
- /// Returns a geometry
+ /// Returns an instance of IGeometry
///
NAMESPACE_OSGEO_GEOMETRY::IGeometry * CreateGeometry(System::String* text);
/// \brief
- /// Creates a Geometry object by converting from an envelope.
+ /// Creates a Geometry object by converting from an envelope.
///
/// \remarks
- /// This method will produce a new FGF-based Geometry
+ /// This method will produce a new FGF-based Geometry
/// based on the given envelope.
///
/// \param envelope
@@ -219,7 +225,7 @@
/// Point
/// \brief
- /// Creates a point object by copying from a position.
+ /// Creates a point object by copying from a position.
///
/// \param position
/// Input position to copy
@@ -231,7 +237,7 @@
NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* position);
/// \brief
- /// Creates an point object by copying from an array of ordinates.
+ /// Creates an point object by copying from an array of ordinates.
///
/// \param dimensionality
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -248,10 +254,10 @@
/// LinearRing
/// \brief
- /// Creates a LinearRing object by copying from a collection of positions.
+ /// Creates a LinearRing object by copying from a collection of positions.
///
/// \remarks
- /// The first and last positions must be equal.
+ /// The first and last positions must be equal.
///
/// \param positions
/// Input collection of positions to copy
@@ -263,10 +269,10 @@
NAMESPACE_OSGEO_GEOMETRY::DirectPositionCollection* positions);
/// \brief
- /// Creates a LinearRing object by copying from an array of ordinates.
+ /// Creates a LinearRing object by copying from an array of ordinates.
///
/// \remarks
- /// The ordinates representing the first and last positions must be equal.
+ /// The ordinates representing the first and last positions must be equal.
///
/// \param dimensionality
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -286,7 +292,7 @@
/// LineStringSegment
/// \brief
- /// Creates a LineStringSegment object by copying from a collection of positions.
+ /// Creates a LineStringSegment object by copying from a collection of positions.
///
/// \param positions
/// Input collection of positions to copy
@@ -298,7 +304,7 @@
NAMESPACE_OSGEO_GEOMETRY::DirectPositionCollection* positions);
/// \brief
- /// Creates a LineStringSegment object by copying from an array of ordinates.
+ /// Creates a LineStringSegment object by copying from an array of ordinates.
///
/// \param dimtype
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -318,7 +324,7 @@
/// Polygon
/// \brief
- /// Creates a polygon object by copying from given LinearRing objects.
+ /// Creates a polygon object by copying from given LinearRing objects.
///
/// \param exteriorRing
/// Input exterior ring to copy
@@ -335,7 +341,7 @@
/// MultiPoint
/// \brief
- /// Creates a MultiPoint object by copying from a collection of point objects.
+ /// Creates a MultiPoint object by copying from a collection of point objects.
///
/// \param points
/// Input collection of point objects to copy
@@ -347,7 +353,7 @@
NAMESPACE_OSGEO_GEOMETRY::PointCollection* points);
/// \brief
- /// Creates a MultiPoint object by copying from an array of ordinates.
+ /// Creates a MultiPoint object by copying from an array of ordinates.
///
/// \param dimensionality
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -367,7 +373,7 @@
/// MultiLineString
/// \brief
- /// Creates a MultiLineString object by copying from a collection of LineString objects.
+ /// Creates a MultiLineString object by copying from a collection of LineString objects.
///
/// \param lineStrings
/// Input collection of LineString objects to copy
@@ -381,7 +387,7 @@
//MultiPolygon
/// \brief
- /// Creates a MultiPolygon object by copying from a collection of polygon objects.
+ /// Creates a MultiPolygon object by copying from a collection of polygon objects.
///
/// \param polygons
/// Input collection of polygon objects to copy
@@ -395,7 +401,7 @@
/// CircularArcSegment
/// \brief
- /// Creates a CircularArcSegment object by copying from three points on the arc.
+ /// Creates a CircularArcSegment object by copying from three points on the arc.
///
/// \param startPosition
/// Input starting position of the arc
@@ -415,7 +421,7 @@
/// CurveString
/// \brief
- /// Creates a CurveString object by copying from a collection of CurveSegment objects.
+ /// Creates a CurveString object by copying from a collection of CurveSegment objects.
///
/// \param curveSegments
/// Input collection of CurveSegment objects to copy
@@ -429,7 +435,7 @@
/// MultiCurveString
/// \brief
- /// Creates a MultiCurveString object by copying from a collection of CurveString objects.
+ /// Creates a MultiCurveString object by copying from a collection of CurveString objects.
///
/// \param curveStrings
/// Input collection of CurveString objects to copy
@@ -443,7 +449,7 @@
/// Ring
/// \brief
- /// Creates a ring object by copying from a collection of CurveSegment objects.
+ /// Creates a ring object by copying from a collection of CurveSegment objects.
///
/// \param curveSegments
/// Input collection of CurveSegment objects to copy
@@ -457,7 +463,7 @@
/// CurvePolygon
/// \brief
- /// Creates a CurvePolygon object by copying from given ring objects.
+ /// Creates a CurvePolygon object by copying from given ring objects.
///
/// \param exteriorRing
/// Input exterior ring to copy
@@ -474,7 +480,7 @@
/// MultiCurvePolygon
/// \brief
- /// Creates a MultiCurvePolygon object by copying from a collection of CurvePolygon objects.
+ /// Creates a MultiCurvePolygon object by copying from a collection of CurvePolygon objects.
///
/// \param curvePolygons
/// Input collection of CurvePolygon objects to copy
@@ -488,7 +494,7 @@
/// MultiGeometry
/// \brief
- /// Creates a MultiGeometry object by copying from a collection of Geometry objects.
+ /// Creates a MultiGeometry object by copying from a collection of Geometry objects.
///
/// \param geometries
/// Input collection of Geometry objects to copy
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgGeometryFactoryAbstract.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgGeometryFactoryAbstract.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgGeometryFactoryAbstract.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -53,31 +53,43 @@
BEGIN_NAMESPACE_OSGEO_GEOMETRY
/// \brief
-///
+///
/// The GeometryFactoryAbstract class is a factory (abstract, non-pure) for Geometry objects and Geometry helper objects.
public __gc class GeometryFactoryAbstract : public NAMESPACE_OSGEO_RUNTIME::Disposable
{
public:
+ /// \brief
+ /// Constructs an GeometryFactoryAbstract managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
GeometryFactoryAbstract(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
public private:
FdoGeometryFactoryAbstract *GetImpObj();
protected:
__sealed System::Void ReleaseUnmanagedObject();
+/// \endcond
public:
/// \brief
- /// Creates a position object using X and Y ordinates.
+ /// Creates a position object using X and Y ordinates.
///
/// \remarks
- /// The resulting object's accessor methods for ordinates
+ /// The resulting object's accessor methods for ordinates
/// that are not given here as input parameters will return the default
/// value of 0.0.
///
- /// \param x
+ /// \param coordinateX
/// Input X ordinate value
- /// \param y
+ /// \param coordinateY
/// Input Y ordinate value
///
/// \return
@@ -86,18 +98,18 @@
NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* CreatePositionXY(System::Double coordinateX, System::Double coordinateY);
/// \brief
- /// Creates a position object using X, Y and Z ordinates.
+ /// Creates a position object using X, Y and Z ordinates.
///
/// \remarks
- /// The resulting object's accessor methods for ordinates
+ /// The resulting object's accessor methods for ordinates
/// that are not given here as input parameters will return the default
/// value of 0.0.
///
- /// \param x
+ /// \param coordinateX
/// Input X ordinate value
- /// \param y
+ /// \param coordinateY
/// Input Y ordinate value
- /// \param z
+ /// \param coordinateZ
/// Input Z ordinate value
///
/// \return
@@ -106,18 +118,18 @@
NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* CreatePositionXYZ(System::Double coordinateX, System::Double coordinateY, System::Double coordinateZ);
/// \brief
- /// Creates a position object using X, Y and M ordinates.
+ /// Creates a position object using X, Y and M ordinates.
///
/// \remarks
- /// The resulting object's accessor methods for ordinates
+ /// The resulting object's accessor methods for ordinates
/// that are not given here as input parameters will return the default
/// value of 0.0.
///
- /// \param x
+ /// \param coordinateX
/// Input X ordinate value
- /// \param y
+ /// \param coordinateY
/// Input Y ordinate value
- /// \param m
+ /// \param coordinateM
/// Input M ordinate value
///
/// \return
@@ -126,15 +138,15 @@
NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* CreatePositionXYM(System::Double coordinateX, System::Double coordinateY, System::Double coordinateM);
/// \brief
- /// Creates a position object using X, Y, Z and M ordinates.
+ /// Creates a position object using X, Y, Z and M ordinates.
///
- /// \param x
+ /// \param coordinateX
/// Input X ordinate value
- /// \param y
+ /// \param coordinateY
/// Input Y ordinate value
- /// \param z
+ /// \param coordinateZ
/// Input Z ordinate value
- /// \param m
+ /// \param coordinateM
/// Input M ordinate value
///
/// \return
@@ -143,7 +155,7 @@
NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* CreatePositionXYZM(System::Double coordinateX, System::Double coordinateY, System::Double coordinateZ, System::Double coordinateM);
/// \brief
- /// Creates a position object by copying from an existing position.
+ /// Creates a position object by copying from an existing position.
///
/// \param position
/// Input position to copy
@@ -156,7 +168,7 @@
/// Envelope
/// \brief
- /// Creates an envelope object using two positions.
+ /// Creates an envelope object using two positions.
///
/// \param lowerLeft
/// Input lower-left position
@@ -169,7 +181,7 @@
NAMESPACE_OSGEO_GEOMETRY::IEnvelope* CreateEnvelope(NAMESPACE_OSGEO_GEOMETRY::IDirectPosition * lowerLeft, NAMESPACE_OSGEO_GEOMETRY::IDirectPosition * upperRight);
/// \brief
- /// Creates an envelope object by copying from an array of ordinates.
+ /// Creates an envelope object by copying from an array of ordinates.
///
/// \param dimensionType
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -182,7 +194,7 @@
NAMESPACE_OSGEO_GEOMETRY::IEnvelope* CreateEnvelope(System::Int32 dimensionType, System::Double ordinates __gc []);
/// \brief
- /// Creates an envelope object using X and Y ordinates.
+ /// Creates an envelope object using X and Y ordinates.
///
/// \param lowerLeftX
/// Input lower-left X ordinate
@@ -203,7 +215,7 @@
System::Double upperRightY);
/// \brief
- /// Creates an envelope object using X, Y and Z ordinates.
+ /// Creates an envelope object using X, Y and Z ordinates.
///
/// \param lowerLeftX
/// Input lower-left, rear X ordinate
@@ -230,7 +242,7 @@
System::Double upperRightZ);
/// \brief
- /// Creates a envelope object by copying from another envelope.
+ /// Creates a envelope object by copying from another envelope.
///
/// \param envelope
/// Input Source envelope
@@ -243,7 +255,7 @@
/// LineString
/// \brief
- /// Creates a LineString object by copying from a collection of positions.
+ /// Creates a LineString object by copying from a collection of positions.
///
/// \param positions
/// Input collection of positions to copy
@@ -254,7 +266,7 @@
NAMESPACE_OSGEO_GEOMETRY::ILineString* CreateLineString(NAMESPACE_OSGEO_GEOMETRY::DirectPositionCollection* positions);
/// \brief
- /// Creates a LineString object by copying from an array of ordinates.
+ /// Creates a LineString object by copying from an array of ordinates.
///
/// \param dimensionType
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -271,10 +283,10 @@
/// Geometry
/// \brief
- /// Creates a Geometry object by copying from another Geometry.
+ /// Creates a Geometry object by copying from another Geometry.
///
/// \remarks
- /// This is a pseudo-copy-constructor.
+ /// This is a pseudo-copy-constructor.
/// It is required that any implementation use only public methods on the underlying
/// Geometry object, thus enabling conversion from geometries of the same (or any
/// other) implementation of this Geometry package.
@@ -288,10 +300,10 @@
NAMESPACE_OSGEO_GEOMETRY::IGeometry * CreateGeometry(NAMESPACE_OSGEO_GEOMETRY::IGeometry * geometry);
/// \brief
- /// Creates a Geometry object by converting from a text string.
+ /// Creates a Geometry object by converting from a text string.
///
/// \remarks
- /// While this method is not pure virtual, its default implementation will
+ /// While this method is not pure virtual, its default implementation will
/// throw an exception if called. A concrete, derived class should override this
/// method if conversion from text is required.
///
@@ -304,10 +316,10 @@
NAMESPACE_OSGEO_GEOMETRY::IGeometry * CreateGeometry(System::String* text);
/// \brief
- /// Creates a Geometry object by converting from an envelope.
+ /// Creates a Geometry object by converting from an envelope.
///
/// \remarks
- /// This method will produce a new Geometry
+ /// This method will produce a new Geometry
/// based on the given envelope. The actual geometry type produced is implementation-dependent.
///
/// \param envelope
@@ -321,7 +333,7 @@
/// Point
/// \brief
- /// Creates a point object by copying from a position.
+ /// Creates a point object by copying from a position.
///
/// \param position
/// Input position to copy
@@ -332,7 +344,7 @@
NAMESPACE_OSGEO_GEOMETRY::IPoint* CreatePoint(NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* position);
/// \brief
- /// Creates a point object by copying from an array of ordinates.
+ /// Creates a point object by copying from an array of ordinates.
///
/// \param dimensionality
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -347,10 +359,10 @@
/// LinearRing
/// \brief
- /// Creates a LinearRing object by copying from a collection of positions.
+ /// Creates a LinearRing object by copying from a collection of positions.
///
/// \remarks
- /// The first and last positions must be equal.
+ /// The first and last positions must be equal.
///
/// \param positions
/// Input collection of positions to copy
@@ -361,10 +373,10 @@
NAMESPACE_OSGEO_GEOMETRY::ILinearRing* CreateLinearRing(NAMESPACE_OSGEO_GEOMETRY::DirectPositionCollection* positions);
/// \brief
- /// Creates a LinearRing object by copying from an array of ordinates.
+ /// Creates a LinearRing object by copying from an array of ordinates.
///
/// \remarks
- /// The ordinates representing the first and last positions must be equal.
+ /// The ordinates representing the first and last positions must be equal.
///
/// \param dimensionality
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -384,7 +396,7 @@
/// LineStringSegment
/// \brief
- /// Creates a LineStringSegment object by copying from a collection of positions.
+ /// Creates a LineStringSegment object by copying from a collection of positions.
///
/// \param positions
/// Input collection of positions to copy
@@ -395,7 +407,7 @@
NAMESPACE_OSGEO_GEOMETRY::ILineStringSegment* CreateLineStringSegment(NAMESPACE_OSGEO_GEOMETRY::DirectPositionCollection* positions);
/// \brief
- /// Creates a LineStringSegment object by copying from an array of ordinates.
+ /// Creates a LineStringSegment object by copying from an array of ordinates.
///
/// \param dimtype
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -415,7 +427,7 @@
/// Polygon
/// \brief
- /// Creates a polygon object by copying from given LinearRing objects.
+ /// Creates a polygon object by copying from given LinearRing objects.
///
/// \param exteriorRing
/// Input exterior ring to copy
@@ -432,7 +444,7 @@
/// MultiPoint
/// \brief
- /// Creates a MultiPoint object by copying from a collection of point objects.
+ /// Creates a MultiPoint object by copying from a collection of point objects.
///
/// \param points
/// Input collection of point objects to copy
@@ -443,7 +455,7 @@
NAMESPACE_OSGEO_GEOMETRY::IMultiPoint* CreateMultiPoint(NAMESPACE_OSGEO_GEOMETRY::PointCollection* points);
/// \brief
- /// Creates a MultiPoint object by copying from an array of ordinates.
+ /// Creates a MultiPoint object by copying from an array of ordinates.
///
/// \param dimensionality
/// Input dimensionality of the ordinates (see Dimensionality)
@@ -463,7 +475,7 @@
/// MultiLineString
/// \brief
- /// Creates a MultiLineString object by copying from a collection of LineString objects.
+ /// Creates a MultiLineString object by copying from a collection of LineString objects.
///
/// \param lineStrings
/// Input collection of LineString objects to copy
@@ -476,7 +488,7 @@
//MultiPolygon
/// \brief
- /// Creates a MultiPolygon object by copying from a collection of polygon objects.
+ /// Creates a MultiPolygon object by copying from a collection of polygon objects.
///
/// \param polygons
/// Input collection of polygon objects to copy
@@ -489,11 +501,11 @@
/// CircularArcSegment
/// \brief
- /// Creates a CircularArcSegment object by copying from three points on the arc.
+ /// Creates a CircularArcSegment object by copying from three points on the arc.
///
/// \param startPosition
/// Input starting position of the arc
- /// \param midPosition
+ /// \param coordinateMidPosition
/// Input a position on the arc, and not equal to the starting or ending positions
/// \param endPosition
/// Input ending position of the arc
@@ -509,7 +521,7 @@
/// CurveString
/// \brief
- /// Creates a CurveString object by copying from a collection of CurveSegment objects.
+ /// Creates a CurveString object by copying from a collection of CurveSegment objects.
///
/// \param curveSegments
/// Input collection of CurveSegment objects to copy
@@ -522,7 +534,7 @@
/// MultiCurveString
/// \brief
- /// Creates an MultiCurveString object by copying from a collection of CurveString objects.
+ /// Creates an MultiCurveString object by copying from a collection of CurveString objects.
///
/// \param curveStrings
/// Input collection of CurveString objects to copy
@@ -535,7 +547,7 @@
/// Ring
/// \brief
- /// Creates a ring object by copying from a collection of CurveSegment objects.
+ /// Creates a ring object by copying from a collection of CurveSegment objects.
///
/// \param curveSegments
/// Input collection of CurveSegment objects to copy
@@ -549,7 +561,7 @@
/// CurvePolygon
/// \brief
- /// Creates a CurvePolygon object by copying from given ring objects.
+ /// Creates a CurvePolygon object by copying from given ring objects.
///
/// \param exteriorRing
/// Input exterior ring to copy
@@ -566,7 +578,7 @@
/// MultiCurvePolygon
/// \brief
- /// Creates a MultiCurvePolygon object by copying from a collection of CurvePolygon objects.
+ /// Creates a MultiCurvePolygon object by copying from a collection of CurvePolygon objects.
///
/// \param curvePolygons
/// Input collection of CurvePolygon objects to copy
@@ -579,7 +591,7 @@
/// MultiGeometry
/// \brief
- /// Creates a MultiGeometry object by copying from a collection of Geometry objects.
+ /// Creates a MultiGeometry object by copying from a collection of Geometry objects.
///
/// \param geometries
/// Input collection of Geometry objects to copy
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIArcSegmentAbstractImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIArcSegmentAbstractImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIArcSegmentAbstractImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -35,6 +35,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IArcSegmentAbstract, public NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstractImp
{
public:
+ /// \brief
+ /// Constructs an IArcSegmentAbstractImp managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IArcSegmentAbstractImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICircularArcSegmentImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICircularArcSegmentImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICircularArcSegmentImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -31,6 +31,16 @@
public NAMESPACE_OSGEO_GEOMETRY::ICircularArcSegment, public NAMESPACE_OSGEO_GEOMETRY::IArcSegmentAbstractImp
{
public:
+ /// \brief
+ /// Constructs an ICircularArcSegmentImp managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
ICircularArcSegmentImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveAbstract.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveAbstract.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveAbstract.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -35,7 +35,7 @@
/// Gets the starting position of this Curve.
///
/// \remarks
- /// This is the start of the entire curve. In cases where a derived type
+ /// This is the start of the entire curve. In cases where a derived type
/// is composed of multiple contiguous parts, this position is the start of the
/// first of those parts.
///
@@ -48,7 +48,7 @@
/// Gets the ending position of this Curve.
///
/// \remarks
- /// This is the end of the entire curve. In cases where a derived type
+ /// This is the end of the entire curve. In cases where a derived type
/// is composed of multiple contiguous parts, this position is the end of the
/// last of those parts.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveAbstractImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveAbstractImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveAbstractImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -34,6 +34,16 @@
public NAMESPACE_OSGEO_GEOMETRY::ICurveAbstract, public NAMESPACE_OSGEO_GEOMETRY::IGeometryImp
{
public:
+ /// \brief
+ /// Constructs an ICurveAbstractImp managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
ICurveAbstractImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
@@ -44,7 +54,7 @@
/// Gets the starting position of this Curve.
///
/// \remarks
- /// This is the start of the entire curve. In cases where a derived type
+ /// This is the start of the entire curve. In cases where a derived type
/// is composed of multiple contiguous parts, this position is the start of the
/// first of those parts.
///
@@ -57,7 +67,7 @@
/// Gets the ending position of this Curve.
///
/// \remarks
- /// This is the end of the entire curve. In cases where a derived type
+ /// This is the end of the entire curve. In cases where a derived type
/// is composed of multiple contiguous parts, this position is the end of the
/// last of those parts.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurvePolygonImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurvePolygonImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurvePolygonImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -30,14 +30,23 @@
BEGIN_NAMESPACE_OSGEO_GEOMETRY
/// \brief
-/// The ICurvePolygonImp class is a CurvePolygon geometry type.
-/// This type is defined by one exterior boundary and zero or more
-/// interior boundaries.
+/// The ICurvePolygonImp class is a concrete geometric CurvePolygon geometry type.
+/// This type is defined by one exterior boundary and zero or more interior boundaries.
/// Each of the boundaries must be a closed, simple Ring.
private __gc class ICurvePolygonImp :
public NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon, public NAMESPACE_OSGEO_GEOMETRY::ISurfaceAbstractImp
{
public:
+ /// \brief
+ /// Constructs an ICurvePolygonImp managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
ICurvePolygonImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
@@ -73,38 +82,89 @@
};
/// \brief
-/// The CurvePolygonCollection class is a collection of CurvePolygon objects.
+/// The CurvePolygonCollection class is a collection of CurvePolygon objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __gc __sealed class CurvePolygonCollection
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
public:
+ /// \brief
+ /// Constructs a CurvePolygonCollection managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
CurvePolygonCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
FdoCurvePolygonCollection *GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
private:
+ /// \brief
+ /// nested class defined to provide Enumerator.
+ ///
__gc class Enumerator : public System::Collections::IEnumerator
{
CurvePolygonCollection *m_pCol;
System::Int32 m_nIdx;
+
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(CurvePolygonCollection *col)
: m_pCol(col), m_nIdx(-1)
{}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first object in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
System::Boolean MoveNext();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
System::Void Reset();
};
+/// \endcond
+
public:
/// \brief
- /// Creates an instance of CurveSegmentCollection with no contained elements.
+ /// Creates an instance of CurveSegmentCollection with no contained elements.
///
/// \return
/// Returns an empty collection
@@ -129,50 +189,53 @@
public:
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th ICurvePolygon from this collection.
+ /// Removes the index-th ICurvePolygon from this collection.
///
/// \param index
/// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
+
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
public:
/// \brief
- /// Adds a ICurvePolygon object into the collection.
+ /// Adds a ICurvePolygon object into the collection.
///
/// \param value
/// Input the ICurvePolygon object to add.
///
/// \return
- /// The position into which the new element was inserted.
+ /// The position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon* value);
+
/// \brief
- /// Determines the index of a specific ICurvePolygon object.
+ /// Determines the index of a specific ICurvePolygon object.
///
/// \param value
/// Input the ICurvePolygon object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon* value);
+
/// \brief
- /// Inserts an ICurvePolygon object to the collection at the specified position.
+ /// Inserts an ICurvePolygon object to the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -180,25 +243,28 @@
/// Input the ICurvePolygon object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon* value);
+
/// \brief
- /// Removes the first occurrence of a specific ICurvePolygon object.
+ /// Removes the first occurrence of a specific ICurvePolygon object.
///
/// \param value
/// Input the ICurvePolygon object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon* value);
+
/// \brief
- /// Determines whether the collection contains a specific ICurvePolygon object.
+ /// Determines whether the collection contains a specific ICurvePolygon object.
///
/// \param value
/// Input The ICurvePolygon object to locate in the collection.
///
/// \return
- /// True if the value is found in the collection; otherwise, false.
+ /// True if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon* value);
+
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -208,15 +274,44 @@
System::Void CopyTo(NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon* array[],System::Int32 startAt);
/// \brief
- /// Gets or sets an ICurvePolygon in the collection.
+ /// Gets an ICurvePolygon in the collection.
///
/// \param index
- /// Input index of the ICurvePolygon to retrieve or set (System::Int32).
+ /// Input index of the ICurvePolygon to retrieve.
///
__property NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon *get_RealTypeItem(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the ICurvePolygon at the specified index
+ ///
+ /// \param index
+ /// Input index of the ICurvePolygon to set.
+ ///
+ /// \param value
+ /// Input the value of the ICurvePolygon
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon *value);
+ /// \brief
+ /// Gets an ICurvePolygon in the collection.
+ ///
+ /// \param index
+ /// Input index of the ICurvePolygon to retrieve.
+ ///
+ /// \return
+ /// Returns the ICurvePolygon at the specified index
+ ///
__property NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon *get_Item(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the ICurvePolygon at the specified index
+ ///
+ /// \param index
+ /// Input index of the ICurvePolygon to set.
+ ///
+ /// \param value
+ /// Input the value of the ICurvePolygon
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ICurvePolygon *value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveSegmentAbstract.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveSegmentAbstract.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveSegmentAbstract.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -88,7 +88,7 @@
/// Gets the dimensionality of ordinates in this object.
///
/// \remarks
- /// Values are from the Dimensionality enumeration.
+ /// Values are from the Dimensionality enumeration.
/// A return type of "Int32" is used instead of the enumeration, catering to typical use with bit masking.
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveSegmentAbstractImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveSegmentAbstractImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveSegmentAbstractImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -36,10 +36,22 @@
: public NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract, public NAMESPACE_OSGEO_RUNTIME::Disposable
{
public:
+ /// \brief
+ /// Constructs an ICurveSegmentAbstractImp managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
ICurveSegmentAbstractImp(IntPtr unmanaged, Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public:
/// \brief
@@ -99,7 +111,7 @@
/// Gets the dimensionality of ordinates in this object.
///
/// \remarks
- /// Values are from the Dimensionality enumeration.
+ /// Values are from the Dimensionality enumeration.
/// A return type of "Int32" is used instead of the enumeration, catering to typical use with bit masking.
///
/// \return
@@ -116,32 +128,83 @@
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
public:
+ /// \brief
+ /// Constructs a CurveSegmentCollection managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
CurveSegmentCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
FdoCurveSegmentCollection *GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
private:
+ /// \brief
+ /// nested class defined to provide Enumerator.
+ ///
__gc class Enumerator : public System::Collections::IEnumerator
{
CurveSegmentCollection *m_pCol;
System::Int32 m_nIdx;
- public:
+
+ public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(CurveSegmentCollection *col)
: m_pCol(col), m_nIdx(-1)
{}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
- System::Boolean MoveNext();
- System::Void Reset();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
+/// \endcond
+
public:
/// \brief
- /// Creates an instance of CurveSegmentCollection with no contained elements.
+ /// Creates an instance of CurveSegmentCollection with no contained elements.
///
/// \return
/// Returns an empty collection
@@ -166,50 +229,52 @@
public:
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th ICurveSegmentAbstract from this collection.
+ /// Removes the index-th ICurveSegmentAbstract from this collection.
///
/// \param index
/// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
public:
/// \brief
- /// Adds a ICurveSegmentAbstract object into the collection.
+ /// Adds a ICurveSegmentAbstract object into the collection.
///
/// \param value
/// Input the ICurveSegmentAbstract object to add.
///
/// \return
- /// The position into which the new element was inserted.
+ /// The position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract* value);
+
/// \brief
- /// Determines the index of a specific ICurveSegmentAbstract object.
+ /// Determines the index of a specific ICurveSegmentAbstract object.
///
/// \param value
/// Input the ICurveSegmentAbstract object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract* value);
+
/// \brief
- /// Inserts an ICurveSegmentAbstract object to the collection at the specified position.
+ /// Inserts an ICurveSegmentAbstract object to the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -217,25 +282,28 @@
/// Input the ICurveSegmentAbstract object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract* value);
+
/// \brief
- /// Removes the first occurrence of a specific ICurveSegmentAbstract object.
+ /// Removes the first occurrence of a specific ICurveSegmentAbstract object.
///
/// \param value
/// Input the ICurveSegmentAbstract object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract* value);
+
/// \brief
- /// Determines whether the collection contains a specific ICurveSegmentAbstract object.
+ /// Determines whether the collection contains a specific ICurveSegmentAbstract object.
///
/// \param value
/// Input The ICurveSegmentAbstract object to locate in the collection.
///
/// \return
- /// True if the value is found in the collection; otherwise, false.
+ /// True if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract* value);
+
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -245,15 +313,44 @@
System::Void CopyTo(NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract* array[],System::Int32 startAt);
/// \brief
- /// Gets or sets an ICurveSegmentAbstract in the collection.
+ /// Gets an ICurveSegmentAbstract in the collection.
///
/// \param index
- /// Input index of the ICurveSegmentAbstract to retrieve or set (System::Int32).
+ /// Input index of the ICurveSegmentAbstract to retrieve
///
__property NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract *get_RealTypeItem(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the object at the specified index
+ ///
+ /// \param index
+ /// Input index of the object to set.
+ ///
+ /// \param value
+ /// Input the value of the object
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract *value);
+ /// \brief
+ /// Gets am object in the collection.
+ ///
+ /// \param index
+ /// Input index of the object to retrieve.
+ ///
+ /// \return
+ /// Returns the object at the specified index.
+ ///
__property NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract *get_Item(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the object at the specified index
+ ///
+ /// \param index
+ /// Input index of the object to set.
+ ///
+ /// \param value
+ /// Input the value of the object.
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstract *value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveStringImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveStringImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgICurveStringImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -31,12 +31,22 @@
BEGIN_NAMESPACE_OSGEO_GEOMETRY
/// \brief
-/// The ICurveStringImp class is a CurveString Geometry type. ICurveString is the most general non-abstract curve type.
+/// The ICurveStringImp class is a concrete geometric CurveString Geometry type. ICurveString is the most general non-abstract curve type.
/// It is defined by an ordered collection of contiguous curve segments.
private __gc class ICurveStringImp
: public NAMESPACE_OSGEO_GEOMETRY::ICurveAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::ICurveString
{
public:
+ /// \brief
+ /// Constructs an ICurveStringImp managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
ICurveStringImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
@@ -72,38 +82,89 @@
};
/// \brief
-/// The CurveStringCollection class is a collection of CurvePolygon objects.
+/// The CurveStringCollection class is a collection of CurvePolygon objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __gc __sealed class CurveStringCollection
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
public:
+ /// \brief
+ /// Constructs a CurveStringCollection managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
CurveStringCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
FdoCurveStringCollection *GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
private:
+ /// \brief
+ /// A Nested class defined to provide Enumerator.
+ ///
__gc class Enumerator : public System::Collections::IEnumerator
{
CurveStringCollection *m_pCol;
System::Int32 m_nIdx;
- public:
+
+ public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(CurveStringCollection *col)
: m_pCol(col), m_nIdx(-1)
{}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
- System::Boolean MoveNext();
- System::Void Reset();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
+/// \endcond
+
public:
/// \brief
- /// Creates an instance of CurveSegmentCollection with no contained elements.
+ /// Creates an instance of CurveSegmentCollection with no contained elements.
///
/// \return
/// Returns an empty collection
@@ -128,76 +189,82 @@
public:
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th ICurveString from this collection.
+ /// Removes the index-th ICurveString from this collection.
///
/// \param index
/// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
+
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
public:
/// \brief
- /// Adds a ICurveString object into the collection.
+ /// Adds a ICurveString object into the collection.
///
/// \param value
/// Input the ICurveString object to add.
///
/// \return
- /// The position into which the new element was inserted.
+ /// The position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_GEOMETRY::ICurveString* value);
+
/// \brief
- /// Determines the index of a specific ICurveString object.
+ /// Determines the index of a specific ICurveString object.
///
/// \param value
/// Input the ICurveString object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_GEOMETRY::ICurveString* value);
+
/// \brief
- /// Inserts an ICurveString object to the collection at the specified position.
+ /// Inserts an ICurveString object to the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
/// \param value
/// Input the ICurveString object to insert.
///
- System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ICurveString* value);
+ System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ICurveString* value);
+
/// \brief
- /// Removes the first occurrence of a specific ICurveString object.
+ /// Removes the first occurrence of a specific ICurveString object.
///
/// \param value
/// Input the ICurveString object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_GEOMETRY::ICurveString* value);
+
/// \brief
- /// Determines whether the collection contains a specific ICurveString object.
+ /// Determines whether the collection contains a specific ICurveString object.
///
/// \param value
/// Input The ICurveString object to locate in the collection.
///
/// \return
- /// True if the value is found in the collection; otherwise, false.
+ /// True if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_GEOMETRY::ICurveString* value);
+
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -207,16 +274,44 @@
System::Void CopyTo(NAMESPACE_OSGEO_GEOMETRY::ICurveString* array[],System::Int32 startAt);
/// \brief
- /// Gets or sets an ICurveString in the collection.
+ /// Gets an ICurveString in the collection.
///
/// \param index
- /// Input index of the ICurveString to retrieve or set (System::Int32).
+ /// Input index of the ICurveString to retrieve.
///
-
__property NAMESPACE_OSGEO_GEOMETRY::ICurveString *get_RealTypeItem(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the ICurveString at the specified index
+ ///
+ /// \param index
+ /// Input index of the ICurveString to set.
+ ///
+ /// \param value
+ /// Input the value of the ICurveString
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ICurveString *value);
+ /// \brief
+ /// Gets an ICurveString in the collection.
+ ///
+ /// \param index
+ /// Input index of the ICurveString to retrieve.
+ ///
+ /// \return
+ /// Returns the ICurveString at the specified index
+ ///
__property NAMESPACE_OSGEO_GEOMETRY::ICurveString *get_Item(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the ICurveString at the specified index
+ ///
+ /// \param index
+ /// Input index of the ICurveString to set.
+ ///
+ /// \param value
+ /// Input the value of the ICurveString
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ICurveString *value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPosition.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPosition.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPosition.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -68,7 +68,7 @@
/// Gets the dimensionality of ordinates in this position.
///
/// \remarks
- /// Values are from the Dimensionality enumeration.
+ /// Values are from the Dimensionality enumeration.
/// A return type of "Int32" is used instead of the enumeration, catering to typical use with bit masking.
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPositionImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPositionImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIDirectPositionImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -27,20 +27,32 @@
BEGIN_NAMESPACE_OSGEO_GEOMETRY
/// \brief
-/// The IDirectPosition class is a direct position object.
+/// The IDirectPositionImp class is a default implementation of the IDirectPosition object.
/// IDirectPosition is a simple coordinate position in any allowed dimension.
-/// The actual object may have several implementations, depending on
-/// the dimension and other factors.
+/// The actual object may have several implementations, depending on the dimension and other factors.
/// This is a lightweight helper type for Geometries in the Geometry package.
/// Note: It does not derive from IGeometry.
private __gc class IDirectPositionImp
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_GEOMETRY::IDirectPosition
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IDirectPositionImp(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
+
public:
/// \brief
@@ -79,7 +91,7 @@
/// Gets the dimensionality of ordinates in this position.
///
/// \remarks
- /// Values are from the Dimensionality enumeration.
+ /// Values are from the Dimensionality enumeration.
/// A return type of "Int32" is used instead of the enumeration, catering to typical use with bit masking.
///
/// \return
@@ -92,38 +104,87 @@
};
/// \brief
-/// The DirectPositionCollection class is a collection of DirectPosition objects.
+/// The DirectPositionCollection class is a collection of DirectPosition objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __gc __sealed class DirectPositionCollection
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
public:
+ /// \brief
+ /// Constructs a DirectPositionCollection managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
DirectPositionCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
FdoDirectPositionCollection *GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
private:
+ /// \brief
+ /// A Nested class defined to provide Enumerator.
+ ///
__gc class Enumerator : public System::Collections::IEnumerator
{
DirectPositionCollection *m_pCol;
System::Int32 m_nIdx;
- public:
+
+ public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(DirectPositionCollection *col)
: m_pCol(col), m_nIdx(-1)
{}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
- System::Boolean MoveNext();
- System::Void Reset();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
public:
/// \brief
- /// Creates an instance of DirectPositionCollection with no contained elements.
+ /// Creates an instance of DirectPositionCollection with no contained elements.
///
/// \return
/// Returns an empty collection
@@ -148,17 +209,17 @@
public:
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th IDirectPosition from this collection.
+ /// Removes the index-th IDirectPosition from this collection.
///
/// \param index
/// Input index of the element to remove.
@@ -166,45 +227,46 @@
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
public:
/// \brief
- /// Adds a IDirectPosition object into the collection.
+ /// Adds a IDirectPosition object into the collection.
///
/// \param value
/// Input the IDirectPosition object to add.
///
/// \return
- /// The position into which the new element was inserted.
+ /// The position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* value);
/// \brief
- /// Determines the index of a specific IDirectPosition object.
+ /// Determines the index of a specific IDirectPosition object.
///
/// \param value
/// Input the IDirectPosition object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* value);
/// \brief
- /// Inserts an IDirectPosition object to the collection at the specified position.
+ /// Inserts an IDirectPosition object to the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
+ ///
/// \param value
/// Input the IDirectPosition object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* value);
/// \brief
- /// Removes the first occurrence of a specific IDirectPosition object.
+ /// Removes the first occurrence of a specific IDirectPosition object.
///
/// \param value
/// Input the IDirectPosition object to remove from the collection.
@@ -212,36 +274,66 @@
System::Void Remove(NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* value);
/// \brief
- /// Determines whether the collection contains a specific IDirectPosition object.
+ /// Determines whether the collection contains a specific IDirectPosition object.
///
/// \param value
/// Input The IDirectPosition object to locate in the collection.
///
/// \return
- /// True if the value is found in the collection; otherwise, false.
+ /// True if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
+ ///
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
System::Void CopyTo(NAMESPACE_OSGEO_GEOMETRY::IDirectPosition* array[],System::Int32 startAt);
/// \brief
- /// Gets or sets an IDirectPosition in the collection.
+ /// Gets an IDirectPosition in the collection.
///
/// \param index
- /// Input index of the IDirectPosition to retrieve or set (System::Int32).
+ /// Input index of the IDirectPosition to retrieve.
///
__property NAMESPACE_OSGEO_GEOMETRY::IDirectPosition *get_RealTypeItem(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the IDirectPosition at the specified index
+ ///
+ /// \param index
+ /// Input index of the IDirectPosition to set.
+ ///
+ /// \param value
+ /// Input the value of the IDirectPosition
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::IDirectPosition *value);
+ /// \brief
+ /// Gets an IDirectPosition in the collection.
+ ///
+ /// \param index
+ /// Input index of the IDirectPosition to retrieve.
+ ///
+ /// \return
+ /// Returns the IDirectPosition at the specified index
+ ///
__property NAMESPACE_OSGEO_GEOMETRY::IDirectPosition *get_Item(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the IDirectPosition at the specified index
+ ///
+ /// \param index
+ /// Input index of the IDirectPosition to set.
+ ///
+ /// \param value
+ /// Input the value of the IDirectPosition
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::IDirectPosition *value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelope.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelope.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelope.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -23,13 +23,11 @@
/// \brief
/// The IEnvelope class is a three-dimensional, axis-aligned box. This is a
-/// helper type for Geometries, and does not itself inherit from
-/// IGeometry.
+/// helper type for Geometries, and does not itself inherit from IGeometry.
/// This type is typically used to record the "extents" of a shape, also
/// known in 2 dimensions as an MBR ("Minimum Bounding Rectangle").
-/// The box may be initially empty, meaning that no dimensions have an
-/// assigned value.
-/// each individual extent may be unassigned, in which case using its
+/// The box may be initially empty, meaning that no dimensions have an assigned value.
+/// Each individual extent may be unassigned, in which case using its
/// accessor will return numeric_limits<double>::quiet_NaN().
public __gc __interface IEnvelope : public System::IDisposable
{
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelopeImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelopeImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIEnvelopeImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -37,10 +37,22 @@
public __gc class IEnvelopeImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_GEOMETRY::IEnvelope
{
public:
+ /// \brief
+ /// Constructs an IEnvelopeImp managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
IEnvelopeImp(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public:
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometricAggregateAbstractImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometricAggregateAbstractImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometricAggregateAbstractImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -26,7 +26,7 @@
BEGIN_NAMESPACE_OSGEO_GEOMETRY
/// \brief
-/// The IGeometricAggregateAbstract class is an aggregate Geometry (abstract) type.
+/// The IGeometricAggregateAbstractImp class is a default implementation of the aggregate Geometry type.
/// IGeometricAggregateAbstract is a single Geometry that is a collection of other geometries.
/// There is no requirement that the geometries interact spatially.
/// Non-abstract derived types should have at least one accessor that returns objects of the appropriate contained type.
@@ -34,6 +34,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IGeometryImp, public NAMESPACE_OSGEO_GEOMETRY::IGeometricAggregateAbstract
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IGeometricAggregateAbstractImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometry.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometry.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometry.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -43,7 +43,7 @@
/// Gets the dimensionality of ordinates in this object.
///
/// \remarks
- /// Values are from the Dimensionality enumeration.
+ /// Values are from the Dimensionality enumeration.
/// A return type of "Int32" is used instead of the enumeration, catering to typical use with bit masking.
///
/// \return
@@ -52,11 +52,10 @@
__property System::Int32 get_Dimensionality();
/// \brief
- /// Gets the type of the most-derived interface
- /// in the Geometry package for this object
+ /// Gets the type of the most-derived interface in the Geometry package for this object
///
/// \remarks
- /// The derived type indicates to what class the object may safely be cast.
+ /// The derived type indicates to what class the object may safely be cast.
///
/// \return
/// Returns the derived type
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometryImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometryImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIGeometryImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -31,16 +31,28 @@
BEGIN_NAMESPACE_OSGEO_GEOMETRY
/// \brief
-/// The IGeometryImp class defines the properties and methods common to all geometric
-/// types.
+/// The IGeometryImp class defines the properties and methods common to all geometric types.
+/// IGeometryImp is a concreate implementation of IGeometry.
public __gc class IGeometryImp
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_GEOMETRY::IGeometry
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IGeometryImp(System::IntPtr unmanaged, System::Boolean autoDelete);
+/// \cond DOXYGEN-IGNORE
protected:
System::Void ReleaseUnmanagedObject();
+/// \endcond
public:
/// \brief
@@ -55,7 +67,7 @@
/// Gets the dimensionality of ordinates in this object.
///
/// \remarks
- /// Values are from the Dimensionality enumeration.
+ /// Values are from the Dimensionality enumeration.
/// A return type of "Int32" is used instead of the enumeration, catering to typical use with bit masking.
///
/// \return
@@ -68,7 +80,7 @@
/// in the Geometry package for this object
///
/// \remarks
- /// The derived type indicates to what class the object may safely be cast.
+ /// The derived type indicates to what class the object may safely be cast.
///
/// \return
/// Returns the derived type
@@ -95,38 +107,89 @@
};
/// \brief
-/// Collection of CurvePolygon objects.
+/// The GeometryCollection class is a collection of Geometry objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __gc __sealed class GeometryCollection
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
public:
+ /// \brief
+ /// Constructs a GeometryCollection managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed object should be automatically deleted
+ /// once it no longer referenced.
+ ///
GeometryCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
FdoGeometryCollection *GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
private:
+ /// \brief
+ /// A Nested class defined to provide Enumerator.
+ ///
__gc class Enumerator : public System::Collections::IEnumerator
{
GeometryCollection *m_pCol;
System::Int32 m_nIdx;
+
public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(GeometryCollection *col)
: m_pCol(col), m_nIdx(-1)
{}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
System::Boolean MoveNext();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
System::Void Reset();
};
+/// \endcond
+
public:
/// \brief
- /// Creates an instance of FdoCurveSegmentCollection with no contained elements.
+ /// Creates an instance of GeometryCollection with no contained elements.
///
/// \return
/// Returns an empty collection
@@ -151,50 +214,53 @@
public:
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th IGeometry from this collection.
+ /// Removes the index-th IGeometry from this collection.
///
/// \param index
/// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
+
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
public:
/// \brief
- /// Adds a IGeometry object into the collection.
+ /// Adds a IGeometry object into the collection.
///
/// \param value
/// Input the IGeometry object to add.
///
/// \return
- /// The position into which the new element was inserted.
+ /// The position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_GEOMETRY::IGeometry* value);
+
/// \brief
- /// Determines the index of a specific IGeometry object.
+ /// Determines the index of a specific IGeometry object.
///
/// \param value
/// Input the IGeometry object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_GEOMETRY::IGeometry* value);
+
/// \brief
- /// Inserts an IGeometry object to the collection at the specified position.
+ /// Inserts an IGeometry object to the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -202,25 +268,28 @@
/// Input the IGeometry object to insert.
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::IGeometry* value);
+
/// \brief
- /// Removes the first occurrence of a specific IGeometry object.
+ /// Removes the first occurrence of a specific IGeometry object.
///
/// \param value
/// Input the IGeometry object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_GEOMETRY::IGeometry* value);
+
/// \brief
- /// Determines whether the collection contains a specific IGeometry object.
+ /// Determines whether the collection contains a specific IGeometry object.
///
/// \param value
/// Input The IGeometry object to locate in the collection.
///
/// \return
- /// True if the value is found in the collection; otherwise, false.
+ /// True if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_GEOMETRY::IGeometry* value);
+
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -230,15 +299,44 @@
System::Void CopyTo(NAMESPACE_OSGEO_GEOMETRY::IGeometry* array[],System::Int32 startAt);
/// \brief
- /// Gets or sets an IGeometry in the collection.
+ /// Gets an IGeometry object in the collection.
///
/// \param index
- /// Input index of the IGeometry to retrieve or set (System::Int32).
+ /// Input index of the IGeometry object to retrieve.
///
__property NAMESPACE_OSGEO_GEOMETRY::IGeometry *get_RealTypeItem(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the IGeometry object at the specified index
+ ///
+ /// \param index
+ /// Input index of the IGeometry object to set.
+ ///
+ /// \param value
+ /// Input the value of the IGeometry
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::IGeometry *value);
+ /// \brief
+ /// Gets an IGeometry object in the collection.
+ ///
+ /// \param index
+ /// Input index of the IGeometry object to retrieve.
+ ///
+ /// \return
+ /// Returns the IGeometry object at the specified index
+ ///
__property NAMESPACE_OSGEO_GEOMETRY::IGeometry *get_Item(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the IGeometry object at the specified index
+ ///
+ /// \param index
+ /// Input index of the IGeometry object to set.
+ ///
+ /// \param value
+ /// Input the value of the IGeometry object
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::IGeometry *value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineString.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineString.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineString.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -61,13 +61,13 @@
///
/// \param index
/// Input Zero-based index in the object's list of positions.
- /// \param x
+ /// \param coordinateX
/// Output X ordinate value.
- /// \param y
+ /// \param coordinateY
/// Output Y ordinate value.
- /// \param z
+ /// \param coordinateZ
/// Output Z ordinate value.
- /// \param m
+ /// \param coordinateM
/// Output M ordinate value.
/// \param dimensionality
/// Output Dimensionality of ordinates in this position.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -38,6 +38,16 @@
: public NAMESPACE_OSGEO_GEOMETRY::ICurveAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::ILineString
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
ILineStringImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
@@ -109,29 +119,80 @@
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
LineStringCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
FdoLineStringCollection *GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
private:
+ /// \brief
+ /// A Nested class defined to provide Enumerator.
+ ///
__gc class Enumerator : public System::Collections::IEnumerator
{
LineStringCollection *m_pCol;
System::Int32 m_nIdx;
- public:
+
+ public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(LineStringCollection *col)
: m_pCol(col), m_nIdx(-1)
{}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
- System::Boolean MoveNext();
- System::Void Reset();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
+/// \endcond
+
public:
/// \brief
/// Creates an instance of LineStringCollection with no contained elements.
@@ -159,30 +220,31 @@
public:
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th ILineString from this collection.
+ /// Removes the index-th ILineString from this collection.
///
/// \param index
/// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
+
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
public:
/// \brief
- /// Adds a ILineString object into the collection.
+ /// Adds a ILineString object into the collection.
///
/// \param value
/// Input the ILineString object to add.
@@ -193,7 +255,7 @@
System::Int32 Add(NAMESPACE_OSGEO_GEOMETRY::ILineString* value);
/// \brief
- /// Determines the index of a specific ILineString object.
+ /// Determines the index of a specific ILineString object.
///
/// \param value
/// Input the ILineString object to locate in the collection.
@@ -204,7 +266,7 @@
System::Int32 IndexOf(NAMESPACE_OSGEO_GEOMETRY::ILineString* value);
/// \brief
- /// Inserts an ILineString object to the collection at the specified position.
+ /// Inserts an ILineString object to the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -214,7 +276,7 @@
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ILineString* value);
/// \brief
- /// Removes the first occurrence of a specific ILineString object.
+ /// Removes the first occurrence of a specific ILineString object.
///
/// \param value
/// Input the ILineString object to remove from the collection.
@@ -222,7 +284,7 @@
System::Void Remove(NAMESPACE_OSGEO_GEOMETRY::ILineString* value);
/// \brief
- /// Determines whether the collection contains a specific ILineString object.
+ /// Determines whether the collection contains a specific ILineString object.
///
/// \param value
/// Input The ILineString object to locate in the collection.
@@ -233,7 +295,7 @@
System::Boolean Contains(NAMESPACE_OSGEO_GEOMETRY::ILineString* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -243,15 +305,44 @@
System::Void CopyTo(NAMESPACE_OSGEO_GEOMETRY::ILineString* array[],System::Int32 startAt);
/// \brief
- /// Gets or sets an ILineString in the collection.
+ /// Gets an ILineString object in the collection.
///
/// \param index
- /// Input index of the ILineString to retrieve or set (System::Int32).
+ /// Input index of the ILineString object to retrieve.
///
__property NAMESPACE_OSGEO_GEOMETRY::ILineString *get_RealTypeItem(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the ILineString object at the specified index
+ ///
+ /// \param index
+ /// Input index of the ILineString object to set.
+ ///
+ /// \param value
+ /// Input the value of the ILineString
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ILineString *value);
+ /// \brief
+ /// Gets an ILineString object in the collection.
+ ///
+ /// \param index
+ /// Input index of the ILineString object to retrieve.
+ ///
+ /// \return
+ /// Returns the ILineString object at the specified index
+ ///
__property NAMESPACE_OSGEO_GEOMETRY::ILineString *get_Item(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the ILineString object at the specified index
+ ///
+ /// \param index
+ /// Input index of the ILineString object to set.
+ ///
+ /// \param value
+ /// Input the value of the ILineString object
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ILineString *value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringSegment.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringSegment.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringSegment.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -48,6 +48,9 @@
/// \brief
/// Gets the position at the specified (zero-based) index.
///
+ /// \param index
+ /// Input Zero-based index in the object's list of positions.
+ ///
/// \return
/// Returns the position
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringSegmentImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringSegmentImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILineStringSegmentImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -39,6 +39,16 @@
: public NAMESPACE_OSGEO_GEOMETRY::ICurveSegmentAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::ILineStringSegment
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
ILineStringSegmentImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRing.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRing.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRing.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -62,13 +62,13 @@
///
/// \param index
/// Input Zero-based index in the object's list of positions.
- /// \param x
+ /// \param coordinateX
/// Output X ordinate value.
- /// \param y
+ /// \param coordinateY
/// Output Y ordinate value.
- /// \param z
+ /// \param coordinateZ
/// Output Z ordinate value.
- /// \param m
+ /// \param coordinateM
/// Output M ordinate value.
/// \param dimensionality
/// Output Dimensionality of ordinates in this position.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRingImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRingImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgILinearRingImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -38,6 +38,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IRingAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::ILinearRing
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
ILinearRingImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
@@ -103,38 +113,89 @@
};
/// \brief
-/// The LinearRingCollection class is a collection of ILinearRing objects.
+/// The LinearRingCollection class is a collection of ILinearRing objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __gc __sealed class LinearRingCollection
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
LinearRingCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
FdoLinearRingCollection *GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
private:
+ /// \brief
+ /// A Nested class defined to provide Enumerator.
+ ///
__gc class Enumerator : public System::Collections::IEnumerator
{
LinearRingCollection *m_pCol;
System::Int32 m_nIdx;
- public:
+
+ public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(LinearRingCollection *col)
: m_pCol(col), m_nIdx(-1)
{}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
- System::Boolean MoveNext();
- System::Void Reset();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
+/// \endcond
+
public:
/// \brief
- /// Creates an instance of LinearRingCollection with no contained elements.
+ /// Creates an instance of LinearRingCollection with no contained elements.
///
/// \return
/// Returns an empty collection
@@ -159,52 +220,53 @@
public:
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th ILinearRing from this collection.
+ /// Removes the index-th ILinearRing from this collection.
///
/// \param index
/// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
+
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
public:
/// \brief
- /// Adds a ILinearRing object into the collection.
+ /// Adds a ILinearRing object into the collection.
///
/// \param value
/// Input the ILinearRing object to add.
///
/// \return
- /// The position into which the new element was inserted.
+ /// The position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_GEOMETRY::ILinearRing* value);
/// \brief
- /// Determines the index of a specific ILinearRing object.
+ /// Determines the index of a specific ILinearRing object.
///
/// \param value
/// Input the ILinearRing object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_GEOMETRY::ILinearRing* value);
/// \brief
- /// Inserts an ILinearRing object to the collection at the specified position.
+ /// Inserts an ILinearRing object to the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -214,7 +276,7 @@
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ILinearRing* value);
/// \brief
- /// Removes the first occurrence of a specific ILinearRing object.
+ /// Removes the first occurrence of a specific ILinearRing object.
///
/// \param value
/// Input the ILinearRing object to remove from the collection.
@@ -222,18 +284,18 @@
System::Void Remove(NAMESPACE_OSGEO_GEOMETRY::ILinearRing* value);
/// \brief
- /// Determines whether the collection contains a specific ILinearRing object.
+ /// Determines whether the collection contains a specific ILinearRing object.
///
/// \param value
/// Input The ILinearRing object to locate in the collection.
///
/// \return
- /// True if the value is found in the collection; otherwise, false.
+ /// True if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_GEOMETRY::ILinearRing* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -243,15 +305,44 @@
System::Void CopyTo(NAMESPACE_OSGEO_GEOMETRY::ILinearRing* array[],System::Int32 startAt);
/// \brief
- /// Gets or sets an ILinearRing in the collection.
+ /// Gets an ILinearRing object in the collection.
///
/// \param index
- /// Input index of the ILinearRing to retrieve or set (System::Int32).
+ /// Input index of the ILinearRing object to retrieve.
///
__property NAMESPACE_OSGEO_GEOMETRY::ILinearRing *get_RealTypeItem(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the ILinearRing object at the specified index
+ ///
+ /// \param index
+ /// Input index of the ILinearRing object to set.
+ ///
+ /// \param value
+ /// Input the value of the ILinearRing
+ ///
__property System::Void set_RealTypeItem(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ILinearRing *value);
+ /// \brief
+ /// Gets an ILinearRing object in the collection.
+ ///
+ /// \param index
+ /// Input index of the ILinearRing object to retrieve.
+ ///
+ /// \return
+ /// Returns the ILinearRing object at the specified index
+ ///
__property NAMESPACE_OSGEO_GEOMETRY::ILinearRing *get_Item(System::Int32 index);
+
+ /// \brief
+ /// Sets the value of the ILinearRing object at the specified index
+ ///
+ /// \param index
+ /// Input index of the ILinearRing object to set.
+ ///
+ /// \param value
+ /// Input the value of the ILinearRing object
+ ///
__property System::Void set_Item(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::ILinearRing *value);
};
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiCurvePolygonImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiCurvePolygonImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiCurvePolygonImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -34,6 +34,16 @@
: public NAMESPACE_OSGEO_GEOMETRY::IGeometricAggregateAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::IMultiCurvePolygon
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IMultiCurvePolygonImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiCurveStringImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiCurveStringImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiCurveStringImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -36,6 +36,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IGeometricAggregateAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::IMultiCurveString
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IMultiCurveStringImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiGeometryImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiGeometryImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiGeometryImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -36,6 +36,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IGeometricAggregateAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::IMultiGeometry
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IMultiGeometryImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiLineStringImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiLineStringImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiLineStringImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -35,6 +35,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IGeometricAggregateAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::IMultiLineString
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IMultiLineStringImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiPointImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiPointImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiPointImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -33,6 +33,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IGeometricAggregateAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::IMultiPoint
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IMultiPointImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiPolygonImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiPolygonImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIMultiPolygonImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -33,6 +33,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IGeometricAggregateAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::IMultiPolygon
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IMultiPolygonImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPoint.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPoint.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPoint.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -45,13 +45,13 @@
/// does not internally use FdoIDirectPosition objects for storage, or for
/// an application seeking to avoid overhead of accessor methods.
///
- /// \param x
+ /// \param coordinateX
/// Output X ordinate value.
- /// \param y
+ /// \param coordinateY
/// Output Y ordinate value.
- /// \param z
+ /// \param coordinateZ
/// Output Z ordinate value.
- /// \param m
+ /// \param coordinateM
/// Output M ordinate value.
/// \param dimensionality
/// Output Dimensionality of ordinates in this position.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPointImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPointImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPointImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -34,6 +34,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IGeometryImp, public NAMESPACE_OSGEO_GEOMETRY::IPoint
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IPointImp(IntPtr unmanaged, Boolean autoDelete);
public private:
@@ -77,38 +87,89 @@
};
/// \brief
-/// The PointCollection class is a collection of Point objects.
+/// The PointCollection class is a collection of Point objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __gc __sealed class PointCollection
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
PointCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
FdoPointCollection *GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
private:
+ /// \brief
+ /// nested class defined to provide Enumerator.
+ ///
__gc class Enumerator : public System::Collections::IEnumerator
{
PointCollection *m_pCol;
System::Int32 m_nIdx;
- public:
+
+ public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(PointCollection *col)
: m_pCol(col), m_nIdx(-1)
{}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
- System::Boolean MoveNext();
- System::Void Reset();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
+/// \endcond
+
public:
/// \brief
- /// Creates an instance of PointCollection with no contained elements.
+ /// Creates an instance of PointCollection with no contained elements.
///
/// \return
/// Returns an empty collection
@@ -133,50 +194,50 @@
public:
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th IPoint from this collection.
+ /// Removes the index-th IPoint from this collection.
///
/// \param index
/// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
public:
/// \brief
- /// Adds a IPoint object into the collection.
+ /// Adds a IPoint object into the collection.
///
/// \param value
/// Input the IPoint object to add.
///
/// \return
- /// The position into which the new element was inserted.
+ /// The position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_GEOMETRY::IPoint* value);
/// \brief
- /// Determines the index of a specific IPoint object.
+ /// Determines the index of a specific IPoint object.
///
/// \param value
/// Input the IPoint object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_GEOMETRY::IPoint* value);
/// \brief
- /// Inserts an IPoint object to the collection at the specified position.
+ /// Inserts an IPoint object to the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -185,24 +246,24 @@
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::IPoint* value);
/// \brief
- /// Removes the first occurrence of a specific IPoint object.
+ /// Removes the first occurrence of a specific IPoint object.
///
/// \param value
/// Input the IPoint object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_GEOMETRY::IPoint* value);
/// \brief
- /// Determines whether the collection contains a specific IPoint object.
+ /// Determines whether the collection contains a specific IPoint object.
///
/// \param value
/// Input The IPoint object to locate in the collection.
///
/// \return
- /// True if the value is found in the collection; otherwise, false.
+ /// True if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_GEOMETRY::IPoint* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -212,7 +273,7 @@
System::Void CopyTo(NAMESPACE_OSGEO_GEOMETRY::IPoint* array[],System::Int32 startAt);
/// \brief
- /// Gets or sets an IPoint in the collection.
+ /// Gets or sets an IPoint in the collection.
///
/// \param index
/// Input index of the IPoint to retrieve or set (System::Int32).
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPolygonImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPolygonImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIPolygonImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -37,6 +37,16 @@
public NAMESPACE_OSGEO_GEOMETRY::ISurfaceAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::IPolygon
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IPolygonImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
@@ -73,38 +83,89 @@
};
/// \brief
-/// The PolygonCollection class is a collection of Polygon objects.
+/// The PolygonCollection class is a collection of Polygon objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __gc __sealed class PolygonCollection
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
PolygonCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
FdoPolygonCollection *GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
private:
+ /// \brief
+ /// nested class defined to provide Enumerator.
+ ///
__gc class Enumerator : public System::Collections::IEnumerator
{
PolygonCollection *m_pCol;
System::Int32 m_nIdx;
- public:
+
+ public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(PolygonCollection *col)
: m_pCol(col), m_nIdx(-1)
{}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
- System::Boolean MoveNext();
- System::Void Reset();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
+/// \endcond
+
public:
/// \brief
- /// Creates an instance of PolygonCollection with no contained elements.
+ /// Creates an instance of PolygonCollection with no contained elements.
///
/// \return
/// Returns an empty collection
@@ -129,50 +190,50 @@
public:
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th IPolygon from this collection.
+ /// Removes the index-th IPolygon from this collection.
///
/// \param index
/// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
public:
/// \brief
- /// Adds a IPolygon object into the collection.
+ /// Adds a IPolygon object into the collection.
///
/// \param value
/// Input the IPolygon object to add.
///
/// \return
- /// The position into which the new element was inserted.
+ /// The position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_GEOMETRY::IPolygon* value);
/// \brief
- /// Determines the index of a specific IPolygon object.
+ /// Determines the index of a specific IPolygon object.
///
/// \param value
/// Input the IPolygon object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_GEOMETRY::IPolygon* value);
/// \brief
- /// Inserts an IPolygon object to the collection at the specified position.
+ /// Inserts an IPolygon object to the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -181,24 +242,24 @@
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::IPolygon* value);
/// \brief
- /// Removes the first occurrence of a specific IPolygon object.
+ /// Removes the first occurrence of a specific IPolygon object.
///
/// \param value
/// Input the IPolygon object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_GEOMETRY::IPolygon* value);
/// \brief
- /// Determines whether the collection contains a specific IPolygon object.
+ /// Determines whether the collection contains a specific IPolygon object.
///
/// \param value
/// Input The IPolygon object to locate in the collection.
///
/// \return
- /// True if the value is found in the collection; otherwise, false.
+ /// True if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_GEOMETRY::IPolygon* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -208,7 +269,7 @@
System::Void CopyTo(NAMESPACE_OSGEO_GEOMETRY::IPolygon* array[],System::Int32 startAt);
/// \brief
- /// Gets or sets an IPolygon in the collection.
+ /// Gets or sets an IPolygon in the collection.
///
/// \param index
/// Input index of the IPolygon to retrieve or set (System::Int32).
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingAbstract.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingAbstract.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingAbstract.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -45,7 +45,7 @@
/// Gets the dimensionality of ordinates in this object.
///
/// \remarks
- /// Values are from the Dimensionality enum.
+ /// Values are from the Dimensionality enum.
/// A return type of "Int32" is used instead of the enum, catering to typical use with bit masking.
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingAbstractImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingAbstractImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingAbstractImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -35,6 +35,16 @@
public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_GEOMETRY::IRingAbstract
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IRingAbstractImp(System::IntPtr unmanaged, System::Boolean autoDelete);
protected:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgIRingImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -37,6 +37,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IRingAbstractImp, public NAMESPACE_OSGEO_GEOMETRY::IRing
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
IRingImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
@@ -72,38 +82,89 @@
};
/// \brief
-/// The RingCollection class is a collection of Ring objects.
+/// The RingCollection class is a collection of Ring objects.
[System::Reflection::DefaultMemberAttribute("RealTypeItem")]
public __gc __sealed class RingCollection
: public NAMESPACE_OSGEO_RUNTIME::Disposable, public System::Collections::IList
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
RingCollection(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
FdoRingCollection *GetImpObj();
+/// \cond DOXYGEN-IGNORE
protected:
__sealed System::Void ReleaseUnmanagedObject();
private:
+ /// \brief
+ /// nested class defined to provide Enumerator.
+ ///
__gc class Enumerator : public System::Collections::IEnumerator
{
RingCollection *m_pCol;
System::Int32 m_nIdx;
- public:
+
+ public:
+ /// \brief
+ /// Constructs a new Collection Enumerator
+ ///
+ /// \param col
+ /// Input The collection to enumerate.
+ ///
Enumerator(RingCollection *col)
: m_pCol(col), m_nIdx(-1)
{}
+ /// \brief
+ /// Retrieves the current object at the enumerator location
+ ///
+ /// \return
+ /// Retuns the current object referenced by the enumerator
+ ///
__property System::Object *get_Current();
- System::Boolean MoveNext();
- System::Void Reset();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// At this position, calling the Current property throws an exception.
+ /// Therefore, you must call the MoveNext method to advance the enumerator
+ /// to the first element of the collection before reading the value of Current.
+ /// If MoveNext passes the end of the collection, the enumerator is positioned
+ /// after the last element in the collection and MoveNext returns false.
+ /// When the enumerator is at this position, subsequent calls to MoveNext also return false.
+ /// If the last call to MoveNext returned false, calling Current throws an exception.
+ /// To set Current to the first element of the collection again, you can call Reset
+ /// followed by MoveNext.
+ ///
+ /// \return
+ /// Retuns true if the Enumerator is able to move to a valid element
+ /// otherwise false.
+ ///
+ System::Boolean MoveNext();
+
+ /// \brief
+ /// Initially, the enumerator is positioned before the first element in the collection.
+ /// The Reset method brings the enumerator back to this position.
+ ///
+ System::Void Reset();
};
+/// \endcond
+
public:
/// \brief
- /// Creates an instance of RingCollection with no contained elements.
+ /// Creates an instance of RingCollection with no contained elements.
///
/// \return
/// Returns an empty collection
@@ -128,50 +189,50 @@
public:
/// \brief
- /// Gets the count of items in collection.
+ /// Gets the count of items in collection.
///
__property System::Int32 get_Count(System::Void);
/// \brief
- /// Gets an enumerator that can iterate through a collection.
+ /// Gets an enumerator that can iterate through a collection.
///
__sealed System::Collections::IEnumerator* GetEnumerator(System::Void);
/// \brief
- /// Removes the index-th IRing from this collection.
+ /// Removes the index-th IRing from this collection.
///
/// \param index
/// Input index of the element to remove.
///
System::Void RemoveAt(System::Int32 index);
/// \brief
- /// Removes all elements from the collection.
+ /// Removes all elements from the collection.
///
System::Void Clear();
public:
/// \brief
- /// Adds a IRing object into the collection.
+ /// Adds a IRing object into the collection.
///
/// \param value
/// Input the IRing object to add.
///
/// \return
- /// The position into which the new element was inserted.
+ /// The position into which the new element was inserted.
///
System::Int32 Add(NAMESPACE_OSGEO_GEOMETRY::IRing* value);
/// \brief
- /// Determines the index of a specific IRing object.
+ /// Determines the index of a specific IRing object.
///
/// \param value
/// Input the IRing object to locate in the collection.
///
/// \return
- /// The index of value if found in the collection; otherwise, -1.
+ /// The index of value if found in the collection; otherwise, -1.
///
System::Int32 IndexOf(NAMESPACE_OSGEO_GEOMETRY::IRing* value);
/// \brief
- /// Inserts an IRing object to the collection at the specified position.
+ /// Inserts an IRing object to the collection at the specified position.
///
/// \param index
/// Input the zero-based index at which value should be inserted.
@@ -180,24 +241,24 @@
///
System::Void Insert(System::Int32 index, NAMESPACE_OSGEO_GEOMETRY::IRing* value);
/// \brief
- /// Removes the first occurrence of a specific IRing object.
+ /// Removes the first occurrence of a specific IRing object.
///
/// \param value
/// Input the IRing object to remove from the collection.
///
System::Void Remove(NAMESPACE_OSGEO_GEOMETRY::IRing* value);
/// \brief
- /// Determines whether the collection contains a specific IRing object.
+ /// Determines whether the collection contains a specific IRing object.
///
/// \param value
/// Input The IRing object to locate in the collection.
///
/// \return
- /// True if the value is found in the collection; otherwise, false.
+ /// True if the value is found in the collection; otherwise, false.
///
System::Boolean Contains(NAMESPACE_OSGEO_GEOMETRY::IRing* value);
/// \brief
- /// Copies the elements of the collection to an array.
+ /// Copies the elements of the collection to an array.
///
/// \param array
/// Output the one-dimensional Array that is the destination of the elements copied from this collection.
@@ -207,7 +268,7 @@
System::Void CopyTo(NAMESPACE_OSGEO_GEOMETRY::IRing* array[],System::Int32 startAt);
/// \brief
- /// Gets or sets an IRing in the collection.
+ /// Gets or sets an IRing in the collection.
///
/// \param index
/// Input index of the IRing to retrieve or set (System::Int32).
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgISurfaceAbstractImp.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgISurfaceAbstractImp.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/mgISurfaceAbstractImp.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -31,6 +31,16 @@
public NAMESPACE_OSGEO_GEOMETRY::IGeometryImp, public NAMESPACE_OSGEO_GEOMETRY::ISurfaceAbstract
{
public:
+ /// \brief
+ /// Constructs a managed object based on an unmanaged instance of the object
+ ///
+ /// \param unmanaged
+ /// Input A Pointer to the unmanaged object.
+ ///
+ /// \param autoDelete
+ /// Input Indicates if the constructed element should be automatically deleted
+ /// once it no longer referenced.
+ ///
ISurfaceAbstractImp(System::IntPtr unmanaged, System::Boolean autoDelete);
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/stdafx.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/stdafx.h 2007-02-01 01:24:30 UTC (rev 697)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/Geometry/stdafx.h 2007-02-01 01:48:47 UTC (rev 698)
@@ -18,6 +18,8 @@
#pragma once
+/// \cond DOXYGEN-IGNORE
+
#define _CRT_SECURE_NO_DEPRECATE
#include <vcclr.h>
@@ -39,4 +41,5 @@
#define NULL 0
#endif
+/// \endcond
More information about the fdo-commits
mailing list