Reference — GSTPy documentation

# Reference

## Version

`version` | The GSTPy API Version
`client_api_version` | The Version of the underlying GST API that GSTPy uses.

## NetworkInterface

Functions

`get_ora_connection` | Establish a connection to the oracle backend interface.
`get_pg_connection` | Establish a connection to the postgres backend interface.
`get_gst3_connection` | Establish a connection to the gst3 backend interface.

Classes

`NetworkInterface` | Connection / Interface to the database.

## Feature

Enums

`GeometryTypes` | The type of a feature.
`ZAxisDomain` | Information about the z-axis domain.
`FeatureClassTag` | Information how a feature class should be tagged.
`GeometryLoadMode` | Defines how a selected geometry will be loaded based on the selection
`GeometryLoadThreshold` | Defines how a geometry will be selected based on the selection area.

Classes

`Box` | Axis-aligned minimum bounding box.
`QueryBox` | Describes a query box Used for select inside queries
`Color` | RGB color value.
`ColorRGBA` | RGBA color value.
`Commit` | Information about a commit.
`CommitVersion` | Information about a specific version of a feature.
`CrudeFeature` | Information and data of a feature download request.
`FeatureClassDesc` | Information about a feature class.
`FeatureDesc` | Information about a feature.
`SaveFeatureResult` | Information about a save feature request.
`Area` | Defines the selection area for a feature download.
`AreaLimiter` | Defines the selection area, selection mode and load threshold for partial feature downloads.
`BoundingBox` | Box with Srs definition.
`GeometryFile` | Defines a reference to a geometry file on the filesystem.
`PolygonSelection` | Defines a polygon from either a geometry file or an existing feature.
`KmlWriterOptions` | Options for the KML format.
`ObjWriterOptions` | Options for the OBJ format.
`SegyWriterOptions` | Options for the SEGY format.
`Tiles3dWriterOptions` | Options for the 3D Tiles format.
`WriterOptions` | Writer options for formats with specific options.
`TilingParameters` | Tiling parameters
`ShiftParameters` | Shift parameters
`MeshSimplificationParameters` | Mesh simplification parameters

## SRS

Enums

`SRSType` | The type of an SRS.

Classes

`SRS` | SRS base class.
`EmptySRSDef` | Empty SRS.
`GSTSRSRef` | SRS stored in GST.
`WKTSRSDef` | OGC WKT SRS Definition.
`PROJ4SRSDef` | PROJ4 SRS Definition.
`ESRIWKTDef` | ESRI WKT SRS Definition.
`SRSItemDesc` | Information about a stored SRS.

## Parsing

Enums

`FileType` | The type of a file.
`RequestFormat` | File format of a requested feature.

Classes

`StreamableGeometry` | Abstract base class used for upload/update of features.
`RawPoint3` | 3d point.
`IdxTriangle` | A triangle that references its vertices by id.
`IdxTetrahedron` | A tetrahedron that references its vertices by id.
`GeometryBuilder` | Allows to create a geometry for upload/update from a custom format.
`IParsingActions` | Allows to retrieve a geometry in a custom format.
`ParsedGeometry` | Describes a parsed geometry.
`ParsedSimplexPropertyDescription` | Describes a simplex property of a parsed geometry.
`GridOrientation` | Orientation and overall length of Grid described by vectors of its three axis.
`GridSize` | Amount of cells in all Grid-axis directions.
`GridDescription` | Describes position, orientation and size of a grid.

## Segy

Enums

`Unit` | Unit of measurement.
`Dimensionality` | Dimension of the SEGY file.
`NumberFormat` | Number format.

Classes

`SEGYInfo` | SEGY information

## Property

Enums

`PropertyTypes` | Type of a property
`PropertyAlignments` | Alignment of a simplex property.

Classes

`NewProperty` | Parameter to create a new property.
`NewSimplexProperty` | Parameter to create a new simplex property.
`AttributeDescription` | Describes a table attribute.
`ObjectPropertyDesc` | Describes an object property
`SimplexPropertyDesc` | Describes a simplex property
`AttributeValue` | Attribute value with description.

## Intersection

Enums

`ImageType` | Output type of the image

Classes

`Point2d` | 2d point
`Rectangle2d` | 2d rectangle
`OutputShapeParameters` | Parameter for shape output.
`OutputImageParameters` | Parameter for image output
`BoreHoleImageParameters` | parameter for borehole creation
`SectionImageParameters` | Parameter for cross section creation.
`MapImageParameters` | Parameter for map section creation.
`IntersectionInfo` | The info for a created intersection.

## Owner

Enums

`OwnerType` | Type of the owner.

Classes

`Owner` | GST owner.
`User` | GST user
`Group` | GST group

## MoMa

Enums

`LinkAdjacencyTargetType` | The type of the link adjacency target.

Classes

`Element` | Information about a MoMa element.
`LinkAdjacency` | Information about a link adjacency.
`LinkedElement` | Information about a linked MoMa element.
`MoMaPropertyDesc` | Information about a MoMa property.
`MoMaPropertyValue` | Information about a MoMa property value.

## Exceptions

`NameAlreadyExists` | The feature to be uploaded has a duplicate name.
`NodeStillLinkedTo` | The node to be deleted has referencing links.
`LinkHasChildren` | The link to be deleted has children.
`ClassHasLockedFeatures` | The feature class to be deleted has locked features.
`SrsStillInUse` | The SRS to be deleted is still in use.
`FeatureIdUnknown` | The feature was not found in the database.
`CouldNotCreateGeometry` | An error with the feature data format.
`NoTransformAvailable` | An error while trying to perform an SRS transformation.
`GeometryIsLocked` | Action cannot be performed on a locked geometry.
`GeometryIsLockedInArea` | Action cannot be performed on a partially locked geometry.
`BorderConstraintViolated` | Update violated a border constraint.
`IntersectionNoResult` | Intersection returned no result with the supplied parameters.