Time.h

Go to the documentation of this file.

// -*- c++ -*-
#ifndef CARMA_UTIL_TIME_H
#define CARMA_UTIL_TIME_H

#include <iosfwd>
#include <string>
#include <ctime>
#include "carma/util/types.h"

struct timeval;

namespace carma {
  namespace util {

    class Time 
    {
    public:
      typedef enum {
        LOCAL =   -1, 
        GMT   =    0, 
        UTC   =  GMT,
        ADT   =    3,
        AST   =    4,
        EDT   =  AST,
        EST   =    5,
        CDT   =  EST,
        CST   =    6,
        MDT   =  CST,
        MST   =    7,
        PDT   =  MST,
        PST   =    8,
        AKDT  =  PST,
        AKST  =    9,
        HADT  = AKST,
        HAST  =   10      
      } TimeZone;

      Time();

      Time(double mjd);

      virtual ~Time();

      double getStoredMJD() const;

      static double MJD() ;

      static double MJD(frameType frame) ;       

      static frameType computeClosestFrame() ;

      static frameType computeClosestFrame(double mjd) ;

      static frameType computeClosestFrame(
                                           const std::string& date, 
                                           const std::string& format="%Y %b %d %H:%M:%S",
                                           const TimeZone tz=LOCAL
                                           );

      static frameType computeCurrentFrame() ;

      static frameType computeFrame(double mjd) ;

      static double computeTimeToNextFrame(double delay=0) ;

      static double computeTimeToFrame(frameType frame, double delay=0) ;

      static double computeFrameTimeDiff(frameType frame, double delay=0) ;

      static double computeMJD (time_t seconds) ; 

      static double computeMJD(
                               const std::string& date, 
                               const std::string& format="%Y %b %d %H:%M:%S",
                               const TimeZone tz=LOCAL
                               );

      // older version
      static double computeMJD1(
                               const std::string& date, 
                               const std::string& format="%Y %b %d %H:%M:%S",
                               const TimeZone tz=LOCAL
                               );

      static double timespec2MJD (const struct timespec ts);
      
      static double timeval2MJD (const struct ::timeval & abstimeval);

      static time_t gettime_t(const frameType frame);

      static std::string getTimeString(int precision=0) ;

      static std::string getTimeString(double mjd, int precision=0) ;

      static std::string getTimeString(frameType frame, int precision=0) ;

      static std::string getDateString(
            const std::string &dateFormat = "%d%b%y") ;

      static std::string getDateString(double mjd,
            const std::string &dateFormat = "%d%b%y") ;

      static std::string getDateString(frameType frame,
             const std::string &dateFormat = "%d%b%y") ;

      static std::string getDateString(int imjd,
            const std::string &dateFormat = "%d%b%y") ;

      static std::string getFITSdateString() ;

      static std::string getFITSdateString(int imjd) ;

      static std::string getFITSdateString(double mjd) ;

      static std::string getFITSdateString(frameType frame) ;

      static ::std::string getNonBuggyByDesignDateTimeString(
          double mjd, const ::std::string &dateFormat );

      static std::string getDateTimeString(int precision=0, 
            const std::string &dateFormat = "%d%b%y") ;

      static std::string getDateTimeString(frameType frame, 
             int precision=0,
             const std::string &dateFormat = "%d%b%y") ;
 
      static std::string getDateTimeString(double mjd,
             int precision=0,
             const std::string &dateFormat = "%d%b%y") ;


      static std::string getFITSdateTimeString(int precision=0);

      static std::string getFITSdateTimeString(double mjd, int precision=0) ;

      static std::string getFITSdateTimeString(frameType frame, 
            int precision=0) ;

      static struct tm getGmtFromLmt(const std::string &date,
                                     const std::string &format,
                                     const Time::TimeZone tz);

      static int  diffHrsFromGmt(const struct tm myTime,
                                 const time_t secondsSince1970);



      static const double MJD1970 = 40587.0;

      static const double MJD2000 = 51544.0;

      static const double JD2000 = 2451544.5;

      static const double SECONDS_PER_DAY = 86400.0;

      static const double MINUTES_PER_DAY;

      // value is initialized with the storage declaration in the .cc file
      static const double MILLISECONDS_PER_DAY;

      // value is initialized with the storage declaration in the .cc file
      static const double MICROSECONDS_PER_DAY;

      // value is initialized with the storage declaration in the .cc file
      static const double FRAMES_PER_DAY;

    private:
      static double  get2kd() ;
      static int     computeIntegerMJD(double mjd, int precision=0) ;
      static double  roundMJD(double mjd, int precision=0) ;
      double mjd_;
    };

  } }  // End namespace carma::util  


::std::ostream& operator<<( ::std::ostream&           os,
                             const carma::util::Time& time );


#endif  // CARMA_UTIL_TIME_H