Indices and tables¶

Introduction¶

The GXContext class¶

class geosoft.gx.GXContext¶

The main GX execution context. A single instance of this object needs to be created before using any other class in the geosoft.gx module.

static create((str) application, (str)version) → GXContext¶

Creates the GX execution context.

Parameters:	application (str) – Calling application name version (str) – Calling application version
Returns:	A GX execution context.
Return type:	geosoft.gx.GXContext

Note

There should be a single instance of this class constructed in a global location prior to using any other GX API classes and their methods. By default the module will only function if an installed Oasis montaj product is found since it loads the dlls that are shipped with Oasis montaj for the actual functionality.

It is possible to redirect the location of dlls used by setting the GX_GEOSOFT_BIN_PATH environment variable. This can be done either using the normal Windows mechanisms (i.e. via set command line or Advanced System Settings->Environment Variables) or directly in Python code by using os.putenv("GX_GEOSOFT_BIN_PATH", ...). If the intention is to use the public standalone API that is shipped with GX Developer then this should be set to wherever the GeosoftFiles redistributable folder is copied or installed.

Exceptions¶

exception geosoft.gx.GXRunTimeError¶: This exception is derived from RuntimeError and is used to report any errors resulting from the invocation of any GX API method or class instantiation.

Helper classed to pass immutable values by reference¶

class geosoft.gx.str_ref¶

class geosoft.gx.bool_ref¶

class geosoft.gx.int_ref¶

class geosoft.gx.float_ref¶

Each of the classes above can be used to pass these immutable types by reference to the GX API. Instances of the objects has a value property holding a reference to the immutable.

Default instances will be intialized with dummy values for float_ref and int_ref, an empty string for str_ref and False for bool_ref. One can also set the value during intialization or assigning to the value property.

Example usage:

import geosoft.gx as gx

     ctx = gx.GXContext.create("sample", "1.0")
     _3dn = gx.GX3DN.create(ctx)

     distance = gx.float_ref() # value property will be equal to gx.rDUMMY
     rot1 = gx.float_ref(1.01) # value property will be equal to 1.01
     rot2 = gx.float_ref(2.0)  # value property will be equal to 2.0
     rot2.value = 4  # value property will be equal to 4.0

     _3dn.get_point_of_view(distance, rot1, rot2)

     print(distance.value) # value property will now be 8.0
     print(rot1.value) # value property will now be 0.0
     print(rot2.value) # value property will now be 0.0

Other Classes in the GX API¶

GX3DN class¶

class geosoft.gx.GX3DN

This class manages the rendering of a 3D view. It allows
the positioning of the camera, specification of the zoom
as well as some rendering controls for the axis. It is
directly releated to the MVIEW class.

Indices and tables¶

Introduction¶

The GXContext class¶

Exceptions¶

Helper classed to pass immutable values by reference¶

Other Classes in the GX API¶

GX3DN class¶

GX3DV class¶

GXACQUIRE class¶

GXAGG class¶

GXARCDB class¶

GXARCDH class¶

GXARCMAP class¶

GXARCSYS class¶

GXBF class¶

GXBIGRID class¶

GXCHIMERA class¶

GXCOM class¶

GXCSYMB class¶

GXDAT class¶

GXDATALINKD class¶

GXDATAMINE class¶

GXDB class¶

GXDBREAD class¶

GXDGW class¶

GXDH class¶

GXDMPPLY class¶

GXDOCU class¶

GXDSEL class¶

GXDU class¶

GXDXFI class¶

GXEDB class¶

GXEDOC class¶

GXEMAP class¶

GXEMAPTEMPLATE class¶

GXEMXD class¶

GXEUL3 class¶

GXEXP class¶

GXEXT class¶

GXFFT class¶

GXFFT2 class¶

GXFLT class¶

GXGD class¶

GXGEOSTRING class¶

GXGER class¶

GXGIS class¶

GXGMSYS class¶

GXGOLEDB class¶

GXGU class¶

GXGUI class¶

GXHGD class¶

GXHTTP class¶

GXHXYZ class¶

GXIEXP class¶

GXIGRF class¶

GXIMG class¶

GXIMU class¶

GXINTERNET class¶

GXIP class¶

GXIPGUI class¶

GXIPJ class¶

GXITR class¶

GXKGRD class¶

GXLAYOUT class¶

GXLL2 class¶

GXLMSG class¶

GXLPT class¶

GXLST class¶

GXLTB class¶

GXMAP class¶

GXMAPL class¶

GXMAPTEMPLATE class¶

GXMATH class¶

GXMETA class¶

GXMISC class¶

GXMSTK class¶

GXMVG class¶

GXMVIEW class¶

GXMVU class¶

GXMXD class¶