geos.GEOSWKBWriter_create_r ⇒ GEOSWKBWriter ⏏
Allocate a new GEOSWKBWriter.
Kind: global property of geos
Returns: GEOSWKBWriter - a new writer. Caller must free with GEOSWKBWriter_destroy()
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
geos.GEOSWKBWriter_destroy ⇒ null ⏏
Free the memory associated with a GEOSWKBWriter.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The writer to destroy. |
geos.GEOSWKBWriter_destroy_r ⇒ null ⏏
Free the memory associated with a GEOSWKBWriter.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The writer to destroy. |
geos.GEOSWKBWriter_getByteOrder ⇒ number ⏏
Find whether the writer will use WKB byte order that is big or little endian. The return value is a member of GEOSWKBByteOrders.
Kind: global property of geos
Returns: number - The current byte order
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The writer to read byte order from |
geos.GEOSWKBWriter_getByteOrder_r ⇒ number ⏏
Find whether the writer will use WKB byte order that is big or little endian. The return value is a member of GEOSWKBByteOrders.
Kind: global property of geos
Returns: number - The current byte order
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The writer to read byte order from |
geos.GEOSWKBWriter_getFlavor ⇒ number ⏏
Find whether the writer will use WKB that is ISO flavor or "extended" flavor. The flavor determines how extra dimensionality is encoded with the type number, and whether SRID can be included in the WKB. ISO flavor does not support SRID embedding. ISO flavor is "more standard" for 3D output. GEOS can read both flavors. The return value is a member of GEOSWKBFlavors.
Kind: global property of geos
Returns: number - The current flavor
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The writer to read flavor from |
geos.GEOSWKBWriter_getFlavor_r ⇒ number ⏏
Find whether the writer will use WKB that is ISO flavor or "extended" flavor. The flavor determines how extra dimensionality is encoded with the type number, and whether SRID can be included in the WKB. ISO flavor does not support SRID embedding. ISO flavor is "more standard" for 3D output. GEOS can read both flavors. The return value is a member of GEOSWKBFlavors.
Kind: global property of geos
Returns: number - The current flavor
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The writer to read flavor from |
geos.GEOSWKBWriter_getIncludeSRID ⇒ number ⏏
Read the current SRID embedding value from the writer.
Kind: global property of geos
Returns: number - char
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The writer to check SRID value on |
geos.GEOSWKBWriter_getIncludeSRID_r ⇒ number ⏏
Read the current SRID embedding value from the writer.
Kind: global property of geos
Returns: number - char
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The writer to check SRID value on |
geos.GEOSWKBWriter_getOutputDimension ⇒ number ⏏
Read the current output dimension of the writer. Either 2, 3, or 4 dimensions. Return current number of dimensions.
Kind: global property of geos
Returns: number - Number of dimensions (2, 3, or 4)
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The writer to read from. |
geos.GEOSWKBWriter_getOutputDimension_r ⇒ number ⏏
Read the current output dimension of the writer. Either 2, 3, or 4 dimensions. Return current number of dimensions.
Kind: global property of geos
Returns: number - Number of dimensions (2, 3, or 4)
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The writer to read from. |
geos.GEOSWKBWriter_setByteOrder ⇒ null ⏏
Set the output byte order of the writer, using a value from GEOSWKBByteOrders enum.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The writer to set byte order on |
| byteOrder | number | Desired byte order |
geos.GEOSWKBWriter_setByteOrder_r ⇒ null ⏏
Set the output byte order of the writer, using a value from GEOSWKBByteOrders enum.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The writer to set byte order on |
| byteOrder | number | Desired byte order |
geos.GEOSWKBWriter_setFlavor ⇒ null ⏏
Set the output flavor of the writer, using a value from GEOSWKBFlavors enum.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The writer to set flavor on |
| flavor | number | Desired flavor |
geos.GEOSWKBWriter_setFlavor_r ⇒ null ⏏
Set the output flavor of the writer, using a value from GEOSWKBFlavors enum.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The writer to set flavor on |
| flavor | number | Desired flavor |
geos.GEOSWKBWriter_setIncludeSRID ⇒ null ⏏
Specify whether SRID values should be output in WKB. Many WKB readers do not support SRID values, use with caution.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The writer to set SRID output on |
| writeSRID | number | Set to 1 to include SRID, 0 otherwise |
geos.GEOSWKBWriter_setIncludeSRID_r ⇒ null ⏏
Specify whether SRID values should be output in WKB. Many WKB readers do not support SRID values, use with caution.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The writer to set SRID output on |
| writeSRID | number | Set to 1 to include SRID, 0 otherwise |
geos.GEOSWKBWriter_setOutputDimension ⇒ null ⏏
Set the output dimensionality of the writer. Either 2, 3, or 4 dimensions. Default since GEOS 3.12 is 4.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The writer to read from. |
| newDimension | number | The dimensionality desired |
geos.GEOSWKBWriter_setOutputDimension_r ⇒ null ⏏
Set the output dimensionality of the writer. Either 2, 3, or 4 dimensions. Default since GEOS 3.12 is 4.
Kind: global property of geos
Returns: null - void
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The writer to read from. |
| newDimension | number | The dimensionality desired |
geos.GEOSWKBWriter_write ⇒ number ⏏
Write out the WKB representation of a geometry.
Kind: global property of geos
Returns: number - The WKB representation. Caller must free with GEOSFree()
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The GEOSWKBWriter controlling the writing. |
| g | GEOSGeometry | Geometry to convert to WKB |
| size | NumberPointer | Pointer to write the size of the final output WKB to |
geos.GEOSWKBWriter_writeHEX ⇒ number ⏏
Write out the hex WKB representation of a geometry.
Kind: global property of geos
Returns: number - The HEX WKB representation. Caller must free with GEOSFree()
| Param | Type | Description |
|---|---|---|
| writer | GEOSWKBWriter | The GEOSWKBWriter controlling the writing. |
| g | GEOSGeometry | Geometry to convert to WKB |
| size | NumberPointer | Pointer to write the size of the final output WKB to |
geos.GEOSWKBWriter_writeHEX_r ⇒ number ⏏
Write out the hex WKB representation of a geometry.
Kind: global property of geos
Returns: number - The HEX WKB representation. Caller must free with GEOSFree()
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The GEOSWKBWriter controlling the writing. |
| g | GEOSGeometry | Geometry to convert to WKB |
| size | NumberPointer | Pointer to write the size of the final output WKB to |
geos.GEOSWKBWriter_write_r ⇒ number ⏏
Write out the WKB representation of a geometry.
Kind: global property of geos
Returns: number - The WKB representation. Caller must free with GEOSFree()
| Param | Type | Description |
|---|---|---|
| handle | GEOSContextHandle_t | - |
| writer | GEOSWKBWriter | The GEOSWKBWriter controlling the writing. |
| g | GEOSGeometry | Geometry to convert to WKB |
| size | NumberPointer | Pointer to write the size of the final output WKB to |