Source code for ska_control_model.obs_mode

# -*- coding: utf-8 -*-
#
# This file is part of the SKA Control System project.
#
# Distributed under the terms of the BSD 3-clause new license.
# See LICENSE.txt for more info.
"""This module defines an enumerated type for device observing mode."""

import enum




class ObsMode(enum.IntEnum):
    """Python enumerated type for observing mode."""

    IDLE = 0
    """
    The observing mode shall be ``IDLE`` when the observing state is
    ``IDLE`` (see :py:class:`~ska_control_model.obs_state.ObsState`).
    Otherwise, it will correctly report the appropriate value.

    More than one observing mode can be active in the same subarray at
    the same time.
    """

    IMAGING = 1
    """Imaging observation is active."""

    PULSAR_SEARCH = 2
    """Pulsar search observation is active."""

    PULSAR_TIMING = 3
    """Pulsar timing observation is active."""

    DYNAMIC_SPECTRUM = 4
    """
    Dynamic spectrum observation is active.

    Use of DYNAMIC_SPECTRUM is deprecated and will be removed in a future
    release and PULSAR_TIMING will be used instead.
    """

    TRANSIENT_SEARCH = 5
    """Transient search observation is active."""

    VLBI = 6
    """Very long baseline interferometry observation is active."""

    CALIBRATION = 7
    """Calibration observation is active."""