:py:mod:`GeoHealthCheck.plugins.probe.tms`
==========================================

.. py:module:: GeoHealthCheck.plugins.probe.tms


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

Classes
~~~~~~~

.. autoapisummary::

   GeoHealthCheck.plugins.probe.tms.TmsCaps
   GeoHealthCheck.plugins.probe.tms.TmsGetTile
   GeoHealthCheck.plugins.probe.tms.TmsGetTileAll




.. py:class:: TmsCaps


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

   Probe for TMS main endpoint url

   .. py:attribute:: NAME
      :value: 'TMS Capabilities'

      

   .. py:attribute:: DESCRIPTION
      :value: 'Perform TMS Capabilities Operation and check validity'

      

   .. py:attribute:: RESOURCE_TYPE
      :value: 'OSGeo:TMS'

      

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

      

   .. py:attribute:: CHECKS_AVAIL

      Checks avail for all specific Caps checks.
      Optionally override Check.PARAM_DEFS using set_params
      e.g. with specific `value` or even `name`.



.. py:class:: TmsGetTile


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

   Fetch TMS tile and check result

   .. py:attribute:: NAME
      :value: 'TMS GetTile Single - get SINGLE Tile Image'

      

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

       .. raw:: html

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

       .. code-block:: python

           """Fetch SINGLE TMS-tile. NB extension
                             should match last string of layer."""

       .. raw:: html

           </details>

      

   .. py:attribute:: RESOURCE_TYPE
      :value: 'OSGeo:TMS'

      

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

      

   .. py:attribute:: REQUEST_TEMPLATE
      :value: '/{layer}/{zoom}/{x}/{y}.{extension}'

      

   .. py:attribute:: PARAM_DEFS

      Param defs


   .. py:attribute:: CHECKS_AVAIL

      Check for TMS GetTile


   .. 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:class:: TmsGetTileAll


   Bases: :py:obj:`TmsGetTile`

   Get TMS map image for each Layer using the TMS GetTile operation.

   .. py:attribute:: NAME
      :value: 'TMS GetTile All - get Tile Image for ALL Layers'

      

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

       .. raw:: html

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

       .. code-block:: python

           """
               Do TMS GetTile request for each Layer.
               """

       .. raw:: html

           </details>

      

   .. py:attribute:: PARAM_DEFS

      

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


   .. py:method:: perform_request()

      Perform actual request to service, overridden from base class