Point Shape Buffer accessor functions. More...
Inherits FileGDBAPI::ShapeBuffer.
Public Member Functions | |
| fgdbError | GetPoint (Point *&point) const |
| Get a pointer to the points coordinates. More... | |
| fgdbError | GetZ (double *&z) const |
| Get a pointer to the points z coordinate. More... | |
| fgdbError | GetM (double *&m) const |
| Get a pointer to the points measure. More... | |
| fgdbError | GetID (int *&id) const |
| Get a pointer to the points ID value. More... | |
| fgdbError | Setup (ShapeType shapeType) |
| Setup a shape buffer for insert. More... | |
 Public Member Functions inherited from FileGDBAPI::ShapeBuffer | |
| bool | Allocate (size_t length) |
| Allocates a byte array of the specified size. More... | |
| bool | IsEmpty (void) const |
| Is the ShapeBuffer empty. More... | |
| void | SetEmpty (void) |
| Set the ShapeBuffer empty. | |
| fgdbError | GetShapeType (ShapeType &shapeType) const |
| Gets the shape type from the shape buffer. More... | |
| fgdbError | GetGeometryType (GeometryType &geometryType) const |
| Gets the geometry type which corresponds to the shape type in the shape buffer. More... | |
| ShapeBuffer (size_t length=0) | |
| The class constructor. | |
| virtual | ~ShapeBuffer () |
| The class destructor. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from FileGDBAPI::ShapeBuffer | |
| static bool | HasZs (ShapeType shapeType) |
| Does the shape buffer contain Z values. More... | |
| static bool | HasMs (ShapeType shapeType) |
| Does the shape buffer contain Ms. More... | |
| static bool | HasIDs (ShapeType shapeType) |
| Does the shape buffer contain IDs. More... | |
| static bool | HasCurves (ShapeType shapeType) |
| Does the shape buffer contain Curves. More... | |
| static bool | HasNormals (ShapeType shapeType) |
| Does the shape buffer includes Normals. More... | |
| static bool | HasTextures (ShapeType shapeType) |
| Does the shape buffer include Textures. More... | |
| static bool | HasMaterials (ShapeType shapeType) |
| Does the shape buffer include Materials. More... | |
| static GeometryType | GetGeometryType (ShapeType shapeType) |
| Gets the geometry type from a shape type. More... | |
| Public Attributes inherited from FileGDBAPI::ShapeBuffer | |
| byte * | shapeBuffer |
| The underlying byte array. | |
| size_t | allocatedLength |
| The capacity of the byte array. | |
| size_t | inUseLength |
| The number of bytes being used in the array. | |
Detailed Description
Point 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 point shape buffer you should first create the appropriate shape buffer, get the geometry, get the point, and any z or m values. To write a point create a row buffer, create a shape buffer, set up the shape buffer, get the point, assign the coordinates to the point, assign z and m values if present, set the geometry and insert the row.
Member Function Documentation
| fgdbError FileGDBAPI::PointShapeBuffer::GetPoint | ( | Point *& | point | ) | const |
Get a pointer to the points coordinates.
- Parameters
-
[out] point A pointer to the coordinate.
- Returns
- Error code indicating whether the method finished successfully.
| fgdbError FileGDBAPI::PointShapeBuffer::GetZ | ( | double *& | z | ) | const |
Get a pointer to the points z coordinate.
- Parameters
-
[out] z A pointer to the z value.
- Returns
- Error code indicating whether the method finished successfully..
| fgdbError FileGDBAPI::PointShapeBuffer::GetM | ( | double *& | m | ) | const |
Get a pointer to the points measure.
- Parameters
-
[out] m A pointer to the m value.
- Returns
- Error code indicating whether the method finished successfully.
| fgdbError FileGDBAPI::PointShapeBuffer::GetID | ( | int *& | id | ) | const |
Get a pointer to the points ID value.
- Parameters
-
[out] id A pointer to the id.
- Returns
- Error code indicating whether the method finished successfully..
| fgdbError FileGDBAPI::PointShapeBuffer::Setup | ( | ShapeType | shapeType | ) |
Setup a shape buffer for insert.
Allocates the correct length buffer for the selected shape type.
- Parameters
-
[in] shapeType The shape type of the buffer. Shape Type
- Returns
- Error code indicating whether the method finished successfully.
