GXGEOSOFT class¶
This is not a class but a collection of global defines. It is used by all functions.
DATE_FORMAT constants¶
Old Date formats
-
gxapi.DATE_FORMAT_YYYYMMDD= 1¶
Standard Date (YYYY/MM/DD, YY/MM/DD, YYYYMMDD or YYMMDD, space or / delimited)
-
gxapi.DATE_FORMAT_DDMMYYYY= 2¶
Date (DD/MM/YYYY or DD/MM/YY century 20 if YY>50, DISC compliant)
-
gxapi.DATE_FORMAT_MMDDYYYY= 3¶
Date (MM/DD/YYYY or MM/DD/YY century 19)
GEO_DUMMY constants¶
Special numbers indicating NULLL
-
gxapi.iDUMMY= -2147483647¶
Integer Dummy (-2147483647)
-
gxapi.rDUMMY= -1e+32¶
Floating Point Dummy (-1.0E32)
GEO_FULL_LIMITS constants¶
Data ranges of all Geosoft types
-
gxapi.GS_S1MX= 127¶
(signed char ) 127
-
gxapi.GS_S1MN= -126¶
(signed char ) -126
-
gxapi.GS_S1DM= -127¶
(signed char ) -127
-
gxapi.GS_U1MX= 254¶
(unsigned char ) 254U
-
gxapi.GS_U1MN= 0¶
(unsigned char ) 0U
-
gxapi.GS_U1DM= 255¶
(unsigned char ) 255U
-
gxapi.GS_S2MX= 32767¶
(short ) 32767
-
gxapi.GS_S2MN= -32766¶
(short ) -32766
-
gxapi.GS_S2DM= -32767¶
(short ) -32767
-
gxapi.GS_U2MX= 65534¶
(unsigned short) 65534U
-
gxapi.GS_U2MN= 0¶
(unsigned short) 0U
-
gxapi.GS_U2DM= 65535¶
(unsigned short) 65535U
-
gxapi.GS_S4MX= 2147483647¶
2147483647L
-
gxapi.GS_S4MN= -2147483646¶
-2147483646L
-
gxapi.GS_S4DM= -2147483647¶
-2147483647L
-
gxapi.GS_U4MX= 4294967294¶
(unsigned long ) 0xFFFFFFFE
-
gxapi.GS_U4MN= 0¶
(unsigned long ) 0x00000000
-
gxapi.GS_U4DM= 4294967295¶
(unsigned long ) 0xFFFFFFFF
-
gxapi.GS_S8MX= 9223372036854775807¶
(__GS_INT64 ) 0x7FFFFFFFFFFFFFFF
-
gxapi.GS_S8MN= -9223372036854775807¶
(__GS_INT64 ) 0x8000000000000001
-
gxapi.GS_S8DM= -9223372036854775808¶
(__GS_INT64 ) 0x8000000000000000
-
gxapi.GS_U8MX= 18446744073709551614¶
(__GS_UINT64 ) 0xFFFFFFFFFFFFFFFE
-
gxapi.GS_U8MN= 0¶
(__GS_UINT64 ) 0x0000000000000000
-
gxapi.GS_U8DM= 18446744073709551615¶
(__GS_UINT64 ) 0xFFFFFFFFFFFFFFFF
-
gxapi.GS_R4MX= 1.0000000331813535e+32¶
(float ) 1.0E32 (In C these must be declared as external constants:)
-
gxapi.GS_R4MN= -9.00000010520405e+31¶
(float ) -0.9E32 const float r4min=(float)-0.9E32,
-
gxapi.GS_R4DM= -1.0000000331813535e+32¶
(float ) -1.0E32 r4max=(float)1.0E32,
r4dum=(float)-1.0E32;
-
gxapi.GS_R8MX= 1e+32¶
(double ) 1.0E32
-
gxapi.GS_R8MN= -9e+31¶
(double ) -0.9E32
-
gxapi.GS_R8DM= -1e+32¶
(double ) -1.0E32
-
gxapi.GS_R4EPSILON= 1.000000023742228e-32¶
(float ) 1.0E-32
-
gxapi.GS_R8EPSILON= 1e-32¶
(double ) 1.0E-32
GEO_LIMITS constants¶
Data ranges of numbers
-
gxapi.iMIN= -2147483646¶
Smallest Integer (-2147483646)
-
gxapi.iMAX= 2147483647¶
Largest Integer (2147483647)
-
gxapi.rMIN= -9e+31¶
Smallest Floating Point (-0.9E32)
-
gxapi.rMAX= 1e+32¶
Largest Floating Point (1.0E32)
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.
-
gxapi.STR_DEFAULT= 128¶
Default Size for almost everything (128 characters)
-
gxapi.STR_DEFAULT_SHORT= 64¶
Default Size for a short string (64 characters)
-
gxapi.STR_DEFAULT_LONG= 1024¶
Default Size for a long string (1024 characters)
-
gxapi.STR_ERROR= 2048¶
Default Size for an error string (2048 characters)
-
gxapi.STR_VERY_LONG= 16384¶
Default Size for a long string (16384 characters)
-
gxapi.STR_VIEW= 2080¶
Name of a View (2080)
-
gxapi.STR_GROUP= 1040¶
Name of a Group (1040)
-
gxapi.STR_VIEW_GROUP= 2080¶
Combined View/Group Name (2080)
-
gxapi.STR_FILE= 1040¶
Name of a file (1040)
-
gxapi.STR_MULTI_FILE= 16384¶
Name of multiple files (16384)
-
gxapi.STR_DB_SYMBOL= 64¶
Name of database symbol (64)
-
gxapi.STR_GXF= 160¶
Size of strings for GXF projection info (160).
-
gxapi.STR_MAX_PATH= 1040¶
Maximum path length (1040)
-
gxapi.STR_MULTI_PATH= 16384¶
Multi-file path (16384)
-
gxapi.GS_MAX_PATH= 1040¶
Same as STR_FILE
-
gxapi.GS_MULTI_PATH= 16384¶
Same as STR_MULTI_FILE
GEO_VAR constants¶
Variable types.
Use -X for strings of X length
-
gxapi.GS_INT= 0¶
Integer (long)
-
gxapi.GS_REAL= 1¶
Floating Point (double)
GS_FORMATS constants¶
Special use data types. String are indicated by a
negative maximum string length (including NULL).
-
gxapi.FORMAT_DECIMAL= 0¶
Standard numbers (-134.534)
-
gxapi.FORMAT_SIG_DIG= 5¶
Decimals imply number of significant digits
-
gxapi.FORMAT_EXP= 1¶
Exponential notation (-1.345e45)
-
gxapi.FORMAT_TIME_COLON= 2¶
Standard Time (HH:MM:SS.SSSS)
-
gxapi.FORMAT_TIME_HMS= 8¶
Time (HH.MMSSSSSSS)
-
gxapi.FORMAT_TIME_HHMMSS= 9¶
Time (HHMMSS)
-
gxapi.FORMAT_DATE_YYYYMMDD= 3¶
Standard Date (YYYY/MM/DD, YY/MM/DD, YYYYMMDD or YYMMDD, space or / delimited)
-
gxapi.FORMAT_DATE_DDMMYYYY= 6¶
Date (DD/MM/YYYY or DD/MM/YY century 20 if YY>50, DISC compliant)
-
gxapi.FORMAT_DATE_MMDDYYYY= 7¶
Date (MM/DD/YYYY or MM/DD/YY century 19)
-
gxapi.FORMAT_GEOGRAPHIC= 4¶
Standard Geographical (DEG.MM.SS.SSS)
-
gxapi.FORMAT_GEOGRAPHIC_1= 10¶
GeoGraph (DEG:MM:SS.SSS)
-
gxapi.FORMAT_GEOGRAPHIC_2= 11¶
GeoGraph (DEG.MMSSSSS)
-
gxapi.FORMAT_GEOGRAPHIC_3= 12¶
GeoGraph (DEGMMmmmm or DEGMM.mmmm or DEG.MM.mmmm) (mmmm: decimal minute)
GS_TYPES constants¶
Special use data types. String are indicated by a
negative maximum string length (including NULL).
-
gxapi.GS_BYTE= 0¶
Signed Byte
-
gxapi.GS_USHORT= 1¶
Unsigned Short
-
gxapi.GS_SHORT= 2¶
Signed Short
-
gxapi.GS_LONG= 3¶
Signed Long
-
gxapi.GS_FLOAT= 4¶
32-Bit floating point
-
gxapi.GS_DOUBLE= 5¶
64-Bit floating point
-
gxapi.GS_UBYTE= 6¶
Unsigned byte
-
gxapi.GS_ULONG= 7¶
Unsigned Long
-
gxapi.GS_LONG64= 8¶
64-Bit signed long
-
gxapi.GS_ULONG64= 9¶
64-Bit unsigned long
-
gxapi.GS_FLOAT3D= 10¶
3 x 32-Bit floating point
-
gxapi.GS_MAXTYPE= 10¶
Maximum supported type (GS_FLOAT3D)
-
gxapi.GS_TYPE_DEFAULT= -32767¶
Default. Can be used only when a method specifically allows a default type.
SYS_CRYPT_KEY constants¶
Special Encryption Keys
-
gxapi.SYS_CRYPT_LICENSE_KEY= '{***LICENSE_KEY***}'¶
Using the current license key
-
gxapi.SYS_CRYPT_COMPUTER_ID= '{***COMPUTER_ID***}'¶
Use the current computer ID
-
gxapi.SYS_CRYPT_GLOBAL_ID= '{***GLOBAL_COMPUTER_ID***}'¶
Use the non-changing computer ID