Skip to content
On this page

geos.GEOSWKBWriter_create ⇒ number

Creates a new GEOSWKBWriter object.

Kind: Exported member
Returns: number - A pointer to a GEOSWKBWriter object, or null on error.


geos.GEOSWKBWriter_create_r ⇒ number

Creates a new GEOSWKBWriter object with a context handle.

Kind: Exported member
Returns: number - A pointer to a GEOSWKBWriter object, or null on error.

ParamTypeDescription
handlenumberA GEOSContextHandle_t object.

geos.GEOSWKBWriter_destroy ⏏

Destroys a GEOSWKBWriter object.

Kind: Exported member

ParamTypeDescription
writernumberA pointer to a GEOSWKBWriter object.

geos.GEOSWKBWriter_destroy_r ⏏

Destroys a GEOSWKBWriter object.

Kind: Exported member

ParamTypeDescription
handlenumberA pointer to the GEOS context handle.
writernumberThe GEOSWKBWriter object to destroy.

geos.GEOSWKBWriter_getByteOrder ⇒ number

Get the byte order of a WKBWriter object.

Kind: Exported member
Returns: number - The byte order (0 for big endian, 1 for little endian).

ParamTypeDescription
writernumberA pointer to a GEOSWKBWriter object.

geos.GEOSWKBWriter_getByteOrder_r ⇒ number

Returns the byte order used by the writer.

Kind: Exported member
Returns: number - The byte order (GEOS_WKB_XDR or GEOS_WKB_NDR).

ParamTypeDescription
handlenumberA pointer to the GEOS context handle.
writernumberThe GEOSWKBWriter pointer.

geos.GEOSWKBWriter_getFlavor ⇒ number

Returns the output format of a WKB writer.

Kind: Exported member
Returns: number - An integer representing the output format, such as 0 for WKB_ISO, 1 for WKB_SFSQL, or 2 for WKB_HEX.
See: https://libgeos.org/doxygen/geos__c_8h.html#a3f7a4c9b8b4f8e2f6d3a0e5c5b7b0a6f

ParamTypeDescription
writernumberA pointer to a GEOS WKB writer object.

geos.GEOSWKBWriter_getFlavor_r ⇒ number

Returns the output format of a WKB writer.

Kind: Exported member
Returns: number - An integer representing the output format, such as 0 for WKB_ISO, 1 for WKB_SFSQL, or 2 for WKB_HEX. Returns -1 on error.
See: https://libgeos.org/doxygen/geos__c_8h.html#a0a7f9c4a6f5b8e0f3c8b9a2d1b6b4e3a

ParamTypeDescription
handlenumberA GEOS context handle.
writernumberA pointer to a GEOS WKB writer object.

geos.GEOSWKBWriter_getIncludeSRID ⇒ number

Returns whether the writer includes SRID values in output WKB.

Kind: Exported member
Returns: number - 1 if SRID values are included, 0 otherwise.

ParamTypeDescription
writernumberThe GEOSWKBWriter pointer.

geos.GEOSWKBWriter_getIncludeSRID_r ⇒ number

Returns whether the writer includes SRID values in output WKB with a context handle.

Kind: Exported member
Returns: number - 1 if SRID values are included, 0 otherwise.

ParamTypeDescription
handlenumberA pointer to the GEOS context handle.
writernumberThe GEOSWKBWriter pointer.

geos.GEOSWKBWriter_getOutputDimension ⇒ number

Get the output dimension of a WKBWriter object.

Kind: Exported member
Returns: number - The output dimension (2 or 3).

ParamTypeDescription
writernumberA pointer to a GEOSWKBWriter object.

geos.GEOSWKBWriter_getOutputDimension_r ⇒ number

Get the output dimension of a WKBWriter object (thread-safe).

Kind: Exported member
Returns: number - The output dimension (2 or 3).

ParamTypeDescription
handlenumberA pointer to a GEOS context handle.
writernumberA pointer to a GEOSWKBWriter object.

geos.GEOSWKBWriter_setByteOrder ⏏

Sets the byte order for the writer.

Kind: Exported member

ParamTypeDescription
writernumberThe GEOSWKBWriter pointer.
byteOrdernumberThe byte order to use (GEOS_WKB_XDR or GEOS_WKB_NDR).

