GXREG class

class GXREG(handle=0)[source]

GXREG class.

The GXREG class is used for storing and retrieving named variables. Many classes contain GXREG objects for storing information particular to the class. The GXMETA class supersedes the GXREG class and is gradually replacing the use of the GXREG class in newer applications.

__init__(handle=0)[source]
clear()[source]

Clears all the parameters in a GXREG object

New in version 5.0.

License: Geosoft Open License

copy(srce)[source]

Copy

Parameters:

srce (GXREG) – Source

New in version 5.0.

License: Geosoft Open License

classmethod create(l_parm_length)[source]

Create a handle to a GXREG object

Parameters:

l_parm_length (int) – Maximum size of “parameter=setting” string.

Returns:

GXREG Object

Return type:

GXREG

New in version 5.0.

License: Geosoft Open License

classmethod create_s(bf)[source]

Create a handle to a GXREG object from a GXBF

Parameters:

bf (GXBF) – GXBF handle for file containing serialized GXREG

Returns:

GXREG Object

Return type:

GXREG

New in version 5.0.

License: Geosoft Open License

entries()[source]

Get the number of parms in a GXREG object

Returns:

Number of parms in a GXREG object.

Return type:

int

New in version 5.1.1.

License: Geosoft Open License

get(parm, data)[source]

Gets a string for a specified parameter in the GXREG object

Parameters:

  • parm (str) – Name of the parameter

  • data (str_ref) – String to get

New in version 5.0.

License: Geosoft Open License

get_double(parm, data)[source]

Gets an real for a specified parameter in the GXREG object

Parameters:

  • parm (str) – Name of the parameter

  • data (float_ref) – Real to get

New in version 5.0.

License: Geosoft Open License

Note: If parameter is not present in GXREG, rDUMMY is returned.

get_int(parm, data)[source]

Gets an int for a specified parameter in the GXREG object

Parameters:

  • parm (str) – Name of the parameter

  • data (int_ref) – Int to get

New in version 5.0.

License: Geosoft Open License

Note: If parameter is not present in GXREG, iDUMMY is returned.

get_maker_xml(parm)[source]

Gets the MAKER handle from the REG object.

Parameters:

parm (str) – XML file name

New in version 9.7.

License: Geosoft Open License

get_one(loc, parm, data)[source]

Gets n-th entry of the GXREG object

Parameters:

  • loc (int) – Sequential number of GXREG entry

  • parm (str_ref) – String to put parameter name

  • data (str_ref) – String to put data into.

New in version 5.1.1.

License: Geosoft Open License

is_null()[source]

Check if this is a null (undefined) instance

Returns:

True if this is a null (undefined) instance, False otherwise.

Return type:

bool

load_ini(ini)[source]

Load a registry from an INI file.

Parameters:

ini (str) – INI file name

New in version 5.0.

License: Geosoft Open License

Note: Items are loaded into the GXREG in the format “GROUP.ITEM”.

match_string(parm, data)[source]

Replace a string with reg settings.

Parameters:

  • parm (str) – String to Replace

  • data (str_ref) – Output Buffer

New in version 5.0.

License: Geosoft Open License

merge(srce, type)[source]

Merge

Parameters:

New in version 5.0.

License: Geosoft Open License

classmethod null()[source]

A null (undefined) instance of GXREG

Returns:

A null GXREG

Return type:

GXREG

save_ini(ini)[source]

Save a GXREG to an INI file.

Parameters:

ini (str) – INI file name

New in version 5.0.

License: Geosoft Open License

Note: Only GXREG parameters in the form “GROUP.ITEM” are dumped to the INI file, because they match the INI format which groups items under [GROUP] headings. Single-word items (without a separating period) are skipped.

serial(bf)[source]

Serialize a GXREG object into a file.

Parameters:

bf (GXBF) – GXBF to serialize GXREG into

New in version 5.0.

License: Geosoft Open License

set(parm, data)[source]

Sets a string parameter in the GXREG object

Parameters:

  • parm (str) – Name of the parameter

  • data (str) – String to set it to An empty string sets the setting to an empty string, but does NOT remove the parameter from the GXREG.

New in version 5.0.

License: Geosoft Open License

Note: To remove a parameter completely, use one of the following:

set_int); or set_double);

set_double(parm, p3)[source]

Sets an real for a specified parameter in the GXREG object

Parameters:

  • parm (str) – Name of the parameter

  • p3 (float) – Real to set, rDUMMY to remove the parameter

New in version 5.0.

License: Geosoft Open License

set_int(parm, data)[source]

Sets an int for a specified parameter in the GXREG object

Parameters:

  • parm (str) – Name of the parameter

  • data (int) – Int to set, iDUMMY to remove the parameter

New in version 5.0.

License: Geosoft Open License

REG_MERGE constants

GXREG merge options

REG_MERGE_REPLACE

Replace Values

gxapi.REG_MERGE_REPLACE = 0
REG_MERGE_ADD

Only append values

gxapi.REG_MERGE_ADD = 1