timer.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_TIMER_H
#define AJA_TIMER_H
 
#include <ostream>
#include "ajabase/common/public.h"
 
enum AJATimerPrecision
{
    AJATimerPrecisionMilliseconds,
    AJATimerPrecisionMicroseconds,
    AJATimerPrecisionNanoseconds
};
 
class AJA_EXPORT AJATimer
{
    public:
                                    AJATimer (const AJATimerPrecision precision = AJATimerPrecisionMilliseconds);
        virtual                     ~AJATimer()     {}
 
        void                        Start (void);
 
        void                        Stop (void);
 
        void                        Reset (void);
 
        uint32_t                    ElapsedTime (void) const;
 
        inline double               ETSecs (void) const                         {return double(ElapsedTime()) * PrecisionSecs(Precision());}
 
        inline bool                 Timeout (const uint32_t interval) const     {return (ElapsedTime() >= interval);}
 
        inline bool                 IsRunning (void) const                      {return mRun;}
 
        inline AJATimerPrecision    Precision (void) const                      {return mPrecision;}
 
 
        std::ostream &              Print (std::ostream & oss) const;
 
 
        static std::string          PrecisionName (const AJATimerPrecision precision, const bool longName = true);
 
        static double               PrecisionSecs (const AJATimerPrecision precision);
 
    private:
        uint64_t            mStartTime;
        uint64_t            mStopTime;
        bool                mRun;
        AJATimerPrecision   mPrecision;
 
    #if defined(DOCTEST_LIBRARY_INCLUDED)
        public: inline void SetStopTime (const uint64_t inIncr) {mStartTime = 0; mStopTime = inIncr;};
    #endif
};  //  AJATimer
 
AJA_EXPORT inline std::ostream & operator << (std::ostream & oss, const AJATimer & inObj)   {return inObj.Print(oss);}
 
#endif  //  AJA_TIMER_H