Source code for ska_control_model.simulation_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 simulation mode."""

import enum



[docs]
class SimulationMode(enum.IntEnum):
    """Python enumerated type for simulation mode."""

    FALSE = 0
    """The control system is connected to a real entity."""

    TRUE = 1
    """
    The control system is connected to a simulator.

    It may be connected to an entirely separate simulator, or the real
    entity may be itself in a simulation mode.
    """