Time.h

Go to the documentation of this file.

// $Id: Time.h,v 1.3 2006/01/25 16:02:48 hmd Exp $
#ifndef GAUDIKERNEL_TIME_H
#define GAUDIKERNEL_TIME_H 1

// Include files
//   for the architecture independent int64 definition (longlong)
#include "GaudiKernel/Kernel.h"
#include "GaudiKernel/StreamBuffer.h"
#include "GaudiKernel/GaudiException.h"

class GAUDI_API TimeException: public GaudiException {
public:
  // Standard constructor
  TimeException( const std::string& Message = "unspecified exception",
                 const std::string& Tag = "*Gaudi::Time*",
                 const StatusCode & Code = StatusCode::FAILURE ):
    GaudiException(Message,Tag,Code) {}
  virtual ~TimeException() throw() {}
};

struct tm;
# ifdef WIN32
typedef struct _FILETIME FILETIME;
# endif

namespace Gaudi {

  class Time;
  class TimeSpan;

  class GAUDI_API TimeSpan {
    friend class Time;
  public:
    typedef longlong ValueType;

    TimeSpan (void);
    TimeSpan (Time t);
    TimeSpan (ValueType nsecs);
    TimeSpan (ValueType secs, int nsecs);
    TimeSpan (int days, int hours, int mins, int secs, int nsecs);

    int  days (void) const;
    int  hours (void) const;
    int  minutes (void) const;
    ValueType  seconds (void) const;

    int  lastHours (void) const;
    int  lastMinutes (void) const;
    int  lastSeconds (void) const;
    int  lastNSeconds (void) const;

    TimeSpan &  operator+= (const TimeSpan &x);
    TimeSpan &  operator-= (const TimeSpan &x);
    TimeSpan &  operator*= (const TimeSpan &n);
    TimeSpan &  operator/= (const TimeSpan &n);
    TimeSpan &  operator%= (const TimeSpan &n);

    ValueType  ns (void) const;

  private:
    ValueType  m_nsecs; //< The span length.
  };


  class GAUDI_API Time {
    friend class TimeSpan;
  public:
    typedef longlong ValueType;

    enum Months {
      January  = 0,
      February = 1,
      March  = 2,
      April  = 3,
      May  = 4,
      June  = 5,
      July  = 6,
      August  = 7,
      September = 8,
      October  = 9,
      November = 10,
      December = 11
    };

    static const int SECS_PER_DAY = 86400;

    static const int SECS_PER_HOUR = 3600;

    static const ValueType SEC_NSECS = 1000000000;

    Time (void);
    Time (TimeSpan ts);
    Time (ValueType nsecs);
    Time (ValueType secs, int nsecs);
    Time (int year, int month, int day, int hour, int min, int sec,
          ValueType nsecs, bool local = true);
    // implicit copy constructor
    // implicit assignment operator
    // implicit destructor

    static Time epoch   (void);
    static Time max     (void);
    static Time  current (void);
# ifdef WIN32
    static Time  from    (const FILETIME *systime);
# endif
    static Time  build   (bool local, const tm &base, TimeSpan diff = 0);

    tm   split   (bool local, int *nsecpart = 0) const;
    tm   utc     (int *nsecpart = 0) const;
    tm   local   (int *nsecpart = 0) const;

    int       year    (bool local) const;
    int       month   (bool local) const;
    int       day     (bool local) const;
    int       hour    (bool local) const;
    int       minute  (bool local) const;
    int       second  (bool local) const;
    int       nsecond (void) const;
    int       weekday (bool local) const;
    bool      isdst   (bool local) const;

    ValueType  utcoffset (int *daylight = 0) const;
    const char * timezone (int *daylight = 0) const;

    Time &  operator+= (const TimeSpan &x);
    Time &  operator-= (const TimeSpan &x);

    ValueType  ns (void) const;

    std::string  format (bool local, const std::string &spec) const;
    std::string  nanoformat (int minwidth = 1, int maxwidth = 9) const;

    static bool  isLeap (int year);

    // Conversion helpers
    static unsigned toDosDate (Time time);
    static Time  fromDosDate (unsigned dosDate);

  private:
    ValueType  m_nsecs; //< Time value as nsecs from #epoch().

    inline void TimeAssert(bool cond, const std::string &msg = "time assertion failed") const {
      if (!cond) throw TimeException(msg);
    }

  };

}

#include "GaudiKernel/Time.icpp"

#endif // GAUDIKERNEL_TIME_H