snews_cs.cs_alert_schema
========================

.. py:module:: snews_cs.cs_alert_schema


Classes
-------

.. autoapisummary::

   snews_cs.cs_alert_schema.CoincidenceTierAlert


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

.. py:class:: CoincidenceTierAlert(env_path=None)

   The Message scheme for the alert and observations

   :param env_path: The path containing the environment configuration file
                    If None, uses the default file in '/etc/test-config.env'
   :type env_path: `str`, optional


   .. py:method:: id_format(num_detectors)

      Returns formatted message ID
          time format should always be same for all detectors.
          num_detectors: `int`
              Number of detectors in the alert. If more than 2,
              it is an update to an earlier alert, and will be
              appended with -UPDATE_ string

      Returns
          :`str`
              The formatted id as a string




   .. py:method:: get_cs_alert_schema(data, is_test=False)

      Create a message schema for alert.
      Internally called in hop_pub

      :param data: cs_utils data tuple with predefined field.
      :type data: `named tuple`

      :returns: message with the correct scheme
      :rtype: `dict`