TimeVal.h

Go to the documentation of this file.

#ifndef TIMEVAL_H
#define TIMEVAL_H

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

namespace sza {
  namespace util {
    
    class TimeVal {
    public:
      
      TimeVal();
      
      TimeVal(unsigned long seconds, unsigned long microSeconds, 
              unsigned long nanoSeconds);
      
      TimeVal(unsigned long seconds, unsigned long nanoSeconds);
      
      TimeVal(const struct timeval& tVal);
      
      TimeVal(const struct timespec& timeSpec);
      
      TimeVal(double mjd);

      //------------------------------------------------------------
      // Methods for seting the time.
      //------------------------------------------------------------
      
#define HAVE_RT 1

#if HAVE_RT
#else
      enum clockid_t {
        CLOCK_REALTIME,
        CLOCK_HIGHRES
      };
#endif

      void setToCurrentTime(clockid_t clock = CLOCK_REALTIME);
      
      void setMjd(unsigned long days, unsigned long seconds, 
                  unsigned long nanoSeconds);
      
      void setMjd(unsigned long days, unsigned long milliSeconds);
      
      void setMjd(double mjd);
      
      void setTime(unsigned long seconds, unsigned long microSeconds, 
                   unsigned long nanoSeconds);
      
      void setTime(unsigned long seconds, unsigned long nanoSeconds);
      
      void setTime(const struct timespec& timeSpec);
      
      void setTime(const struct timeval& tVal);
      
      //------------------------------------------------------------
      // Methods to modify the time.
      //------------------------------------------------------------
      
      void incrementSeconds(double seconds);

      void incrementNanoSeconds(unsigned nanoSeconds);
      
      void reset();
      
      struct timeval* timeVal();
      
      struct timespec* timeSpec();
      
      const TimeVal operator+(const TimeVal& tVal);
      
      const TimeVal operator-(const TimeVal& tVal);
      
      //------------------------------------------------------------
      // Methods returning the time.
      //------------------------------------------------------------
      
      double getTimeInMjdDays();
      
      double getTimeInSeconds();
      
      double getTimeInMilliSeconds();

      double getTimeInMicroSeconds();
      
      unsigned long getTimeInNanoSeconds();
      
      //------------------------------------------------------------
      // Methods returning parts of the time.
      //------------------------------------------------------------
      
      double getFractionalTimeInSeconds();
      
      unsigned long getSeconds();
      
      unsigned long getMicroSeconds();
      
      unsigned long getNanoSeconds();
      
      unsigned long getMjdDays();
      
      unsigned long getMjdSeconds();
      
      unsigned long getMjdMilliSeconds();
      
      unsigned long getMjdNanoSeconds();
      
      double getMjd();

      double getFractionalMjdDay();

      unsigned int getMjdId(unsigned nanoSecondInterval);

      //------------------------------------------------------------
      // 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 long 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 long seconds_;
      unsigned long nanoSeconds_;
      
      // An equivalent representation of time as MJD day number,
      // seconds and nanoseconds.
      
      unsigned long mjdDays_;
      unsigned long mjdSeconds_;
      unsigned long mjdNanoSeconds_;
      
      //------------------------------------------------------------
      // Methods to update all represenations of time.
      //------------------------------------------------------------

    public:

      void setSeconds(unsigned long seconds);
      
      void setMicroSeconds(unsigned long microSeconds);

    private:
      
      void setNanoSeconds(unsigned long nanoSeconds);
      
    }; // End class TimeVal
  }; // End namespace util
}; // End namespace sza

#endif // End #ifndef