GXGEOSOFT class¶

This is not a class but a collection of global defines. It is used by all functions.

CRC_INIT_VALUE constants¶

Initial value for starting a CRC

CRC_INIT_VALUE¶

0xFFFFFFFF

gxapi.CRC_INIT_VALUE = 4294967295¶

DATE_FORMAT constants¶

Old Date formats

DATE_FORMAT_YYYYMMDD¶

Standard Date (YYYY/MM/DD, YY/MM/DD, YYYYMMDD or YYMMDD, space or / delimited)

gxapi.DATE_FORMAT_YYYYMMDD = 1¶

DATE_FORMAT_DDMMYYYY¶

Date (DD/MM/YYYY or DD/MM/YY century 20 if YY>50, DISC compliant)

gxapi.DATE_FORMAT_DDMMYYYY = 2¶

DATE_FORMAT_MMDDYYYY¶

Date (MM/DD/YYYY or MM/DD/YY century 19)

gxapi.DATE_FORMAT_MMDDYYYY = 3¶

GEO_DUMMY constants¶

Special numbers indicating NULLL

iDUMMY¶

Integer Dummy (-2147483647)

gxapi.iDUMMY = -2147483647¶

rDUMMY¶

Floating Point Dummy (-1.0E32)

gxapi.rDUMMY = -1e+32¶

GEO_FULL_LIMITS constants¶

Data ranges of all Geosoft types

GS_S1MX¶

(signed char ) 127

gxapi.GS_S1MX = 127¶

GS_S1MN¶

(signed char ) -126

gxapi.GS_S1MN = -126¶

GS_S1DM¶

(signed char ) -127

gxapi.GS_S1DM = -127¶

GS_U1MX¶

(unsigned char ) 254U

gxapi.GS_U1MX = 254¶

GS_U1MN¶

(unsigned char ) 0U

gxapi.GS_U1MN = 0¶

GS_U1DM¶

(unsigned char ) 255U

gxapi.GS_U1DM = 255¶

GS_S2MX¶

(short ) 32767

gxapi.GS_S2MX = 32767¶

GS_S2MN¶

(short ) -32766

gxapi.GS_S2MN = -32766¶

GS_S2DM¶

(short ) -32767

gxapi.GS_S2DM = -32767¶

GS_U2MX¶

(unsigned short) 65534U

gxapi.GS_U2MX = 65534¶

GS_U2MN¶

(unsigned short) 0U

gxapi.GS_U2MN = 0¶

GS_U2DM¶

(unsigned short) 65535U

gxapi.GS_U2DM = 65535¶

GS_S4MX¶

2147483647L

gxapi.GS_S4MX = 2147483647¶

GS_S4MN¶

-2147483646L

gxapi.GS_S4MN = -2147483646¶

GS_S4DM¶

-2147483647L

gxapi.GS_S4DM = -2147483647¶

GS_U4MX¶

(unsigned long ) 0xFFFFFFFE

gxapi.GS_U4MX = 4294967294¶

GS_U4MN¶

(unsigned long ) 0x00000000

gxapi.GS_U4MN = 0¶

GS_U4DM¶

(unsigned long ) 0xFFFFFFFF

gxapi.GS_U4DM = 4294967295¶

GS_S8MX¶

(__GS_INT64 ) 0x7FFFFFFFFFFFFFFF

gxapi.GS_S8MX = 9223372036854775807¶

GS_S8MN¶

(__GS_INT64 ) 0x8000000000000001

gxapi.GS_S8MN = -9223372036854775807¶

GS_S8DM¶

(__GS_INT64 ) 0x8000000000000000

gxapi.GS_S8DM = -9223372036854775808¶

GS_U8MX¶

(__GS_UINT64 ) 0xFFFFFFFFFFFFFFFE

gxapi.GS_U8MX = 18446744073709551614¶

GS_U8MN¶

(__GS_UINT64 ) 0x0000000000000000

gxapi.GS_U8MN = 0¶

GS_U8DM¶

(__GS_UINT64 ) 0xFFFFFFFFFFFFFFFF

gxapi.GS_U8DM = 18446744073709551615¶

GS_R4MX¶

(float ) 1.0E32 (In C these must be declared as external constants:)

gxapi.GS_R4MX = 1e+32¶

GS_R4MN¶

