TimeVal.h

Go to the documentation of this file.

#ifndef TIMEVAL_H
#define TIMEVAL_H

#include <time.h>
#include <sys/time.h>
#include <iostream>

#include "gcp/util/common/Directives.h"

namespace gcp {
  namespace util {
    
    class TimeVal {
    public:
      
      TimeVal();
      
      TimeVal(unsigned int seconds, unsigned int microSeconds, 
          unsigned int nanoSeconds);
      
      TimeVal(unsigned int seconds, unsigned int nanoSeconds);
      
      TimeVal(double seconds);
      
      TimeVal(std::string time_string, std::string format, 
          struct tm& refdate, double& reftime);
    /* counter to keep track of the number of errors*/
      int ErrorCounter_;
      TimeVal(std::string time_string, std::string format);
      
      TimeVal(const struct timeval& tVal);
      
      TimeVal(const struct timespec& timeSpec);
      TimeVal(const TimeVal& tVal);
      TimeVal(TimeVal& tVal);

      //------------------------------------------------------------
      // Methods for seting the time.
      //------------------------------------------------------------
      
#if DIR_HAVE_RT
#else
      enum clockid_t {
    CLOCK_REALTIME,
    CLOCK_HIGHRES
      };
#endif

      void setToCurrentTime(clockid_t clock = CLOCK_REALTIME);
      
      void setMjd(unsigned int days, unsigned int seconds, 
          unsigned int nanoSeconds);
      
      void setMjd(unsigned int days, unsigned int milliSeconds);
      
      void setMjd(double mjd);
      
      void setTime(unsigned int seconds, unsigned int microSeconds, 
           unsigned int nanoSeconds);
      
      void setTime(unsigned int seconds, unsigned int nanoSeconds);
      
      void setTime(const struct timespec& timeSpec);
      
      void setTime(const struct timeval& tVal);
      void setTime(double seconds);
      
      void setTimeInMilliSeconds(unsigned int milliSeconds);

      //------------------------------------------------------------
      // Methods to modify the time.
      //------------------------------------------------------------
      
      void incrementSeconds(double seconds);

      void incrementMilliSeconds(unsigned milliSeconds);

      void incrementNanoSeconds(unsigned nanoSeconds);

      void reset();
      
      struct timeval* timeVal();
      
      struct timespec* timeSpec();
      
      const TimeVal operator+(const TimeVal& tVal);
      
      const TimeVal operator-(const TimeVal& tVal);
      void operator=(const TimeVal& tVal);
      void operator=(TimeVal& tVal);
      bool operator>=(TimeVal& tVal);
      bool operator>=(const TimeVal& tVal);
      bool operator<(TimeVal& tVal);
      bool operator<(const TimeVal& tVal);
      void operator-=(const TimeVal& tVal);
      
      //------------------------------------------------------------
      // Methods returning the time.
      //------------------------------------------------------------
      
      double getTimeInMjdDays();
      
      double getTimeInSeconds() const;
      
      unsigned int getTimeInMicroSeconds();
      
      unsigned int getTimeInMilliSeconds();

      unsigned int getTimeInNanoSeconds();
      
      //------------------------------------------------------------
      // Methods returning parts of the time.
      //------------------------------------------------------------
      
      double getFractionalTimeInSeconds();
      
      unsigned int getSeconds();
      
      unsigned int getMilliSeconds(bool round=false);

      unsigned int getMicroSeconds();
      
      unsigned int getNanoSeconds();
      
      unsigned int getMjdDays();
      
      unsigned int getMjdSeconds();
      
      unsigned int getMjdMilliSeconds(bool round=false);
      
      unsigned int getMjdNanoSeconds();
      
      double getMjd();
      
      unsigned int getMjdId(unsigned nanoSecondInterval);
      // was int  <<--
      //------------------------------------------------------------
      // When our timespec struct is used as a countdown timer, it
      // can be modified to reflect the elapsed time.  The following
      // methods return the elapsed time in different
      // representations.
      //------------------------------------------------------------
      
      double getElapsedTimeInSeconds();
      
      double getElapsedTimeInMicroSeconds();
      
      unsigned int getElapsedTimeInNanoSeconds();
      
      
      //------------------------------------------------------------
      // Print methods
      //------------------------------------------------------------      
      
      std::string getUtcString();
      
      std::string dateString();

      friend std::ostream& operator<<(std::ostream& os, TimeVal& tVal);
      
    private:
      
      // The following are all equivalent representations of a
      // single time stamp.
      
      // timeval stores a time as seconds and microseconds.
      
      struct timeval timeVal_;
      
      // timespec stores a time as seconds and nanoseconds.
      
      struct timespec timeSpec_;
      
      // A generic representation of time as seconds and nanoseconds.
      
      unsigned int seconds_;
      unsigned int nanoSeconds_;
      
      // An equivalent representation of time as MJD day number,
      // seconds and nanoseconds.
      
      unsigned int mjdDays_;
      unsigned int mjdSeconds_;
      unsigned int mjdNanoSeconds_;
      
    public:

      //------------------------------------------------------------
      // Methods to update all represenations of time.
      //------------------------------------------------------------
      void setDateTime(std::string time_string, std::string format, struct tm& refdate, double& reftime);
      
      void setSeconds(unsigned int seconds);
      
      void setMilliSeconds(unsigned int milliSeconds);

      void setMicroSeconds(unsigned int microSeconds);

      void setNanoSeconds(unsigned int nanoSeconds);

    }; // End class TimeVal
    
  } // End namespace util
} // End namespace gcp


#endif // End #ifndef