Source code for ska_control_model.control_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 control mode."""

import enum




class ControlMode(enum.IntEnum):
    """Python enumerated type for control mode."""

    REMOTE = 0
    """Monitoring and control operations are accepted from all clients."""

    LOCAL = 1
    """
    Monitoring and control operations are accepted only from a "local" client.

    Commands and queries received from TM or any other "remote" clients
    are ignored.

    This mode is typically activated by a switch, or a connection on the
    local control interface. The intention is to support early
    integration of dishes and stations. The equipment has to be put back
    in ``REMOTE`` before clients can take  control again.

    **Note:** ``LOCAL`` control mode is **not a safety feature**, but
    rather a usability feature.  Safety must be implemented separately
    from the control paths.
    """