(float ) -0.9E32 const float r4min=(float)-0.9E32,

gxapi.GS_R4MN = -9e+31¶

GS_R4DM¶

(float ) -1.0E32 r4max=(float)1.0E32, r4dum=(float)-1.0E32;

gxapi.GS_R4DM = -1e+32¶

GS_R8MX¶

(double ) 1.0E32

gxapi.GS_R8MX = 1e+32¶

GS_R8MN¶

(double ) -0.9E32

gxapi.GS_R8MN = -9e+31¶

GS_R8DM¶

(double ) -1.0E32

gxapi.GS_R8DM = -1e+32¶

GS_R4EPSILON¶

(float ) 1.0E-32

gxapi.GS_R4EPSILON = 1e-32¶

GS_R8EPSILON¶

(double ) 1.0E-32

gxapi.GS_R8EPSILON = 1e-32¶

GEO_LIMITS constants¶

Data ranges of numbers

iMIN¶

Smallest Integer (-2147483646)

gxapi.iMIN = -2147483646¶

iMAX¶

Largest Integer (2147483647)

gxapi.iMAX = 2147483647¶

rMIN¶

Smallest Floating Point (-0.9E32)

gxapi.rMIN = -9e+31¶

rMAX¶

Largest Floating Point (1.0E32)

gxapi.rMAX = 1e+32¶

GEO_STRING_SIZE constants¶

Default string sized for different uses GX’s must use these unless there is a very good reason not to. The path strings here are generally larger than what is possible in the OS, but it is defined as such for Unicode conversion reasons.

STR_DEFAULT¶

Default Size for almost everything (128 characters)

gxapi.STR_DEFAULT = 128¶

STR_DEFAULT_SHORT¶

Default Size for a short string (64 characters)

gxapi.STR_DEFAULT_SHORT = 64¶

STR_DEFAULT_LONG¶

Default Size for a long string (1024 characters)

gxapi.STR_DEFAULT_LONG = 1024¶

STR_ERROR¶

Default Size for an error string (2048 characters)

gxapi.STR_ERROR = 2048¶

STR_VERY_LONG¶

Default Size for a long string (16384 characters)

gxapi.STR_VERY_LONG = 16384¶

STR_VIEW¶

Name of a View (2080)

gxapi.STR_VIEW = 2080¶

STR_GROUP¶

Name of a Group (1040)

gxapi.STR_GROUP = 1040¶

STR_VIEW_GROUP¶

Combined View/Group Name (2080)

gxapi.STR_VIEW_GROUP = 2080¶

STR_FILE¶

Name of a file (1040)

gxapi.STR_FILE = 1040¶

STR_MULTI_FILE¶

Name of multiple files (16384)

gxapi.STR_MULTI_FILE = 16384¶

STR_DB_SYMBOL¶

Name of database symbol (64)

gxapi.STR_DB_SYMBOL = 64¶

STR_GXF¶

Size of strings for GXF projection info (160).

gxapi.STR_GXF = 160¶

STR_MAX_PATH¶

Maximum path length (1040)

gxapi.STR_MAX_PATH = 1040¶

STR_MULTI_PATH¶

Multi-file path (16384)

gxapi.STR_MULTI_PATH = 16384¶

GS_MAX_PATH¶

Same as STR_FILE

gxapi.GS_MAX_PATH = 1040¶

GS_MULTI_PATH¶

Same as STR_MULTI_FILE

gxapi.GS_MULTI_PATH = 16384¶

GEO_VAR constants¶

Variable types. Use -X for strings of X length

GS_INT¶

Integer (long)

gxapi.GS_INT = 0¶

GS_REAL¶

Floating Point (double)

gxapi.GS_REAL = 1¶

GS_FORMATS constants¶

Special use data types. String are indicated by a negative maximum string length (including NULL).

FORMAT_DECIMAL¶

Standard numbers (-134.534)

gxapi.FORMAT_DECIMAL = 0¶

FORMAT_SIG_DIG¶

Decimals imply number of significant digits

gxapi.FORMAT_SIG_DIG = 5¶

FORMAT_EXP¶

Exponential notation (-1.345e45)

gxapi.FORMAT_EXP = 1¶

FORMAT_TIME_COLON¶

Standard Time (HH:MM:SS.SSSS)

gxapi.FORMAT_TIME_COLON = 2¶

