Source code for spinn_front_end_common.interface.provenance.timer_work

# Copyright (c) 2022 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from enum import auto, Enum




class TimerWork(Enum):
    """
    Different Work types an Algorithm could be doing
    """

    OTHER = (auto(), "Other")
    GET_MACHINE = (auto(), "Turning on Machine")
    LOADING = (auto(), "Loading Stage")
    LOADING_DATA = (auto(), "Loading Data")
    # Only for on Machine Compression
    COMPRESSING = (auto(), "Compressing")
    CONTROL = (auto(), "Control")
    SYNAPSE = (auto(), "Expanding Synapse")
    RUNNING = (auto(), "Running")
    EXTRACTING = (auto(), "Extracting Stage")
    EXTRACT_DATA = (auto(), "Extracting Data")
    REPORT = (auto(), "Reporting")

    def __new__(cls, value: int, __: str) -> 'TimerWork':
        obj = object.__new__(cls)
        obj._value_ = value
        return obj

    def __init__(self, value: int, work_name: str):
        """
        :param value: Enum ID
        :param work_name: Descriptor for this Enum
        """
        _ = value
        self._work_name = work_name

    @property
    def work_name(self) -> str:
        """
        The name for this timer distinction.
        """
        return self._work_name