timer.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::Timer class.  An OS portable timing class.

  \par Copyright Information

  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/
#ifndef INCLUDED_DISTI_TIMER_H
#define INCLUDED_DISTI_TIMER_H

#include "disti_include.h"
#ifdef _WIN32
#    include <windows.h>
// Windows.h must come first
#    include <mmsystem.h>
#    include <windef.h>
#    include <winnt.h>
#else
#    include <stdint.h>
#endif

#ifndef INT_64
#    ifndef _WIN32
typedef uint64_t INT_64;
#    else
typedef __int64 INT_64;
#    endif
#endif

namespace disti
{
/** The Timer class
  */
class Timer
{
private:
    /** 
        The epoch time when the timer was started.  The time of
        day that the time was started, or last "Reset".  Used to calculate
        elapsed time.
    */
    INT_64 _start_time;

    void AccurateSleep( unsigned long milli );

    bool _winTimerResolutionSet;

#ifdef _WIN32
    TIMECAPS _timeCaps;
#endif

protected:
#ifdef _WIN32
    /** Speed of the hardware timer on windows in cycles per second
          * This will have a value of zero if High performance timers
          * are not available. */
    LARGE_INTEGER performanceFreq;
#endif

public:
    /** Timer constructor. */
    DISTI_EXPORT Timer( void );

    /** 
        Reset the timer so current time is the time base,  reset "epoch time" to
        the current time
    */
    DISTI_EXPORT void Reset( void );

    /** 
        Get the number of milliseconds elapsed since the "epoch time"  began
        \return Return the elapsed milliseconds since the beginning of the epoch
    */
    virtual DISTI_EXPORT unsigned long ElapsedMilliseconds( void );

    /** 
        Get the number of microseconds elapsed since the "epoch time"  began
        \return Return the elapsed Microseconds since the beginning of the epoch
    */
    virtual DISTI_EXPORT unsigned long ElapsedMicroseconds( void );

    /** 
        Get the number of seconds elapsed since the "epoch time" began 
        \return Return the number of seconds since the beginning of the epoch
    */
    virtual DISTI_EXPORT unsigned long ElapsedSeconds( void );

    /**
        Get the number of seconds elapsed since the "epoch time" began
        \return The number of seconds elapsed since the beginning of the epoch
    */
    virtual DISTI_EXPORT double ElapsedSecondsDouble( void );

    /** 
        Get the number of seconds elapsed since 01/01/1970, "wall clock"
        \return Return the number of seconds
    */
    virtual DISTI_EXPORT unsigned long GetCurrentTimeInSeconds( void );

    /**
        Get the number of seconds elapsed since 01/01/1970,
        and the number of microseconds elapsed in the current second
        \param sec  Return the number of seconds elapsed since 01/01/1970
        \param usec Return the factional second in microseconds
    */
    virtual DISTI_EXPORT void GetTimeOfDay( unsigned long* sec, unsigned long* usec );

    /** 
       Get number of microseconds elapsed since 01/01/1970
       \param usec Return number of microseconds elapsed
      */
    virtual DISTI_EXPORT void GetTimeOfDay( INT_64* usec );

    /**
      Cause the process (or thread) to sleep for the specified number of
      milliseconds.  Clock time continues, this pauses the thread, not
      the clock.
      \param milli How long to sleep in milliseconds. 
    */
    virtual DISTI_EXPORT void WaitMilliseconds( unsigned long milli );

    /**
       Cause the process (or thread) to sleep for the specified number of
       microseconds.  Clock time continues, this pauses the thread, not
      the clock.
       \param micro How long to sleep im micoseconds
    */
    virtual DISTI_EXPORT void WaitMicroseconds( unsigned long micro );

    /**
        Get the difference between a time value and when the "epoch time" began
        \param sec Time in seconds to compare to "epoch time"
        \param usec Time in microseconds to compare to "epoch time"
        \return Return the difference between the time parameters, and the "epoch time", in Microseconds
    */
    virtual DISTI_EXPORT unsigned long DifferenceInMicroseconds( unsigned long sec, unsigned long usec );

    /**
        Get the difference between a time value and when the "epoch time" began
        \param sec Time in seconds to compare to "epoch time"
        \param usec Time in microseconds to compare to "epoch time"
        \return Return the difference between the time parameters, and the "epoch time", in Seconds
    */
    virtual DISTI_EXPORT double DifferenceInSeconds( unsigned long sec, unsigned long usec );

    /** 
        Create a DIS timestamp based on the current time of day
        \return Return a DIS timestamp
    */
    virtual DISTI_EXPORT unsigned long DIS_Timestamp( void );

    virtual DISTI_EXPORT ~Timer();
};

} // namespace disti

#endif