SYS_Flicks.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        SYS_Flicks.h (SYS Library, C++)
 *
 * COMMENTS:
 */

#ifndef __SYS_Flicks__
#define __SYS_Flicks__

#include <flicks.h>
#include "SYS_Types.h"

// Define SYS_Flicks
using SYS_Flicks = util::flicks;

// Extract constants for flicks
// 0 seconds
constexpr SYS_Flicks SYS_FLICKS_0S = util::k_flicks_zero_seconds;
// 1 second
constexpr SYS_Flicks SYS_FLICKS_1S = util::k_flicks_one_second;
// 0.5 seconds
constexpr SYS_Flicks SYS_FLICKS_1_2S{
    std::chrono::duration_cast<SYS_Flicks>(
        std::chrono::duration<SYS_Flicks::rep, std::ratio<1, 2>>{1})};
// 1/24th of a second
constexpr SYS_Flicks SYS_FLICKS_1_24S = util::k_flicks_one_twenty_fourth_of_second;
// 1/90th of a second
constexpr SYS_Flicks SYS_FLICKS_1_90S = util::k_flicks_one_ninetieth_of_second;
// The minimum unit of time that can be expressed in flicks
constexpr SYS_Flicks SYS_FLICKS_MIN = util::k_flicks_min_time;

constexpr int64 SYStoInt(const SYS_Flicks f)
{
    // Return the number of flicks -- This is consistent across platforms and
    // can be used to compute a hash for flicks
    return f.count();
}


/// NOTE:  the util::flicks_hash() hasher is *not* consistent across platforms
/// and should not be used.  Use SYShash() instead.
constexpr size_t SYShash(const SYS_Flicks f)
{
    return f.count();
}

constexpr double SYStoSeconds(const SYS_Flicks f)
{
    return util::to_seconds(f);
}
constexpr SYS_Flicks SYStoFlicks(double seconds)
{
    return util::to_flicks(seconds);
}

#endif