Changes between Version 2 and Version 3 of FDORfc63


Ignore:
Timestamp:
05/17/12 12:29:47 (13 years ago)
Author:
danstoica
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • FDORfc63

    v2 v3  
    7474    /// \param mode
    7575    /// Input Type of the spatial index
    76         ///
    77         /// \return
     76    ///
     77    /// \return
    7878    /// Returns A spatial index instance
    7979    ///
    8080    FDO_SPATIAL_API static FdoSpatialIndex* Create(FdoSpatialIndexMode mode = FdoSpatialIndex_ByGeometriesBoundingBox);
    8181
    82         /// \brief
    83         /// Retrieves the Spatial index mode set at creation time
    84         ///
    85         /// \return
     82    /// \brief
     83    /// Retrieves the Spatial index mode set at creation time
     84    ///
     85    /// \return
    8686    /// Returns the Spatial index mode set at creation
    8787    ///
    8888    FDO_SPATIAL_API FdoSpatialIndexMode GetMode();
    8989
    90         /// \brief
    91         /// Inserts a feature into the spatial index given a bounding box
    92         ///
    93         /// \remarks
     90    /// \brief
     91    /// Inserts a feature into the spatial index given a bounding box
     92    ///
     93    /// \remarks
    9494    /// Applies only for Mode #1. The Featid is not encoded.
    9595    ///
    96         /// \param featId
     96    /// \param featId
    9797    /// Input The feature identifier
    98         /// \param featId
     98    /// \param featId
    9999    /// Input A bounding box
    100         ///
    101         /// \return
     100    ///
     101    /// \return
    102102    /// Returns Nothing
    103103    ///
    104104    FDO_SPATIAL_API void InsertObject(FdoInt64 featId, FdoIEnvelope *ext);
    105105
    106         /// \brief
    107         /// Inserts a feature into the spatial index given a bounding box
    108         ///
    109         /// \remarks
    110         /// Applies for Mode #2 and #3. The Featid is encoded as follows:
    111         /// Mode #2:
     106    /// \brief
     107    /// Inserts a feature into the spatial index given a bounding box
     108    ///
     109    /// \remarks
     110    /// Applies for Mode #2 and #3. The Featid is encoded as follows:
     111    /// Mode #2:
    112112    ///      32 bits (0-31)  - 1-based featId #
    113113    ///      32 bits (32-63) - vertex # (contiguous)
    114114    ///
    115         /// Mode #3:
    116         ///              0 bits          - featId # (will be ignored)
     115    /// Mode #3:
     116    ///          0 bits          - featId # (will be ignored)
    117117    ///      16 bits (0-15)  - part # (for multi-features) max. 65534
    118118    ///      16 bits (16-31) - subpart # (e.g. polygons with interior rings) max 65534
    119119    ///      32 bits (32-63) - vertex #
    120     ///
    121         /// \param featId
     120    /// 
     121    /// \param featId
    122122    /// Input The feature identifier
    123         /// \param featId
     123    /// \param featId
    124124    /// Input A geometry in FGF format
    125         ///
    126         /// \return
     125    ///
     126    /// \return
    127127    /// Returns Nothing
    128128    ///
    129129    FDO_SPATIAL_API void InsertObject(FdoInt32 featId, FdoByteArray* fgfArray);
    130130
    131         /// \brief
    132         /// Returns the extent of the spatial index
    133         ///
    134         /// \return
     131    /// \brief
     132    /// Returns the extent of the spatial index
     133    ///
     134    /// \return
    135135    /// Returns The extents of the spatial index
    136136    ///
    137137    FDO_SPATIAL_API FdoIEnvelope* GetTotalExtent();
    138138
    139         /// \brief
    140         /// Decodes a marker returned by the Spatial index iterator.
    141         /// Applies only for Mode #2, BySegmentsMultipleFeatures.
    142         ///
    143         /// \param marker
     139    /// \brief
     140    /// Decodes a marker returned by the Spatial index iterator.
     141    /// Applies only for Mode #2, BySegmentsMultipleFeatures.
     142    ///
     143    /// \param marker
    144144    /// Input A marker returned by the Spatial index iterator
    145         /// \param featId
     145    /// \param featId
    146146    /// Output The featId
    147         /// \param iVertex
     147    /// \param iVertex
    148148    /// Output The index of the segment in the original geometry, 1-based
    149         ///
    150         /// \return
     149    ///
     150    /// \return
    151151    /// Returns Nothing
    152152    ///
    153153    FDO_SPATIAL_API void     DecodeMarker(FdoInt64 marker, FdoInt32 &featId, FdoInt32 &iSegment);
    154154
    155         /// \brief
    156         /// Decodes a marker returned by the Spatial index iterator.
    157         /// Applies only for Mode #3, BySegmentsSingleFeature.
    158         ///
    159         /// \param marker
     155    /// \brief
     156    /// Decodes a marker returned by the Spatial index iterator.
     157    /// Applies only for Mode #3, BySegmentsSingleFeature.
     158    ///
     159    /// \param marker
    160160    /// Input A marker returned by the Spatial index iterator
    161         /// \param iPart
    162         /// Output The index of the part in a multi-geometry, e.g. a polygon # in a multi-polygon
    163         /// \param iSubPart
    164         /// Output The index of the subpart in a geometry, e.g. a ring # in a polygon
    165         /// \param iVertex
     161    /// \param iPart
     162    /// Output The index of the part in a multi-geometry, e.g. a polygon # in a multi-polygon
     163    /// \param iSubPart
     164    /// Output The index of the subpart in a geometry, e.g. a ring # in a polygon
     165    /// \param iVertex
    166166    /// Output The index of the segment in the sub-part, 1-based
    167         ///
    168         /// \return
     167    ///
     168    /// \return
    169169    /// Returns Nothing
    170170    ///
    … …  
    176176   
    177177protected:
     178    // Constructor
    178179    FdoSpatialIndex(FdoSpatialIndexMode mode = FdoSpatialIndex_ByGeometriesBoundingBox);
    179180
    … …  
    186187{
    187188public:
    188         /// \brief
    189         /// Creates a Spatial Index Iterator instance
    190         ///
     189    /// \brief
     190    /// Creates a Spatial Index Iterator instance
     191    ///
    191192    /// \param si
    192193    /// Input A Spatial Index instance
    193         /// \param minx
    194         /// Input The minimim X of the bounding box representing the search area
    195         /// \param miny
    196         /// Input The minimim Y of the bounding box representing the search area
    197         /// \param maxx
    198         /// Input The maximum X of the bounding box representing the search area
    199         /// \param maxy
    200         /// Input The maximum Y of the bounding box representing the search area
    201         ///
    202         /// \return
     194    /// \param minx
     195    /// Input The minimim X of the bounding box representing the search area
     196    /// \param miny
     197    /// Input The minimim Y of the bounding box representing the search area
     198    /// \param maxx
     199    /// Input The maximum X of the bounding box representing the search area
     200    /// \param maxy
     201    /// Input The maximum Y of the bounding box representing the search area
     202    ///
     203    /// \return
    203204    /// Returns A Spatial Index Iterator instance
    204205    ///