Source code for ska_control_model.test_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 test mode."""

import enum




class TestMode(enum.IntEnum):
    """Python enumerated type for test mode."""

    __test__ = False  # disable pytest discovery for this class

    NONE = 0
    """Normal mode of operation. No test mode active."""

    TEST = 1
    """
    Test mode active.

    The element's behaviour and/or interface differs from the normal
    operating mode.

    To be implemented only by devices that implement one or more test
    modes. The element documentation shall provide detailed description.
    """