Source code for spinn_front_end_common.utilities.utility_objs.executable_type

# Copyright (c) 2017-2019 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from enum import Enum
from spinnman.model.enums import CPUState


[docs]class ExecutableType(Enum): """ The different types of executable from the perspective of how they\ are started and controlled. """ #: Runs immediately without waiting for barrier and then exits. RUNNING = ( 0, [CPUState.RUNNING], [CPUState.FINISHED], False, "Runs immediately without waiting for barrier and then exits") #: Calls ``spin1_start(SYNC_WAIT)`` and then eventually ``spin1_exit()``. SYNC = ( 1, [CPUState.SYNC0], [CPUState.FINISHED], False, "Calls spin1_start(SYNC_WAIT) and then eventually spin1_exit()") #: Calls ``simulation_run()`` and ``simulation_exit()`` / #: ``simulation_handle_pause_resume()``. USES_SIMULATION_INTERFACE = ( 2, [CPUState.SYNC0, CPUState.SYNC1, CPUState.PAUSED, CPUState.READY], [CPUState.READY], True, "Calls simulation_run() and simulation_exit() / " "simulation_handle_pause_resume()") #: Situation where there user has supplied no application but for some #: reason still wants to run. NO_APPLICATION = ( 3, [], [], True, "Situation where there user has supplied no application but for " "some reason still wants to run") #: Runs immediately without waiting for barrier and never ends. SYSTEM = ( 4, [CPUState.RUNNING], [CPUState.RUNNING], True, "Runs immediately without waiting for barrier and never ends") def __new__(cls, value, start_state, end_state, supports_auto_pause_and_resume, doc=""): # pylint: disable=protected-access, too-many-arguments obj = object.__new__(cls) obj._value_ = value obj.start_state = start_state obj.end_state = end_state obj.supports_auto_pause_and_resume = supports_auto_pause_and_resume obj.__doc__ = doc return obj def __init__(self, value, start_state, end_state, supports_auto_pause_and_resume, doc=""): # pylint: disable=too-many-arguments self._value_ = value self.__doc__ = doc self.start_state = start_state self.end_state = end_state self.supports_auto_pause_and_resume = supports_auto_pause_and_resume self.__doc__ = doc