struct DsePolygon

Functions

DsePolygon *

dse_polygon_new

( )

Creates a new polygon iterator.

Returns:
Type Details
DsePolygon *

Returns an polygon that must be freed.
See Also:
void

dse_polygon_free

( DsePolygon * polygon )

Frees a polygon instance.

Parameters:
Name Type Details
in polygon DsePolygon *
void

dse_polygon_reset

( DsePolygon * polygon )

Resets a polygon so that it can be reused.

Parameters:
Name Type Details
in polygon DsePolygon *
void

dse_polygon_reserve

( DsePolygon * polygon, cass_uint32_t num_rings, cass_uint32_t total_num_points )

Reserves enough memory to contain the provided number rings and points. This can be use to reduce memory allocations, but it is not required.

Parameters:
Name Type Details
in polygon DsePolygon *
in num_rings cass_uint32_t
in total_num_points cass_uint32_t
CassError

dse_polygon_start_ring

( DsePolygon * polygon )

Starts a new ring.

Note: This will finish the previous ring.

Parameters:
Name Type Details
in polygon DsePolygon *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

dse_polygon_add_point

( DsePolygon * polygon, cass_double_t x, cass_double_t y )

Adds a point to the current ring.

Parameters:
Name Type Details
in polygon DsePolygon *
in x cass_double_t
in y cass_double_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

dse_polygon_finish

( DsePolygon * polygon )

Finishes the contruction of a polygon.

Parameters:
Name Type Details
in polygon DsePolygon *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.