### extends 'class_empty.py'
### block ClassImports
# NOTICE: Do not edit anything here, it is generated code
from . import gxapi_cy
from geosoft.gxapi import GXContext, float_ref, int_ref, str_ref
### endblock ClassImports
### block Header
# NOTICE: The code generator will not replace the code in this block
### endblock Header
### block ClassImplementation
# NOTICE: Do not edit anything here, it is generated code
[docs]class GXTPAT(gxapi_cy.WrapTPAT):
"""
GXTPAT class.
The full name of the pattern.
ex: "felsic volcanics"
Code: Short-form of the pattern description. This is the value
which typically appears (for instance) in the "Rock code"
channel in a Wholeplot From-To data group.
ex: "FVOL"
The code is CASE-SENSITIVE.
Label: Text to use as a short-form in labels, graphs etc.
By default, this is the same as the code.
ex: "FVol."
Pattern Attributes: (See DEFAULT.`GXPAT <geosoft.gxapi.GXPAT>` in \\src\\etc for more inforation)
Pattern: The Pattern Index; defined in DEFAULT.`GXPAT <geosoft.gxapi.GXPAT>`, or in the user's
USER.`GXPAT <geosoft.gxapi.GXPAT>` file. If not specified, defaults to 0 (solid fill).
Size: The pattern tile size. If not specified, defaults to 2.0mm.
Density: The tiling density. If not specified, defaults to 1.0.
Thickness: The line thickness in the tile, expressed as a integer
percentage (0-100) of the tile size.
Color: The pattern line work color. If not specified, defaults to black.
Background color: The pattern background color. If not specified, defaults to
transparent (C_ANY_NONE)
Symbols:
Symbol Font The name of the symbol font to use for a given symbol index
Symbol Number Index into the font.
Symbol Rotation: Rotation in degrees CCW.
Symbol Scaling Additional scale factor to apply to symbol size (Default 1.0)
"""
[docs] def __init__(self, handle=0):
super(GXTPAT, self).__init__(GXContext._get_tls_geo(), handle)
[docs] @classmethod
def null(cls):
"""
A null (undefined) instance of `GXTPAT <geosoft.gxapi.GXTPAT>`
:returns: A null `GXTPAT <geosoft.gxapi.GXTPAT>`
:rtype: GXTPAT
"""
return GXTPAT()
[docs] def is_null(self):
"""
Check if this is a null (undefined) instance
:returns: True if this is a null (undefined) instance, False otherwise.
:rtype: bool
"""
return self._internal_handle() == 0
# Miscellaneous
[docs] def add_color(self, code, label, descr, color):
"""
Add a new color to the list
:param code: Code (required - CASE SENSITIVE)
:param label: Label (optional, can be "")
:param descr: Description (optional, can be "")
:param color: Color (use `GXMVIEW.color <geosoft.gxapi.GXMVIEW.color>` to convert to int).
:type code: str
:type label: str
:type descr: str
:type color: int
.. versionadded:: 7.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** The new code must be unique; not in the existing list.
"""
self._add_color(code.encode(), label.encode(), descr.encode(), color)
[docs] @classmethod
def create(cls):
"""
Creates an empty thematic pattern object.
:returns: `GXTPAT <geosoft.gxapi.GXTPAT>` object
:rtype: GXTPAT
.. versionadded:: 7.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = gxapi_cy.WrapTPAT._create(GXContext._get_tls_geo())
return GXTPAT(ret_val)
[docs] def code(self, code):
"""
Find the index of a given thematic pattern
:param code: Pattern code (case sensitive)
:type code: str
:returns: The code index, -1 if not found
:rtype: int
.. versionadded:: 7.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = self._code(code.encode())
return ret_val
[docs] def get_solid_pattern(self, index, code, label, descr, color):
"""
Get solid pattern info from the `GXTPAT <geosoft.gxapi.GXTPAT>`.
:param index: Index
:param code: Returned Code
:param label: Returned Label
:param descr: Returned Description
:param color: Color.
:type index: int
:type code: str_ref
:type label: str_ref
:type descr: str_ref
:type color: int_ref
.. versionadded:: 7.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** Returns the solid color, pattern foreground color, or symbol
color, along with the code, label and description.
"""
code.value, label.value, descr.value, color.value = self._get_solid_pattern(index, code.value.encode(), label.value.encode(), descr.value.encode(), color.value)
[docs] def size(self):
"""
Returns the number of rows (items) in the `GXTPAT <geosoft.gxapi.GXTPAT>` object.
:returns: Number of `GXTPAT <geosoft.gxapi.GXTPAT>` items.
:rtype: int
.. versionadded:: 7.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
"""
ret_val = self._size()
return ret_val
[docs] def load_csv(self, file):
"""
Load thematic patterns from a CSV file
:param file: Thematic Pattern file name
:type file: str
.. versionadded:: 7.0
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** The type of thematic patterns file is recognized from the types
of fields found inside it.
The following fields are identified. Only the "CODE" field is
required, as the "default" thematic pattern is a solid black color.
CODE The pattern code (required by all types - CASE SENSITIVE)
LABEL Longer text identifier to use in legends etc. (up to 31 characters)
DESCRIPTION Much longer text string (up to 127 characters).
COLOR Line color used in patterns, and for solid colors, the color.
If only this field is found (and none below), the pattern file
is assumed to be type TPAT_TYPE_COLOR.
PATTERN Geosoft pattern ID.
PAT_SIZE Pattern tile size, or symbol size (default 2mm)
PAT_DENSITY Pattern tile density (default 1.0)
PAT_THICKNESS Pattern line thickness as % of size (default 5)
BACK_COLOR Background color for the pattern. Also used for symbols
(Default background is transparent).
SYMBFONT Symbol font (e.g. "symbols.gfn")
SYMBNUM Symbol number of the current font
SYMBROT Symbol rotation
SYMBSCL Additional scaling factor applied to the current size
"""
self._load_csv(file.encode())
[docs] def setup_translation_vv(self, ltb, field, vv_values):
"""
Initializes a `GXVV <geosoft.gxapi.GXVV>` used to map `GXTPAT <geosoft.gxapi.GXTPAT>` indices to output values
:param ltb: Table containing `GXTPAT <geosoft.gxapi.GXTPAT>` codes as the key
:param field: Field in `GXLTB <geosoft.gxapi.GXLTB>` with the output values (numeric or string)
:param vv_values: Returned values for each `GXTPAT <geosoft.gxapi.GXTPAT>` index
:type ltb: GXLTB
:type field: int
:type vv_values: GXVV
.. versionadded:: 7.3
**License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
**Note:** The input `GXLTB <geosoft.gxapi.GXLTB>` object should have key values matching the `GXTPAT <geosoft.gxapi.GXTPAT>` codes.
Whether the matches are case sensitive or not is dependent on how the
`GXLTB <geosoft.gxapi.GXLTB>` oject was created (see ltb.h).
The `GXLTB <geosoft.gxapi.GXLTB>` field values are converted to the output `GXVV <geosoft.gxapi.GXVV>` type.
"""
self._setup_translation_vv(ltb, field, vv_values)
### endblock ClassImplementation
### block ClassExtend
# NOTICE: The code generator will not replace the code in this block
### endblock ClassExtend
### block Footer
# NOTICE: The code generator will not replace the code in this block
### endblock Footer