FORMAT_TIME_HMS¶

Time (HH.MMSSSSSSS)

gxapi.FORMAT_TIME_HMS = 8¶

FORMAT_TIME_HHMMSS¶

Time (HHMMSS)

gxapi.FORMAT_TIME_HHMMSS = 9¶

FORMAT_DATE_YYYYMMDD¶

Standard Date (YYYY/MM/DD, YY/MM/DD, YYYYMMDD or YYMMDD, space or / delimited)

gxapi.FORMAT_DATE_YYYYMMDD = 3¶

FORMAT_DATE_DDMMYYYY¶

Date (DD/MM/YYYY or DD/MM/YY century 20 if YY>50, DISC compliant)

gxapi.FORMAT_DATE_DDMMYYYY = 6¶

FORMAT_DATE_MMDDYYYY¶

Date (MM/DD/YYYY or MM/DD/YY century 19)

gxapi.FORMAT_DATE_MMDDYYYY = 7¶

FORMAT_GEOGRAPHIC¶

Standard Geographical (DEG.MM.SS.SSS)

gxapi.FORMAT_GEOGRAPHIC = 4¶

FORMAT_GEOGRAPHIC_1¶

GeoGraph (DEG:MM:SS.SSS)

gxapi.FORMAT_GEOGRAPHIC_1 = 10¶

FORMAT_GEOGRAPHIC_2¶

GeoGraph (DEG.MMSSSSS)

gxapi.FORMAT_GEOGRAPHIC_2 = 11¶

FORMAT_GEOGRAPHIC_3¶

GeoGraph (DEGMMmmmm or DEGMM.mmmm or DEG.MM.mmmm) (mmmm: decimal minute)

gxapi.FORMAT_GEOGRAPHIC_3 = 12¶

GS_TYPES constants¶

Special use data types. String are indicated by a negative maximum string length (including NULL).

GS_BYTE¶

Signed Byte

gxapi.GS_BYTE = 0¶

GS_USHORT¶

Unsigned Short

gxapi.GS_USHORT = 1¶

GS_SHORT¶

Signed Short

gxapi.GS_SHORT = 2¶

GS_LONG¶

Signed Long

gxapi.GS_LONG = 3¶

GS_FLOAT¶

32-Bit floating point

gxapi.GS_FLOAT = 4¶

GS_DOUBLE¶

64-Bit floating point

gxapi.GS_DOUBLE = 5¶

GS_UBYTE¶

Unsigned byte

gxapi.GS_UBYTE = 6¶

GS_ULONG¶

Unsigned Long

gxapi.GS_ULONG = 7¶

GS_LONG64¶

64-Bit signed long

gxapi.GS_LONG64 = 8¶

GS_ULONG64¶

64-Bit unsigned long

gxapi.GS_ULONG64 = 9¶

GS_FLOAT3D¶

3 x 32-Bit floating point

gxapi.GS_FLOAT3D = 10¶

GS_DOUBLE3D¶

3 x 64-Bit floating point

gxapi.GS_DOUBLE3D = 11¶

GS_FLOAT2D¶

2 x 32-Bit floating point

gxapi.GS_FLOAT2D = 12¶

GS_DOUBLE2D¶

2 x 64-Bit floating point

gxapi.GS_DOUBLE2D = 13¶

GS_MAXTYPE¶

Maximum supported type (GS_DOUBLE2D)

gxapi.GS_MAXTYPE = 13¶

GS_TYPE_DEFAULT¶

Default. Can be used only when a method specifically allows a default type.

gxapi.GS_TYPE_DEFAULT = -32767¶

SYS_CRYPT_KEY constants¶

Special Encryption Keys

SYS_CRYPT_LICENSE_KEY¶

Using the current license key

gxapi.SYS_CRYPT_LICENSE_KEY = '{***LICENSE_KEY***}'¶

SYS_CRYPT_COMPUTER_ID¶

Use the current computer ID

gxapi.SYS_CRYPT_COMPUTER_ID = '{***COMPUTER_ID***}'¶

SYS_CRYPT_GLOBAL_ID¶

Use the non-changing computer ID

gxapi.SYS_CRYPT_GLOBAL_ID = '{***GLOBAL_COMPUTER_ID***}'¶

TIME_FORMAT constants¶

Old Time formats

TIME_FORMAT_COLON¶