GXGEOSTRING class

class geosoft.gx.GXGEOSTRING

The GEOSTRING class is used to read information stored in Geostring files (*.geosoft_string). Geosoft geostrings are 3D vector files that store digitized interpretations drawn on section maps. Both polygon and polyline features can be stored in the same file. This API currently only provides read access, but read/write support could be added in the future.            

get_all_shapes((GXLST)arg1) → None:

Get the all shapes

Parameters:arg1 (geosoft.gx.GXLST) – LST to fill Returns:Nothing Return type:None

New in version 8.4.0.

get_feature_properties((str)arg1, (str_ref)arg2, (str_ref)arg3, (bool_ref)arg4, (int_ref)arg5, (float_ref)arg6, (float_ref)arg7, (float_ref)arg8, (int_ref)arg9, (int_ref)arg10, (int_ref)arg11, (float_ref)arg12, (float_ref)arg13, (int_ref)arg14) → None:

Get a feature's properties

Parameters:

• arg1 (str) – Feature GUID
• arg2 (geosoft.gx.str_ref) – Name
• arg3 (geosoft.gx.str_ref) – Description
• arg4 (geosoft.gx.bool_ref) – bool indicating if feature is decribed by polygons (shapes are polylines if not set)
• arg5 (geosoft.gx.int_ref) – The fill pattern number (see PatNumber_MVIEW)
• arg6 (geosoft.gx.float_ref) – The fill pattern size (see PatSize_MVIEW)
• arg7 (geosoft.gx.float_ref) – The fill pattern thickness (see PatThick_MVIEW)
• arg8 (geosoft.gx.float_ref) – The fill pattern density (see PatDensity_MVIEW)
• arg9 (geosoft.gx.int_ref) – The fill color (an MVIEW color)
• arg10 (geosoft.gx.int_ref) – The fill background color (an MVIEW color)
• arg11 (geosoft.gx.int_ref) – The line style (see LineStyle_MVIEW)
• arg12 (geosoft.gx.float_ref) – The line thickness (see LineThick_MVIEW)
• arg13 (geosoft.gx.float_ref) – The dash pattern pitch (see LineStyle_MVIEW)
• arg14 (geosoft.gx.int_ref) – The line color (an MVIEW color)

Returns:

Nothing

Return type:

None

New in version 8.4.0.

get_features((GXLST)arg1) → None:

Get the features

Parameters:arg1 (geosoft.gx.GXLST) – LST to fill Returns:Nothing Return type:None

New in version 8.4.0.

Note:

List items are returned with feature GUID in name and feature name in value.

get_ipj((GXIPJ)arg1) → None:

Get the coordinate system of the Geostring.

Parameters:arg1 (geosoft.gx.GXIPJ) – IPJ in which to place the Geostring coordinate system Returns:Nothing Return type:None

New in version 8.4.0.

get_section_properties((str)arg1, (str_ref)arg2, (str_ref)arg3, (int_ref)arg4, (float_ref)arg5, (float_ref)arg6, (float_ref)arg7, (float_ref)arg8, (float_ref)arg9, (float_ref)arg10, (float_ref)arg11, (float_ref)arg12, (float_ref)arg13) → None:

Get a section's properties

Parameters:

• arg1 (str) – Section GUID
• arg2 (geosoft.gx.str_ref) – Name
• arg3 (geosoft.gx.str_ref) – ContainerName
• arg4 (geosoft.gx.int_ref) – SECTION_ORIENTATION constants
• arg5 (geosoft.gx.float_ref) – Easting
• arg6 (geosoft.gx.float_ref) – Northing
• arg7 (geosoft.gx.float_ref) – Elevation
• arg8 (geosoft.gx.float_ref) – Azimuth
• arg9 (geosoft.gx.float_ref) – Swing
• arg10 (geosoft.gx.float_ref) – A in the scalar equation of best-fit plane describing the section
• arg11 (geosoft.gx.float_ref) – B in the scalar equation of best-fit plane describing the section
• arg12 (geosoft.gx.float_ref) – C in the scalar equation of best-fit plane describing the section
• arg13 (geosoft.gx.float_ref) – D in the scalar equation of best-fit plane describing the section

Returns:

Nothing

Return type:

None

New in version 8.4.0.

get_sections((GXLST)arg1) → None:

Get the sections

Parameters:arg1 (geosoft.gx.GXLST) – LST to fill Returns:Nothing Return type:None

New in version 8.4.0.

Note:

List items are returned with section GUID in name and section name in value.

get_shape_properties((str)arg1, (str_ref)arg2, (str_ref)arg3, (GXVV)arg4, (GXVV)arg5, (GXVV)arg6) → None:

Get a shape's properties

Parameters:

• arg1 (str) – Shape GUID
• arg2 (geosoft.gx.str_ref) – Feature GUID
• arg3 (geosoft.gx.str_ref) – Section GUID
• arg4 (geosoft.gx.GXVV) – Vertices X location
• arg5 (geosoft.gx.GXVV) – Vertices Y location
• arg6 (geosoft.gx.GXVV) – Vertices Z location

Returns:

Nothing

Return type:

None

New in version 8.4.0.

get_shapes_for_feature((str)arg1, (GXLST)arg2) → None:

Get all shapes linked to a specific feature

Parameters:

• arg1 (str) – Feature GUID
• arg2 (geosoft.gx.GXLST) – LST to fill

Returns:

Nothing

Return type:

None

New in version 8.4.0.

get_shapes_for_feature_and_section((str)arg1, (str)arg2, (GXLST)arg3) → None:

Get all shapes linked to a specific feature and section

Parameters:

• arg1 (str) – Feature GUID
• arg2 (str) – Section GUID
• arg3 (geosoft.gx.GXLST) – LST to fill

Returns:

Nothing

Return type:

None

New in version 8.4.0.

get_shapes_for_section((str)arg1, (GXLST)arg2) → None:

Get all shapes linked to a specific section

Parameters:

• arg1 (str) – Section GUID
• arg2 (geosoft.gx.GXLST) – LST to fill

Returns:

Nothing

Return type:

None

New in version 8.4.0.

is_null() → bool

Check if the instance of geosoft.gx.GXGEOSTRING is null (undefined)

Returns:True if this is a null instance of geosoft.gx.GXGEOSTRING, False otherwise. Return type:bool`

static null() → GXGEOSTRING

A null (undefined) instance of geosoft.gx.GXGEOSTRING

Returns:A null geosoft.gx.GXGEOSTRING Return type:geosoft.gx.GXGEOSTRING

static open((GXContext)ctx, (str)arg1, (int)arg2) → GXGEOSTRING:

Open a Geostring file

Parameters:

• ctx (geosoft.gx.GXContext) – The GX execution context
• arg1 (str) – Geostring file name
• arg2 (int) – GEOSTRING_OPEN constants

Returns:

GEOSTRING Object

Return type:

geosoft.gx.GXGEOSTRING

New in version 8.4.0.

GEOSTRING_OPEN constants

Open Modes

gx.GEOSTRING_OPEN_READ = 0

gx.GEOSTRING_OPEN_READWRITE = 1

SECTION_ORIENTATION constants

Section orientation types

gx.SECTION_ORIENTATION_UNKNOWN = 0

gx.SECTION_ORIENTATION_PLAN = 1

gx.SECTION_ORIENTATION_SECTION = 2

gx.SECTION_ORIENTATION_CROOKED = 2

gx.SECTION_ORIENTATION_GMSYS = 2