File Geodatabase API
FileGDBAPI::MultiPointShapeBuffer Class Reference

MultiPoint Shape Buffer accessor functions. More...

Inherits FileGDBAPI::ShapeBuffer.

List of all members.

Public Member Functions

fgdbError GetExtent (double *&extent)
 Get a pointer to the geomtries extent.
fgdbError GetNumPoints (int &numPoints)
 Get the number of coordinates in the geometry.
fgdbError GetPoints (Point *&points)
 Get a pointer to the point array.
fgdbError GetZExtent (double *&zExtent)
 Get a pointer to the z extent.
fgdbError GetZs (double *&zArray)
 Get a pointer to the z array.
fgdbError GetMExtent (double *&mExtent)
 Get a pointer to the m extent.
fgdbError GetMs (double *&mArray)
 Get a pointer to the m array.
fgdbError GetIDs (int *&ids)
 Get a pointer to the id array.
fgdbError Setup (ShapeType shapeType, int numPoints)
 Setup a shape buffer for insert.
fgdbError CalculateExtent (void)
 Calculates the extent for the shape after all of the coordinate arrays have been filled.

Detailed Description

MultiPoint Shape Buffer accessor functions.

These functions provide access to the shape buffer. Consult the extended shapefile format document for the buffer layout. When reading a multipoint shape buffer you should first create the appropriate shape buffer, get the geometry, get the number of points, get a pointer to the part array, get a pointer to the point array, and, if present, pointers to the z, m, and id arrays. To write a multipoint shape buffer create a row buffer, create a shape buffer, set up the shape buffer, get the points, assign the coordinates to the point array, and if needed get the z, m, id and curve arrays and populate, calculate the extent of the geometry, set the geometry and insert the row. To improve load use Table::LoadOnlyMode. Set it to true before you insert any rows and set it too false when finished. If all grid size values in the spatial index are zero, the values will be calculated based on the existing geometries.


Member Function Documentation

fgdbError FileGDBAPI::MultiPointShapeBuffer::GetExtent ( double *&  extent)

Get a pointer to the geomtries extent.

Parameters:
[out]extentA pointer to the geometries extent.
Returns:
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::MultiPointShapeBuffer::GetNumPoints ( int &  numPoints)

Get the number of coordinates in the geometry.

Parameters:
[out]numPointsThe number of points.
Returns:
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::MultiPointShapeBuffer::GetPoints ( Point *&  points)

Get a pointer to the point array.

Parameters:
[out]pointsA pointer to the coordinate array.
Returns:
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::MultiPointShapeBuffer::GetZExtent ( double *&  zExtent)

Get a pointer to the z extent.

Parameters:
[out]zExtentA pointer to the z extent.
Returns:
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::MultiPointShapeBuffer::GetZs ( double *&  zArray)

Get a pointer to the z array.

Parameters:
[out]zArrayA pointer to the z array.
Returns:
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::MultiPointShapeBuffer::GetMExtent ( double *&  mExtent)

Get a pointer to the m extent.

Parameters:
[out]mExtentA pointer to the m extent.
Returns:
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::MultiPointShapeBuffer::GetMs ( double *&  mArray)

Get a pointer to the m array.

Parameters:
[out]mArrayA pointer to the m array.
Returns:
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::MultiPointShapeBuffer::GetIDs ( int *&  ids)

Get a pointer to the id array.

Parameters:
[out]idsA pointer to the id array.
Returns:
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::MultiPointShapeBuffer::Setup ( ShapeType  shapeType,
int  numPoints 
)

Setup a shape buffer for insert.

Allocates the correct length buffer for the selected shape type.

Parameters:
[in]shapeTypeThe shape type of the buffer. Shape Type
[in]numPointsThe number of points to be loaded.
Returns:
Error code indicating whether the method finished successfully.
fgdbError FileGDBAPI::MultiPointShapeBuffer::CalculateExtent ( void  )

Calculates the extent for the shape after all of the coordinate arrays have been filled.

Returns:
Error code indicating whether the method finished successfully.