Reference¶
Version¶
The GSTPy API Version |
|
The Version of the underlying GST API that GSTPy uses. |
NetworkInterface¶
Functions
Establish a connection to the oracle backend interface. |
|
Establish a connection to the postgres backend interface. |
|
Establish a connection to the gst3 backend interface. |
Classes
Connection / Interface to the database. |
Feature¶
Enums
The type of a feature. |
|
Information about the z-axis domain. |
Classes
Axis-aligned minimum bounding box. |
|
Describes a query box Used for select inside queries |
|
RGB color value. |
|
RGBA color value. |
|
Information about a commit. |
|
Information about a specific version of a feature. |
|
Information and data of a feature download request. |
|
Information about a feature class. |
|
Information about a feature. |
|
Information about a save feature request. |
SRS¶
Enums
The type of an SRS. |
Classes
SRS base class. |
|
Empty SRS. |
|
SRS stored in GST. |
|
OGC WKT SRS Definition. |
|
PROJ4 SRS Definition. |
|
ESRI WKT SRS Definition. |
|
Information about a stored SRS. |
Parsing¶
Enums
File format of a requested feature. |
Classes
Abstract base class used for upload/update of features. |
|
3d point. |
|
A triangle that references its vertices by id. |
|
A tetrahedron that references its vertices by id. |
|
Allows to create a geometry for upload/update from a custom format. |
|
Allows to retrieve a geometry in a custom format. |
Property¶
Enums
Type of a property |
|
Alignment of a simplex property. |
Classes
Parameter to create a new property. |
|
Describes a table attribute. |
|
Describes an object property |
|
Describes a simplex property |
|
Attribute value with description. |
Intersection¶
Enums
Output type of the image |
Classes
2d point |
|
2d rectangle |
|
Parameter for shape output. |
|
Parameter for image output |
|
parameter for borehole creation |
|
Parameter for cross section creation. |
|
Parameter for map section creation. |
|
The info for a created intersection. |
MoMa¶
Enums
The type of the link adjacency target. |
Classes
Information about a MoMa element. |
|
Information about a level. |
|
Information about a link adjacency. |
|
Information about a linked MoMa element. |
|
Information about a MoMa property. |
|
Information about a MoMa property value. |
Exceptions¶
The feature to be uploaded has a duplicate name. |
|
The node to be deleted has referencing links. |
|
The link to be deleted has children. |
|
The feature class to be deleted has locked features. |
|
The SRS to be deleted is still in use. |
|
The feature was not found in the database. |
|
An error with the feature data format. |
|
An error while trying to perform an SRS transformation. |
|
Action cannot be performed on a locked geometry. |
|
Action cannot be performed on a partially locked geometry. |
|
Update violated a border constraint. |
|
Intersection returned no result with the supplied parameters. |