geosoft.gxpy.gx submodule

GX Context and related methods to with Geosoft Python.

exception geosoft.gxpy.gx.GXException

Bases: Exception

Exceptions from this module.

New in version 9.1.

class geosoft.gxpy.gx.GXpy(name='geosoft.gxpy.gx', version='9.1', parent_window=0)

Bases: object

Geosoft GX context.

Parameters:

• app – application name, default is the script name
• version – application version number, default geosoft version
• parent_window – ID of the parent window if needed, default 0.

Members:

gxapi:GX context to be used to call geosoft.gxapi methods gid:User’s Geosoft ID

Raises:

GXException():if unable to create context

New in version 9.1.

active_wind_id()

Returns:The active window ID (HWND cast to unsigned for Windows).

New in version 9.1.

disable_app()

Disables application windows to allow modal Python UI. Call before opening your own UI window.

New in version 9.1.

enable_app()

Enables application windows to allow modal Python UI. Call before returning control to OM.

New in version 9.1.

entitlements()

Returns:The current user entitlements as a dictionary.

New in version 9.1.

environment(formated_indent=-1)

Returns:Geosoft environment information as a dictionary.

New in version 9.1.

folder_temp()

Returns:The Geosoft tempporary folder.

New in version 9.1.

folder_user()

Returns:The Geosoft user configuration files folder.

New in version 9.1.

folder_workspace()

Returns:The workspace folder.

New in version 9.1.

license_class()

Returns:The current license class.

New in version 9.1.

main_wind_id()

Returns:The main window ID (HWND cast to unsigned for Windows).

New in version 9.1.