# Copyright (c) 2015-2022 EPFL/Blue Brain Project
# All rights reserved. Do not distribute without permission.
#
# Responsible Author: adrien.fleury@epfl.ch
#
# This file is part of Brayns <https://github.com/BlueBrain/Brayns>
#
# This library is free software; you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License version 3.0 as published
# by the Free Software Foundation.
#
# This library 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 Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

from enum import Enum


class TimeUnit(Enum):
    """Simulation time unit.

    Simulation time is always in milliseconds but this class is here to avoid
    making this assumption.

    :param MILLISECOND: milliseconds ('ms').
    """

    MILLISECOND = 'ms'

    @property
    def seconds(self) -> float:
        """Convert the time unit to seconds.

        :return: Time unit in seconds.
        :rtype: float
        """
        return 1 / self.per_second

    @property
    def per_second(self) -> float:
        """Get the number of time unit per second.

        :return: Time unit count in one second.
        :rtype: float
        """
        return 1000.0
