TimeStamp.hh

Go to the documentation of this file.

#ifndef CRL_MULTISENSE_TIMESTAMP_HH
#define CRL_MULTISENSE_TIMESTAMP_HH

#if defined(WIN32)
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN 1
#endif

#include <windows.h>
#include <winsock2.h> // Provides a declaration for struct timeval
#else
#include <sys/time.h>
#endif
#include <stdint.h>

namespace crl {
namespace multisense {
namespace details {
namespace utility {

//
// This is a simple class that helps manage time for the rest of the system,
// abstracting it away into something that is more usable.
//

class TimeStamp
{
private:

    //
    // The stored time.
    //

    struct timeval time;

    //
    // The time synchronization offset. This offset is recalculated each time
    // we receive a PPS timestamp set. It is applied to all times returned by
    // calling getCurrentTime().
    //

    static double timeSynchronizationOffset;
#if defined (WIN32)
    static ULARGE_INTEGER offsetSecondsSince1970;
#endif

public:

    //
    // Static routines, for the singleton version of the TimeStamp.
    //

    static TimeStamp getCurrentTime();

    static void setTimeAtPps(TimeStamp& local, TimeStamp& remote);
    static void setTimeAtPps(struct timeval& local, struct timeval& remote);
    static double getTimeSynchronizationOffset();

    //
    // Public constructor. Initializes from a timestamp.
    //

    TimeStamp();
    TimeStamp(struct timeval& value);
    TimeStamp(double value);

    //
    // For setting the timestamp.
    //

    void set(struct timeval& value);

    //
    // For getting precise values from the timestamp.
    //

    uint32_t getSeconds() const;
    uint32_t getMicroSeconds() const;

    //
    // Operator overloads, for working with time.
    //

    operator double() const;
    TimeStamp& operator=(double timeStamp);
    TimeStamp& operator+=(TimeStamp const& other);
    TimeStamp& operator-=(TimeStamp const& other);
    
    //
    // Make sure internal state is consistent.  Use this if you set
    // the TimeStamp using a timeval struct that had an unchecked
    // microseconds value, such as a negative number.
    //

    void normalize();
};


//
// Arithmetic operators are mostly handled by implicit conversion to
// and from double.
//

// TimeStamp operator +(TimeStamp const& arg0, TimeStamp const& arg1);
// TimeStamp operator -(TimeStamp const& arg0, TimeStamp const& arg1);
  
}}}} // namespaces

#endif /* #ifndef CRL_MULTISENSE_TIMESTAMP_HH */