geos.GEOSWKBWriter_setByteOrder_r ⏏

Sets the byte order for the writer with a context handle.

Kind: Exported member

ParamTypeDescription
handlenumberA pointer to the GEOS context handle.
writernumberThe GEOSWKBWriter pointer.
byteOrdernumberThe byte order to use (GEOS_WKB_XDR or GEOS_WKB_NDR).

geos.GEOSWKBWriter_setFlavor ⇒ void

Sets the output format of a WKB writer to either WKB or EWKB.

Kind: Exported member
See: https://libgeos.org/doxygen/geos__c_8h.html#a9a0e1f9fa62b0d657c4b18e01a276a94

ParamTypeDescription
writernumberA pointer to a GEOS WKB writer object.
flavornumberAn integer representing the output format, 1 for WKB, 2 for EWKB.

geos.GEOSWKBWriter_setFlavor_r ⇒ number

Sets the output format of a WKB writer to either WKB or EWKB.

Kind: Exported member
Returns: number - 1 on success, 0 on failure.
See: https://libgeos.org/doxygen/geos__c_8h.html#a7f9a6d3a5f2b0f1a4c6b4c2e3b9b8a9e

ParamTypeDescription
handlenumberA GEOS context handle.
writernumberA pointer to a GEOS WKB writer object.
flavornumberAn integer representing the output format, 1 for WKB, 2 for EWKB.

geos.GEOSWKBWriter_setIncludeSRID ⏏

Sets whether output WKB should have an SRID header.

Kind: Exported member

ParamTypeDescription
writernumberA GEOSWKBWriter pointer.
writeSRIDnumberA boolean value indicating whether to include SRID or not.

geos.GEOSWKBWriter_setIncludeSRID_r ⏏

Sets whether output WKB should have an SRID header, with a context handle.

Kind: Exported member

ParamTypeDescription
handlenumberA GEOSContextHandle pointer.
writernumberA GEOSWKBWriter pointer.
writeSRIDnumberA boolean value indicating whether to include SRID or not.

geos.GEOSWKBWriter_setOutputDimension ⏏

Set the output dimension of a WKBWriter object.

Kind: Exported member

ParamTypeDescription
writernumberA pointer to a GEOSWKBWriter object.
newDimensionnumberThe new output dimension (2 or 3).

geos.GEOSWKBWriter_setOutputDimension_r ⏏

Set the output dimension of a WKBWriter object (thread-safe).

Kind: Exported member

ParamTypeDescription
handlenumberA pointer to a GEOS context handle.
writernumberA pointer to a GEOSWKBWriter object.
newDimensionnumberThe new output dimension (2 or 3).

geos.GEOSWKBWriter_write ⇒ string

Writes a geometry as a WKB byte array.

Kind: Exported member
Returns: string - A WKB byte array as a string.

ParamTypeDescription
writernumberThe GEOSWKBWriter object to use.
gnumberThe GEOSGeometry object to write.

geos.GEOSWKBWriter_writeHEX ⇒ string

Writes a geometry as a WKB hex-encoded byte array.

Kind: Exported member
Returns: string - A WKB hex-encoded byte array as a string.

ParamTypeDescription
writernumberThe GEOSWKBWriter object to use.
gnumberThe GEOSGeometry object to write.
sizenumberA pointer to store the size of the output array.

geos.GEOSWKBWriter_writeHEX_r ⇒ string

Writes a geometry as a WKB hex-encoded byte array with a context handle.

Kind: Exported member
Returns: string - A WKB hex-encoded byte array as a string.

ParamTypeDescription
handlenumberA pointer to the GEOS context handle.
writernumberThe GEOSWKBWriter object to use.
gnumberThe GEOSGeometry object to write.
sizenumberA pointer to store the size of the output array.

geos.GEOSWKBWriter_write_r ⇒ string

Writes a geometry as a WKB byte array with a context handle.

Kind: Exported member
Returns: string - A WKB byte array as a string.

ParamTypeDescription
handlenumberA pointer to the GEOS context handle.
writernumberThe GEOSWKBWriter object to use.
gnumberThe GEOSGeometry object to write.
sizenumberA pointer to store the size of the output array.