GXARCDB class

class geosoft.gxapi.GXARCDB
The ARCDB class is used in ArcGIS to access table contents from
data sources and layers.
create_dat((str)arg1, (str)arg2, (str)arg3) → GXDAT:
Create a handle to a ARCGIS table DAT 2D object
Parameters:
  • arg1 (str) – Name of X field in table
  • arg2 (str) – Name of Y field in table
  • arg3 (str) – Name of Data field in table
Returns:

DAT, terminates if creation fails
Return type:

geosoft.gxapi.GXDAT

New in version 8.0.0.

create_dat_3d((str)arg1, (str)arg2, (str)arg3, (str)arg4) → GXDAT:
Create a handle to a ARCGIS table DAT 3D object
Parameters:
  • arg1 (str) – Name of X field in table
  • arg2 (str) – Name of Y field in table
  • arg3 (str) – Name of Z field in table
  • arg4 (str) – Name of Data field in table
Returns:

DAT, terminates if creation fails
Return type:

geosoft.gxapi.GXDAT

New in version 8.0.0.

static current() → GXARCDB:
This method return a handle to the current table
Returns:ARCDB Handle, geosoft.gxapi.GXARCDB.null() if no table selected
Return type:geosoft.gxapi.GXARCDB

New in version 8.0.0.

exist_field((str)arg1) → int:
This method checks to see if the specified field exists
in the table.
Parameters:arg1 (str) – Name of Field
Returns:0 - Field does not exist 1 - Field Exists
Return type:int

New in version 8.0.0.

export_to_db((GXDB)arg1, (str)arg2, (str)arg3) → None:
Export data from an ARCDB table into a group in a Geosoft GDB using a template.
Parameters:
  • arg1 (geosoft.gxapi.GXDB) – Database
  • arg2 (str) – import template name
  • arg3 (str) – Oasis montaj line name to create (overrides template value)
Returns:

Nothing
Return type:

None

New in version 8.0.0.

Note:

1. The import template can be in the local directory or the GEOSOFT
   directory.

3. If the line already exists, the data will overwrite the existing data.
field_lst((GXLST)arg1) → None:
Place the list of field names in a LST.
Parameters:arg1 (geosoft.gxapi.GXLST) – LST
Returns:Nothing
Return type:None

New in version 8.0.0.

Note:

If Z or M values are supported by the table geometry the strings
"<Z Values>" and "<M Values>" will be added accordingly.
static from_i_unknown((int)arg1) → GXARCDB:
This method attempts to make a table handle from an IUnknown pointer

Returns                               ARCDB Handle, geosoft.gxapi.GXARCDB.null() if not successful
Parameters:arg1 (int) – IUnknown pointer
Return type:geosoft.gxapi.GXARCDB

New in version 8.0.0.

get_i_unknown() → int:
This method gets the IUnknown pointer
Returns:IUnknown pointer
Return type:int

New in version 8.0.0.

get_ipj((GXIPJ)arg1) → None:
Get georeference information from a table.
Parameters:arg1 (geosoft.gxapi.GXIPJ) – IPJ to fill in
Returns:Nothing
Return type:None

New in version 8.0.0.

Note:

If the table does not have an IPJ, the IPJ that is
returned will have an unknown projection.
import_chem_database_wizard((str)arg1, (int)arg2) → int:
Template creation for importing geochem data.
Parameters:
Returns:

0-OK 1-Cancel
Return type:

int

New in version 8.0.0.

is_null() → bool

Check if the instance of geosoft.gxapi.GXARCDB is null (undefined)

Returns:True if this is a null instance of geosoft.gxapi.GXARCDB, False otherwise.
Return type:bool`
static null() → GXARCDB

A null (undefined) instance of geosoft.gxapi.GXARCDB

Returns:A null geosoft.gxapi.GXARCDB
Return type:geosoft.gxapi.GXARCDB
static sel_tbl_ex_gui((int_ref)arg1) → GXARCDB:
Select table GUI with table type.
Parameters:arg1 (geosoft.gxapi.int_ref) – ARC_SELTBL_TYPE constants
Returns:Handle to the table (Terminate on Error)
Return type:geosoft.gxapi.GXARCDB

New in version 8.0.0.

static sel_tbl_gui() → GXARCDB:
Select table GUI.
Returns:Handle to the table
Return type:geosoft.gxapi.GXARCDB

New in version 8.0.0.

Note:

Terminates with Cancel on cancel, returns ARCDB_NULL if there are no valid tables in current document.

ARC_SELTBL_TYPE constants

Describes what kind of table was selected
gxapi.ARC_SELTBL_STANDALONE = 0
Standalone Table
gxapi.ARC_SELTBL_FEATURELAYER = 1
Feature Layer
gxapi.ARC_SELTBL_CANCELED = -1
User Canceled