.. _GXSYS: GXSYS class ================================== .. autoclass:: geosoft.gxapi.GXSYS :members: .. _ARC_LICENSE: ARC_LICENSE constants ----------------------------------------------------------------------- :: ArcGIS platform types .. autoattribute:: geosoft.gxapi.ARC_LICENSE_ENGINENOTPRESENT :: The Engine or any qualifying ArcGIS product is missing .. autoattribute:: geosoft.gxapi.ARC_LICENSE_DESKTOPENGINE :: Desktop Engine .. autoattribute:: geosoft.gxapi.ARC_LICENSE_ARCVIEW :: ArcView .. autoattribute:: geosoft.gxapi.ARC_LICENSE_ARCEDITOR :: ArcEditor .. autoattribute:: geosoft.gxapi.ARC_LICENSE_ARCINFO :: ArcInfo .. autoattribute:: geosoft.gxapi.ARC_LICENSE_ARCSERVER :: ArcServer .. _GEO_DIRECTORY: GEO_DIRECTORY constants ----------------------------------------------------------------------- :: Geosoft directory defines .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_NONE :: None .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_GEOSOFT :: Geosoft\ .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_BIN :: Geosoft\bin .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_GER :: Geosoft\ger .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_OMN :: Geosoft\omn .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_TBL :: Geosoft\tbl .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_FONTS :: Geosoft\fonts .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_GX :: Geosoft\gx .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_GS :: Geosoft\gs .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_APPS :: Geosoft\apps .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_ETC :: Geosoft\user\etc and then Geosoft\etc .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_HLP :: Geosoft\hlp .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_USER_CSV :: Geosoft\user\csv .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_USER_LIC :: Geosoft\user\lic .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_USER_INI :: Geosoft\user\ini .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_USER_TEMP :: Geosoft\temp (or where the user put it) .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_USER_ETC :: Geosoft\user\etc .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_IMG :: Geosoft\img .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_BAR :: Geosoft\bar .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_MAPTEMPLATE :: Geosoft\maptemplate .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_USER_MAPTEMPLATE :: Geosoft\user\maptemplate .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_PYGX :: Geosoft\pygx .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_USER_PYGX :: Geosoft\user\pygx .. autoattribute:: geosoft.gxapi.GEO_DIRECTORY_USER_GX :: Geosoft\user\gx .. _REG_DOMAIN: REG_DOMAIN constants ----------------------------------------------------------------------- :: Registry key domains .. autoattribute:: geosoft.gxapi.REG_DOMAIN_MACHINE :: same as HKEY_LOCAL_MACHINE in Windows .. autoattribute:: geosoft.gxapi.REG_DOMAIN_USER :: same as HKEY_CURRENT_USER in Windows .. _SHELL_EXECUTE: SHELL_EXECUTE constants ----------------------------------------------------------------------- :: Shell execute defines .. autoattribute:: geosoft.gxapi.SW_HIDE .. autoattribute:: geosoft.gxapi.SW_SHOWNORMAL .. autoattribute:: geosoft.gxapi.SW_SHOWMINIMIZED .. autoattribute:: geosoft.gxapi.SW_SHOWMAXIMIZED .. autoattribute:: geosoft.gxapi.SW_SHOWNOACTIVATE .. autoattribute:: geosoft.gxapi.SW_SHOW .. autoattribute:: geosoft.gxapi.SW_MINIMIZE .. autoattribute:: geosoft.gxapi.SW_SHOWMINNOACTIVE .. autoattribute:: geosoft.gxapi.SW_SHOWNA .. autoattribute:: geosoft.gxapi.SW_RESTORE .. autoattribute:: geosoft.gxapi.SW_SHOWDEFAULT .. autoattribute:: geosoft.gxapi.SW_FORCEMINIMIZE .. _SYS_DIR: SYS_DIR constants ----------------------------------------------------------------------- :: SYS Directory locations .. autoattribute:: geosoft.gxapi.SYS_DIR_LOCAL :: is the workspace working directory .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT :: is the geosoft installation directory (read-only) .. autoattribute:: geosoft.gxapi.SYS_DIR_USER :: is the geosoft installation directory that contains user read/write files. .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOTEMP :: Geosoft Temp folder .. autoattribute:: geosoft.gxapi.SYS_DIR_WINDOWS :: Windows folder .. autoattribute:: geosoft.gxapi.SYS_DIR_SYSTEM :: Windows SYSTEM folder .. autoattribute:: geosoft.gxapi.SYS_DIR_LICENSE :: Where the license file is stored .. autoattribute:: geosoft.gxapi.SYS_DIR_RESOURCEFILES :: User RESOURCEFILES Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_BAR :: BAR folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_BIN :: BIN folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_CSV :: CSV folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_CSV_ALIASES :: CSV ALIASES folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_DATA :: DATA folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_DBG :: DBG folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_ENCRYPTEDFILES :: Encrypted Files folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_ETC :: ETC folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_FONTS :: FONTS folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_GER :: GER folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_GS :: GS folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_GX :: GX folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_HLP :: HLP folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_IMG :: IMG folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_INI :: INI folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_MAPTEMPLATE :: MAPTEMPLATE folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_OMN :: OMN folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_PAGE :: PAGE folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_SCHEMA :: SCHEMA folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_SPEC_INI :: SPEC INI older .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_STYLESHEETS :: STYLE SHEETS folder .. autoattribute:: geosoft.gxapi.SYS_DIR_GEOSOFT_TBL :: TBL folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_CSV :: User CSV Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_ETC :: User ETC Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_GS :: User GS Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_HLP :: User HLP Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_INI :: User INI Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_LIC :: User LIC Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_MAPTEMPLATE :: User MAPTEMPLATE Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_OMN :: User OMN Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_BAR :: User BAR Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_IMG :: User IMG Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_STACKS :: User STACKS Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_TEMP :: User TEMP Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_SERVICES :: User SERVICES Folder .. autoattribute:: geosoft.gxapi.SYS_DIR_USER_STYLESHEETS :: User STYLESHEETS Folder .. _SYS_FONT: SYS_FONT constants ----------------------------------------------------------------------- :: Font types .. autoattribute:: geosoft.gxapi.SYS_FONT_GFN :: Geosoft GFN fonts. .. autoattribute:: geosoft.gxapi.SYS_FONT_TT :: available TrueType fonts .. _SYS_INFO: SYS_INFO constants ----------------------------------------------------------------------- :: System information .. autoattribute:: geosoft.gxapi.SYS_INFO_VERSION_MAJOR .. autoattribute:: geosoft.gxapi.SYS_INFO_VERSION_MINOR .. autoattribute:: geosoft.gxapi.SYS_INFO_VERSION_SP .. autoattribute:: geosoft.gxapi.SYS_INFO_BUILD_NUMBER .. autoattribute:: geosoft.gxapi.SYS_INFO_BUILD_LABEL .. autoattribute:: geosoft.gxapi.SYS_INFO_VERSION_LABEL .. autoattribute:: geosoft.gxapi.SYS_INFO_PRODUCTNAME .. autoattribute:: geosoft.gxapi.SYS_INFO_SERVERNAME .. autoattribute:: geosoft.gxapi.SYS_INFO_LEGALCOPYRIGHT .. autoattribute:: geosoft.gxapi.SYS_INFO_REGISTRY .. autoattribute:: geosoft.gxapi.SYS_INFO_REGISTRY_ENVIRONMENT .. autoattribute:: geosoft.gxapi.SYS_INFO_REGISTRY_SUPPORT .. autoattribute:: geosoft.gxapi.SYS_INFO_REGISTRY_INTERAPP .. autoattribute:: geosoft.gxapi.SYS_INFO_OIS_REGISTRY .. autoattribute:: geosoft.gxapi.SYS_INFO_TEST_REGISTRY .. _SYS_LINEAGE_SOURCE: SYS_LINEAGE_SOURCE constants ----------------------------------------------------------------------- :: Type of lineage sources .. autoattribute:: geosoft.gxapi.SYS_LINEAGE_SOURCE_MAP .. autoattribute:: geosoft.gxapi.SYS_LINEAGE_SOURCE_MXD .. autoattribute:: geosoft.gxapi.SYS_LINEAGE_SOURCE_DB .. autoattribute:: geosoft.gxapi.SYS_LINEAGE_SOURCE_MAPTEMPLATE .. autoattribute:: geosoft.gxapi.SYS_LINEAGE_SOURCE_GRID .. autoattribute:: geosoft.gxapi.SYS_LINEAGE_SOURCE_VOXEL .. _SYS_MENU_CLEAR: SYS_MENU_CLEAR constants ----------------------------------------------------------------------- :: Font types .. autoattribute:: geosoft.gxapi.SYS_MENU_CLEAR_ALL :: Clear all menus excluding the coremenus.omn but including any default menus specified in the settings (these will not come back in this project). .. autoattribute:: geosoft.gxapi.SYS_MENU_CLEAR_DEFAULT :: Clear all menus excluding the coremenus.omn but reload any default menus specified in the settings (essentially this is a refresh back to the default state again). .. _SYS_PATH: SYS_PATH constants ----------------------------------------------------------------------- :: Get specific Geosoft paths. The path name will have a directory separator at the end. .. autoattribute:: geosoft.gxapi.SYS_PATH_LOCAL :: is the workspace working directory .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT :: is the geosoft installation directory (read-only) .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER :: is the geosoft installation directory that contains user read/write files. .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOTEMP :: Geosoft Temp folder .. autoattribute:: geosoft.gxapi.SYS_PATH_WINDOWS :: Windows folder .. autoattribute:: geosoft.gxapi.SYS_PATH_SYSTEM :: System folder .. autoattribute:: geosoft.gxapi.SYS_PATH_LICENSE :: Where the license file is stored .. autoattribute:: geosoft.gxapi.SYS_PATH_RESOURCEFILES :: User RESOURCEFILES Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_BAR :: BAR folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_BIN :: BIN folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_CSV :: CSV folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_CSV_ALIASES :: CSV ALIASES folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_DATA :: DATA folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_DBG :: DBG folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_ENCRYPTEDFILES :: Encrypted Files folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_ETC :: ETC folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_FONTS :: FONTS folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_GER :: GER folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_GS :: GS folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_PYGX :: PYGX folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_GX :: GX folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_HLP :: HLP folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_IMG :: IMG folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_INI :: INI folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_MAPTEMPLATE :: MAPTEMPLATE folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_OMN :: OMN folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_PAGE :: PAGE folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_SCHEMA :: SCHEMA folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_SPEC_INI :: SPEC INI older .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_STYLESHEETS :: STYLE SHEETS folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_TBL :: TBL folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_CSV :: User CSV Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_ETC :: User ETC Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_GS :: User GS Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_GX :: User GX Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_PYGX :: User PYGX Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_HLP :: User HLP Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_INI :: User INI Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_LIC :: User LIC Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_MAPTEMPLATE :: User MAPTEMPLATE Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_OMN :: User OMN Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_STACKS :: User STACKS Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_GEOSOFT_USER_TEMP :: User TEMP Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_USER_SERVICES :: User SERVICES Folder .. autoattribute:: geosoft.gxapi.SYS_PATH_USER_STYLESHEETS :: User STYLESHEETS Folder .. _SYS_RUN_DISPLAY: SYS_RUN_DISPLAY constants ----------------------------------------------------------------------- :: Windows Display Options Determine how applications are started. These options are not yet implemented. .. autoattribute:: geosoft.gxapi.SYS_RUN_DISPLAY_WINDOW :: In a window (default) .. autoattribute:: geosoft.gxapi.SYS_RUN_DISPLAY_MINIMIZE :: Maximized .. autoattribute:: geosoft.gxapi.SYS_RUN_DISPLAY_FULLSCREEN :: Full Screen .. _SYS_RUN_HOLD: SYS_RUN_HOLD constants ----------------------------------------------------------------------- :: DOS Console Options These options determine if and when the DOS/EXE console window is held. These options only work on DOS and EXE programs. .. autoattribute:: geosoft.gxapi.SYS_RUN_HOLD_NEVER :: Don't wait (Default) .. autoattribute:: geosoft.gxapi.SYS_RUN_HOLD_ONERROR :: Hold the screen if there is an error .. autoattribute:: geosoft.gxapi.SYS_RUN_HOLD_ALWAYS :: Always hold the screen .. _SYS_RUN_TYPE: SYS_RUN_TYPE constants ----------------------------------------------------------------------- :: Type of application to run .. autoattribute:: geosoft.gxapi.SYS_RUN_TYPE_DOS :: Things such as .BAT files, copy commands, etc. (A console window is created) .. autoattribute:: geosoft.gxapi.SYS_RUN_TYPE_EXE :: Any program (.EXE) (a console window is created) .. autoattribute:: geosoft.gxapi.SYS_RUN_TYPE_WINDOWS :: Windows applications that do not require a console window. .. _SYS_RUN_WIN: SYS_RUN_WIN constants ----------------------------------------------------------------------- :: Windows Options Should we wait for the application to finish or should we continue executing. If you wait for another program, Oasis montaj will not redraw or respond. We always wait for EXE and DOS programs. .. autoattribute:: geosoft.gxapi.SYS_RUN_WIN_NOWAIT :: Never wait (default) .. autoattribute:: geosoft.gxapi.SYS_RUN_WIN_WAIT :: Always wait .. _SYS_SEARCH_PATH: SYS_SEARCH_PATH constants ----------------------------------------------------------------------- :: Find File define .. autoattribute:: geosoft.gxapi.FIND_LOCAL_GEOSOFT :: Local and then Geosoft directory .. autoattribute:: geosoft.gxapi.FIND_GEOSOFT :: Geosoft directory .. autoattribute:: geosoft.gxapi.FIND_LOCAL :: Local directory .. autoattribute:: geosoft.gxapi.FIND_SHORT :: Make the name short (FLAG that is added on) .. _SYS_ENCRYPTION_KEY: SYS_ENCRYPTION_KEY constants ----------------------------------------------------------------------- :: How to encrypt a string. Determines the portability of the encrypted string. .. autoattribute:: geosoft.gxapi.SYS_ENCRYPTION_KEY_GEOSOFT_ID :: Encrypt string to currently signed-in user. The string can be decrypted by the same user on any machine. .. autoattribute:: geosoft.gxapi.SYS_ENCRYPTION_KEY_GLOBAL_ID :: Encrypt string to current machine. The string can be decrypted by any user on the same machine.