Scylla Documentation Logo Documentation
  • Server
    • Scylla Open Source
    • Scylla Enterprise
    • Scylla Alternator
  • Cloud
    • Scylla Cloud
    • Scylla Cloud Docs
  • Tools
    • Scylla Manager
    • Scylla Monitoring Stack
    • Scylla Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu
Scylla C/C++ Driver Documentation API Documentation DsePolygonIterator

DsePolygonIterator¶

struct DsePolygonIterator¶

Public Functions

DsePolygonIterator *dse_polygon_iterator_new()¶

Creates a new polygon iterator.

See also

dse_polygon_iterator_free()

Returns

Returns an iterator that must be freed.

void dse_polygon_iterator_free(DsePolygonIterator *iterator)¶

Frees a polygon iterator instance.

Parameters

iterator – [in]

CassError dse_polygon_iterator_reset(DsePolygonIterator *iterator, const CassValue *value)¶

Resets a polygon iterator so that it can be reused to process a binary representation.

Parameters
  • iterator – [in] the iterator to reset

  • value – [in] binary representation of the polygon

Returns

CASS_OK if successful, otherwise an error occurred.

CassError dse_polygon_iterator_reset_with_wkt(DsePolygonIterator *iterator, const char *wkt)¶

Resets a polygon iterator so that it can be reused to parse WKT.

Note

The wkt string must remain allocated throughout the lifetime of the iterator since the iterator traverses the string without copying it.

Parameters
  • iterator – [in] the iterator to reset

  • wkt – [in] WKT representation of the polygon

Returns

CASS_OK if successful, otherwise an error occurred.

CassError dse_polygon_iterator_reset_with_wkt_n(DsePolygonIterator *iterator, const char *wkt, size_t wkt_length)¶

Same as dse_polygon_iterator_reset_with_wkt(), but with lengths for string parameters.

Note

The wkt string must remain allocated throughout the lifetime of the iterator since the iterator traverses the string without copying it.

Parameters
  • iterator – [in] the iterator to reset

  • wkt – [in] WKT representation (string) of the polygon

  • wkt_length – [in] length of wkt string

Returns

CASS_OK if successful, otherwise an error occurred.

cass_uint32_t dse_polygon_iterator_num_rings(const DsePolygonIterator *iterator)¶

Gets the number rings in the polygon.

Parameters

iterator – [in]

Returns

The number of rings in the polygon.

CassError dse_polygon_iterator_next_num_points(DsePolygonIterator *iterator, cass_uint32_t *num_points)¶

Gets the number of points for the current ring.

Parameters
  • iterator – [in]

  • num_points – [out]

Returns

CASS_OK if successful, otherwise an error occurred.

CassError dse_polygon_iterator_next_point(DsePolygonIterator *iterator, cass_double_t *x, cass_double_t *y)¶

Gets the next point in the current ring.

Parameters
  • iterator – [in]

  • x – [out]

  • y – [out]

Returns

CASS_OK if successful, otherwise an error occurred.

PREVIOUS
DsePolygon
NEXT
Features
  • master
    • master
  • C/C++ Driver for ScyllaDB
  • API Documentation
    • CassAggregateMeta
    • CassAuthenticator
    • CassBatch
    • CassCluster
    • CassCollection
    • CassColumnMeta
    • CassCustomPayload
    • CassDataType
    • CassErrorResult
    • CassExecProfile
    • CassFunctionMeta
    • CassFuture
    • CassIndexMeta
    • CassInet
    • CassIterator
    • CassKeyspaceMeta
    • CassMaterializedViewMeta
    • CassMetrics
    • CassNode
    • CassPrepared
    • CassResult
    • CassRetryPolicy
    • CassRow
    • CassSchemaMeta
    • CassSession
    • CassSsl
    • CassStatement
    • CassTableMeta
    • CassTimestampGen
    • CassTuple
    • CassUserType
    • CassUuid
    • CassUuidGen
    • CassValue
    • CassVersion
    • DseDateRange
    • DseDateRangeBound
    • DseLineString
    • DseLineStringIterator
    • DsePolygon
    • DsePolygonIterator
  • Features
    • Basics
      • Batches
      • Binding Parameters
      • Client-side timestamps
      • Consistency
      • Data Types
      • The date and time Types
      • Futures
      • Handling Results
      • Keyspaces
      • Prepared Statements
      • Schema Metadata
      • Tuples
      • User-Defined Types (UDTs)
      • UUIDs
    • Building
    • Client Configuration
    • Cloud
    • Configuration
      • Retry policies
    • Execution Profiles
    • FAQ
    • Installation
    • Logging
    • Metrics
    • Scylla Specific Features
    • Security
      • SSL
    • Testing
      • Cassandra Cluster Manager (CCM)
    • Tracing
  • DSE Features
    • Authentication
    • Geospatial types
  • Create an issue
  • Edit this page
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 18 October 2022.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.3.1