GXLMSG class

class GXLMSG(handle=0)[source]

GXLMSG class.

Message class methods.

__init__(handle=0)[source]
classmethod goto_line(line)[source]

Sends a ‘go to line’ message

Parameters:

line (str) – Line name

Added in version 2022.2.0.

License: Geosoft End-User License

classmethod goto_line_fid(line, fiducial)[source]

Sends a ‘go to line and fiducial’ message

Parameters:

  • line (str) – Line name

  • fiducial (float) – Fiducial value

Added in version 2026.1.0.

License: Geosoft End-User License

classmethod goto_point(x, y, z, ipj)[source]

Sends a move cursor message

Parameters:

  • x (float) – X location

  • y (float) – Y location

  • z (float) – Z location

  • ipj (GXIPJ) – GXIPJ (if (GXIPJ)0, default coordinate system)

Added in version 5.0.7.

License: Geosoft End-User 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

classmethod null()[source]

A null (undefined) instance of GXLMSG

Returns:

A null GXLMSG

Return type:

GXLMSG

classmethod view_area(x0, y0, x1, y1, ipj)[source]

Sends a view area message

Parameters:

  • x0 (float) – X0 location

  • y0 (float) – Y0 location

  • x1 (float) – X1 location

  • y1 (float) – Y1 location

  • ipj (GXIPJ) – GXIPJ (if (GXIPJ)0, default coordinate system)

Added in version 5.0.7.

License: Geosoft End-User License