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

.. py:module:: GeoHealthCheck.plugins.probe.wms


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

Classes
~~~~~~~

.. autoapisummary::

   GeoHealthCheck.plugins.probe.wms.WmsGetMapV1
   GeoHealthCheck.plugins.probe.wms.WmsGetMapV1All




.. py:class:: WmsGetMapV1


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

   Get WMS map image using the OGC WMS GetMap v1.1.1 Operation
   for single Layer.

   .. py:attribute:: NAME
      :value: 'WMS GetMap WMS v1.1.1. operation on SINGLE Layer'

      

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

       .. raw:: html

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

       .. code-block:: python

           """
               Do WMS GetMap v1.1.1 request with user-specified parameters
               for single Layer.
               """

       .. raw:: html

           </details>

      

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

      

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

      

   .. py:attribute:: REQUEST_TEMPLATE

      

   .. py:attribute:: PARAM_DEFS

      Param defs


   .. py:attribute:: CHECKS_AVAIL

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


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

      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:: WmsGetMapV1All


   Bases: :py:obj:`WmsGetMapV1`

   Get WMS map image for each Layer using the WMS GetMap operation.

   .. py:attribute:: NAME
      :value: 'WMS GetMap WMS v1.1.1. operation on ALL Layers'

      

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

       .. raw:: html

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

       .. code-block:: python

           """
               Do WMS GetMap v1.1.1 request for all Layers with
               user-specified parameters.
               """

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