Source code for geosoft.gxapi.GXMAPL

#  Copyright (c) 2024 Bentley Systems, Incorporated. All rights reserved.
#  Copyright (c) 2024 Bentley Systems, Incorporated. All rights reserved.
#  Copyright (c) 2024 Bentley Systems, Incorporated. All rights reserved.
### 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 GXMAPL(gxapi_cy.WrapMAPL):
    """
    GXMAPL class.

    The `GXMAPL <geosoft.gxapi.GXMAPL>` class is the interface with the MAPPLOT program,
    which reads a MAPPLOT control file and plots graphical
    entities to a map. The `GXMAPL <geosoft.gxapi.GXMAPL>` object is created for a given
    control file, then passed to the MAPPLOT program, along
    with the target `GXMAP <geosoft.gxapi.GXMAP>` object on which to do the drawing
    """


[docs]
    def __init__(self, handle=0):
        super(GXMAPL, self).__init__(GXContext._get_tls_geo(), handle)



[docs]
    @classmethod
    def null(cls):
        """
        A null (undefined) instance of `GXMAPL <geosoft.gxapi.GXMAPL>`
        
        :returns: A null `GXMAPL <geosoft.gxapi.GXMAPL>`
        :rtype:   GXMAPL
        """
        return GXMAPL()



[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]
    @classmethod
    def create(cls, name, ref_name, line):
        """
        Create a `GXMAPL <geosoft.gxapi.GXMAPL>`.
        
        :param name:      `GXMAPL <geosoft.gxapi.GXMAPL>` file name
        :param ref_name:  Map base reference name
        :param line:      Start line number in file (0 is first)
        :type  name:      str
        :type  ref_name:  str
        :type  line:      int

        :returns:         `GXMAPL <geosoft.gxapi.GXMAPL>`, aborts if creation fails
        :rtype:           GXMAPL

        .. versionadded:: 5.0

        **License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_

        **Note:** The default map groups will use the reference name with
        "_Data" and "_Base" added.  If no reference name is specified,
        the name "`GXMAPL <geosoft.gxapi.GXMAPL>`" is used
        """
        ret_val = gxapi_cy.WrapMAPL._create(GXContext._get_tls_geo(), name.encode(), ref_name.encode(), line)
        return GXMAPL(ret_val)





[docs]
    @classmethod
    def create_reg(cls, name, ref_name, line, reg):
        """
        Create a `GXMAPL <geosoft.gxapi.GXMAPL>` with `GXREG <geosoft.gxapi.GXREG>`.
        
        :param name:      `GXMAPL <geosoft.gxapi.GXMAPL>` file name
        :param ref_name:  Map base reference name
        :param line:      Start line number in file (0 is first)
        :type  name:      str
        :type  ref_name:  str
        :type  line:      int
        :type  reg:       GXREG

        :returns:         `GXMAPL <geosoft.gxapi.GXMAPL>`, aborts if creation fails
        :rtype:           GXMAPL

        .. versionadded:: 5.0

        **License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_

        **Note:** The default map groups will use the reference name with
        "_Data" and "_Base" added.  If no reference name is specified,
        the name "`GXMAPL <geosoft.gxapi.GXMAPL>`" is used
        """
        ret_val = gxapi_cy.WrapMAPL._create_reg(GXContext._get_tls_geo(), name.encode(), ref_name.encode(), line, reg)
        return GXMAPL(ret_val)








[docs]
    def process(self, map):
        """
        Process a `GXMAPL <geosoft.gxapi.GXMAPL>`
        
        :type  map:   GXMAP

        .. versionadded:: 5.0

        **License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
        """
        self._process(map)

        





[docs]
    def replace_string(self, var, repl):
        """
        Adds a replacement string to a mapplot control file.
        
        :param var:   Variable
        :param repl:  Replacement
        :type  var:   str
        :type  repl:  str

        .. versionadded:: 5.0

        **License:** `Geosoft Open License <https://geosoftgxdev.atlassian.net/wiki/spaces/GD/pages/2359406/License#License-open-lic>`_
        """
        self._replace_string(var.encode(), repl.encode())


        





### 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