OpenSpace/src/util/timeconversion.cpp

/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2022                                                               *
 *                                                                                       *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
 * software and associated documentation files (the "Software"), to deal in the Software *
 * without restriction, including without limitation the rights to use, copy, modify,    *
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
 * permit persons to whom the Software is furnished to do so, subject to the following   *
 * conditions:                                                                           *
 *                                                                                       *
 * The above copyright notice and this permission notice shall be included in all copies *
 * or substantial portions of the Software.                                              *
 *                                                                                       *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
 ****************************************************************************************/

#include <openspace/util/timeconversion.h>

#include <ghoul/glm.h>

#include <cstring>

namespace openspace {

std::pair<double, std::string> simplifyTime(double seconds, bool forceSingularForm) {
    const double secondsVal = glm::abs(seconds);

    if (secondsVal == 0.0) {
        return { 0.0, forceSingularForm ? "second" : "seconds" };
    }
    else if (secondsVal > 1e-3 && secondsVal < SecondsPerMinute) {
        return { seconds, (seconds == 1.0 || forceSingularForm) ? "second" : "seconds" };
    }

    if (secondsVal <= 1e-9) {
        const double val = seconds / 1e-9;
        return { val, (val == 1.0 || forceSingularForm) ? "nanosecond" : "nanoseconds" };
    }
    else if (secondsVal <= 1e-6) {
        const double val = seconds / 1e-6;
        return {
            val,
            (val == 1.0 || forceSingularForm) ? "microsecond" : "microseconds"
        };
    }
    else if (secondsVal <= 1e-3) {
        const double val = seconds / 1e-3;
        return {
            val,
            (val == 1.0 || forceSingularForm) ? "millisecond" : "milliseconds"
        };
    }

    if (secondsVal >= SecondsPerYear) {
        const double val = seconds / SecondsPerYear;
        return { val, (val == 1.0 || forceSingularForm) ? "year" : "years" };
    }
    else if (secondsVal >= SecondsPerMonth) {
        const double val = seconds / SecondsPerMonth;
        return { val, (val == 1.0 || forceSingularForm) ? "month" : "months" };
    }
    else if (secondsVal >= SecondsPerDay) {
        const double val = seconds / SecondsPerDay;
        return { val, (val == 1.0 || forceSingularForm) ? "day" : "days" };
    }
    else if (secondsVal >= SecondsPerHour) {
        const double val = seconds / SecondsPerHour;
        return { val, (val == 1.0 || forceSingularForm) ? "hour" : "hours" };
    }
    else {
        const double val = seconds / SecondsPerMinute;
        return { val, (val == 1.0 || forceSingularForm) ? "minute" : "minutes" };
    }
}

} // namespace openspace