systemtime.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_TIME_H
    #define AJA_TIME_H

#if defined(AJA_USE_CPLUSPLUS11) && !defined(AJA_BAREMETAL)
    // If compiling with C++11, by default, implementation uses STL chrono & thread.
    #ifndef AJA_SLEEP_USE_STL
        #define AJA_SLEEP_USE_STL   //  Sleep... functions use STL chrono/thread;  comment this out to use native impl
    #endif
    // #ifndef AJA_SYSCLK_USE_STL
    //  #define AJA_SYSCLK_USE_STL  //  GetSystem... functions use STL chrono;  comment this out to use native impl (TBD)
    // #endif
#endif  //  AJA_USE_CPLUSPLUS11

//  #define AJA_COLLECT_SLEEP_STATS     //  Define this to allow thread-specific stat collection for Sleep & SleepInMicroseconds
    #include "ajabase/common/public.h"
    #if defined(AJA_COLLECT_SLEEP_STATS)
        #include <string>
    #endif  //  defined(AJA_COLLECT_SLEEP_STATS)

    class AJA_EXPORT AJATime
    {
        public:

        static int64_t  GetSystemTime (void);

        static int64_t  GetSystemCounter (void);

        static int64_t  GetSystemFrequency (void);

        static double   GetSystemSeconds (void);

        static uint64_t GetSystemMilliseconds (void);

        static uint64_t GetSystemMicroseconds (void);

        static uint64_t GetSystemNanoseconds (void);

        static void     Sleep (const int32_t inMilliseconds);

        static void     SleepInMicroseconds (const int32_t inMicroseconds);

        static void     SleepInNanoseconds (const uint64_t inNanoseconds);

        #if defined(AJA_COLLECT_SLEEP_STATS)
            static bool         CollectSleepStats (const bool inEnable = true);
            static std::string  GetSleepStats (void);
        #endif  //  AJA_COLLECT_SLEEP_STATS
    };  //  AJATime

#endif  //  AJA_TIME_H