GeoHealthCheck.plugins.probe.wmts
=================================

.. py:module:: GeoHealthCheck.plugins.probe.wmts


Classes
-------

.. autoapisummary::

   GeoHealthCheck.plugins.probe.wmts.WmtsGetTile
   GeoHealthCheck.plugins.probe.wmts.WmtsGetTileAll


Module Contents
---------------

.. py:class:: WmtsGetTile

   Bases: :py:obj:`GeoHealthCheck.probe.Probe`


   Get WMTS map tile for specific layers.
   There are 2 possible request templates to support both KVP and REST


   .. py:attribute:: NAME
      :value: 'WMTS GetTile operation on specific layers'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
             Do WMTS GetTile request on user-specified layers.
             """

      .. raw:: html

         </details>



      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:attribute:: RESOURCE_TYPE
      :value: 'OGC:WMTS'


      Type of GHC Resource e.g. 'OGC:WMS', default not applicable.



   .. py:attribute:: REQUEST_METHOD
      :value: 'GET'


      HTTP request method capitalized, GET (default) or POST.



   .. py:attribute:: REQUEST_TEMPLATE

      Template in standard Python `str.format(*args)`. The variables
      like {service} and {version} within a template are filled from
      actual values for parameters defined in PARAM_DEFS and substituted
      from values or constant values specified by user in GUI and stored
      in DB.



   .. py:attribute:: PARAM_DEFS

      Param defs



   .. py:attribute:: CHECKS_AVAIL

      Checks for WMTS GetTile Response available.
      Optionally override Check PARAM_DEFS using set_params
      e.g. with specific `value` or even `name`.



   .. py:attribute:: layer_count
      :value: 0



   .. py:method:: get_metadata(resource, version='1.0.0')

      Get metadata, specific per Resource type.
      :param resource:
      :param version:
      :return: Metadata object



   .. py:method:: expand_params(resource)

      Called after creation. Use to expand PARAM_DEFS, e.g. from Resource
      metadata like WMS Capabilities. See e.g. WmsGetMapV1 class.
      :param resource:
      :return: None



   .. py:method:: test_kvp_rest()

      Make requests on some variations of the url to test
      if KVP and/or REST is possible.



   .. py:method:: check_capabilities(url)

      Check for exception in GetCapabilities response



   .. py:method:: before_request()

      Before request to service, overridden from base class



   .. py:method:: perform_request()

      Perform actual request to service, overridden from base class



   .. py:method:: actual_request()

      Perform actual request to service



   .. py:method:: calculate_center_tile(center_coord, tilematrix, crs)

      Determine center tile row and column indexes based on
      topleft coordinate, scale, center coordinate and tilewidth/height



.. py:class:: WmtsGetTileAll

   Bases: :py:obj:`WmtsGetTile`


   Get WMTS GetTile for all layers.


   .. py:attribute:: NAME
      :value: 'WMTS GetTile for all layers.'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
             WMTS GetTile for all layers.
             """

      .. raw:: html

         </details>



      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:attribute:: PARAM_DEFS

      Param defs



   .. py:attribute:: wmts
      :value: None



   .. py:attribute:: layers
      :value: None



   .. py:method:: expand_params(resource)

      Called after creation. Use to expand PARAM_DEFS, e.g. from Resource
      metadata like WMS Capabilities. See e.g. WmsGetMapV1 class.
      :param resource:
      :return: None



   .. py:method:: before_request()

      Before request to service, overridden from base class