facilities::Timestamp Class Reference

#include <Timestamp.h>

List of all members.

Public Member Functions
	Timestamp ()
	Timestamp (long int seconds, int nano=0, int tzOffset=0)
	Timestamp (double julian)
	Constructor for Julian date. Must be GMT.
	Timestamp (const std::string &str, int tzOffset=0)
	Timestamp (int year, int month, int day, int hour=0, int minute=0, int second=0, int nano=0)
	Construct absolute time with specified fields.
std::string	getString () const
	Return string representation of time, not including nanoseconds;.
double	getJulian () const
	Return julian date.
double	getNano () const
long int	getClibTime () const
bool	operator< (const Timestamp &other) const
bool	operator> (const Timestamp &other) const
bool	operator<= (const Timestamp &other) const
bool	operator>= (const Timestamp &other) const
Timestamp &	operator= (const Timestamp &other)
bool	operator== (const Timestamp &other) const
bool	operator!= (const Timestamp &other) const
Protected Attributes
time_t	m_time
	internal binary rep of time; count seconds from Jan 1, 1970
int	m_nano
	Save fractional seconds separately (associated with m_time).
Static Private Member Functions
static time_t	toBinary (const std::string &strTime)
	Return "standard" binary time: count in seconds since 1 jan 1970.
static void	toString (time_t bin, std::string &strTime)
	Assemble string rep. from count of seconds.
Static Private Attributes
static const double	julian1970 = 2440587.5
static const int	secPerDay = (24*60*60)
static const double	inverseNano = 1000 * 1000 * 1000
static const int	inverseNanoInt = 1000 * 1000 * 1000
static const long int	maxInt = 0x7fffffff
static TZOffset	s_tz
Classes
class	TZOffset

---

Detailed Description

Timestamp class, valid for dates from 1970 through 2037

Supports comparisons

Input to constructors may be Julian date seconds since start of 1970, Jan. 1 with optional nanosecond field individual fields (year, month, etc.) string format

yyyy-mm-dd hh:mm:ss 1969 < yyyy < 2038 where 0 < mm < 13 0 < dd < 32 -1 < hh < 24 -1 < mm < 60 -1 < ss < 60

o only the first three fields are required. Omitted trailing fields will be interpreted as equal to 0. o by default : will be used to delimit fields, but user may specify an alternative in most circumstances o leading zeros are optional

Definition at line 49 of file Timestamp.h.

---

Constructor & Destructor Documentation

facilities::Timestamp::Timestamp

(

)

Default constructor builds object representing current time, expressed in GMT

Definition at line 19 of file Timestamp.cxx.

References m_time.

                       : m_nano(0) {
    m_time = time(0);
  }

facilities::Timestamp::Timestamp	(	long int	seconds,
		int	nano = 0,
		int	tzOffset = 0
	)

Count seconds from the creation-according-to-unix, start of 1970 Optional third argument is offset in seconds from GMT (e.g., PST is +28800)

Definition at line 28 of file Timestamp.cxx.

References inverseNanoInt.

    : m_time((time_t) seconds), m_nano(nano)
  {
    if  ((nano >= inverseNanoInt)  || (nano < 0) || (seconds < 0))
      throw BadTimeInput("facilities::Timestamp bad nano argument");
    seconds += tzOffset;
  }

facilities::Timestamp::Timestamp

(

double

julian

)

Constructor for Julian date. Must be GMT.

Definition at line 37 of file Timestamp.cxx.

References inverseNano, julian1970, m_nano, m_time, maxInt, and secPerDay.

                                    {
    double secs;
    secs = (julian - julian1970) * secPerDay;

    if ((fabs(secs) > maxInt) || (secs < 0) )
      throw BadTimeInput("Julian time not in range [1970, 2037]");

    m_time = (long int) secs;

    // In case time is negative, truncation will go the "wrong way".
    // Want m_time always <= secs
    if (m_time > secs) m_time--;
    m_nano = (int) ((secs - m_time)/inverseNano);
  } 

facilities::Timestamp::Timestamp	(	const std::string &	str,
		int	tzOffset = 0
	)

Create a timestamp from an ascii string of standard form yyyy-mm-dd hh:mm:ss where only the first three fields are required.

If the string is invalid, object will represent unix creation time. If the string represents a time in a timezone other than GMT, tzOffset should represent time zone offset relative to GMT in seconds so if local time is, for example, PST, tzOffset should be 28800

Definition at line 53 of file Timestamp.cxx.

References m_time, and toBinary().

                                                         : m_nano(0) {
    m_time = toBinary(str);
    m_time += tzOffset;
  }

facilities::Timestamp::Timestamp	(	int	year,
		int	month,
		int	day,
		int	hour = 0,
		int	minute = 0,
		int	second = 0,
		int	nano = 0
	)

Construct absolute time with specified fields.

Definition at line 59 of file Timestamp.cxx.

References inverseNanoInt, m_time, facilities::Timestamp::TZOffset::m_tzseconds, and s_tz.

                                 :  m_nano(nano) {
    struct tm fields;

    // check input   
    // for now don't bother checking whether, e.g., someone
    // specified April 31
    if ((month < 1 ) || (month > 12) || (day < 1) || (day > 31) ||
        (hour < 0) || (hour > 23) || 
        (minute < 0) || (minute > 59) || 
        (second < 0 ) || (second >= 60) ||
        (year < 1970) || (year > 2037) || 
        (nano < 0 ) || (nano >= inverseNanoInt) ) 
      throw BadTimeInput("facilities::Timestamp Bad subfield");

    fields.tm_year = year - 1900;
    fields.tm_mon = month - 1;
    fields.tm_mday = day;
    fields.tm_hour = hour;
    fields.tm_min = minute;
    fields.tm_sec = (long int) second;
    fields.tm_wday = -1;
    fields.tm_yday = -1;
    
    // let system figure out whether daylight savings time is in effect
    fields.tm_isdst = 0;

    //    m_time = timegm(&fields);
    m_time = mktime(&fields) - Timestamp::s_tz.m_tzseconds;
  }

---

Member Function Documentation

long int facilities::Timestamp::getClibTime

(

)

const [inline]

Definition at line 88 of file Timestamp.h.

References m_time.

Referenced by Coverage::Coverage().

{return m_time;}

double facilities::Timestamp::getJulian

(

)

const

Return julian date.

Definition at line 99 of file Timestamp.cxx.

References inverseNano, julian1970, m_nano, m_time, and secPerDay.

                                     {
    double julian = (m_time +  m_nano/inverseNano)/secPerDay;
    julian += julian1970;
    return julian;
  }

double facilities::Timestamp::getNano

(

)

const [inline]

Definition at line 87 of file Timestamp.h.

References m_nano.

{return m_nano;}

std::string facilities::Timestamp::getString

(

)

const

Return string representation of time, not including nanoseconds;.

Definition at line 92 of file Timestamp.cxx.

References m_time, deljobs::string, and toString().

Referenced by calibUtil::Metadata::adjustVend(), Coverage::checkType(), rdbModel::Table::fillProgramCols(), lookup(), main(), operator<<(), calibUtil::Metadata::registerCalib(), and soonest().

                                       {
    std::string str;

    toString(m_time, str);
    return str;
  }

bool facilities::Timestamp::operator!=

(

const Timestamp &

other

)

const [inline]

Definition at line 118 of file Timestamp.h.

References EvtCyclic3::other().

                                                  {
      return (!(*this == other));
    }

bool facilities::Timestamp::operator<

(

const Timestamp &

other

)

const [inline]

Definition at line 90 of file Timestamp.h.

References m_nano, m_time, and EvtCyclic3::other().

                                                 {
      return ((m_time < other.m_time) || 
              ((m_time == other.m_time) && (m_nano < other.m_nano)));
    }

bool facilities::Timestamp::operator<=

(

const Timestamp &

other

)

const [inline]

Definition at line 100 of file Timestamp.h.

References EvtCyclic3::other().

                                                  {
      return ( !(other < (*this)) );
    }

Timestamp& facilities::Timestamp::operator=

(

const Timestamp &

other

)

[inline]

Definition at line 109 of file Timestamp.h.

References m_nano, m_time, and EvtCyclic3::other().

                                                  {
      m_time = other.m_time; m_nano = other.m_nano; 
      return *this;
    }

bool facilities::Timestamp::operator==

(

const Timestamp &

other

)

const [inline]

Definition at line 114 of file Timestamp.h.

References m_nano, m_time, and EvtCyclic3::other().

                                                 {
      return ((m_time == other.m_time) && (m_nano == other.m_nano));
    }

bool facilities::Timestamp::operator>

(

const Timestamp &

other

)

const [inline]

Definition at line 95 of file Timestamp.h.

References EvtCyclic3::other().

                                                 {
      return (other < (*this));
        
    }

bool facilities::Timestamp::operator>=

(

const Timestamp &

other

)

const [inline]

Definition at line 104 of file Timestamp.h.

References EvtCyclic3::other().

                                                  {
      return ( !( (*this) < other ) );
    }

time_t facilities::Timestamp::toBinary

(

const std::string &

strTime

)

[static, private]

Return "standard" binary time: count in seconds since 1 jan 1970.

Definition at line 106 of file Timestamp.cxx.

References EvtCyclic3::c_str(), facilities::Timestamp::TZOffset::m_tzseconds, boss::pos, and s_tz.

Referenced by Timestamp().

                                                     {
    // Break out fields
    struct tm fields;

    unsigned int pos;
    unsigned int oldPos = 0;

    // Three delimiter characters may occur in ascii time representation.
    // First is hyphen.
    char  delim = '-';

    pos = strTime.find(delim, oldPos);

    // Must have two occurrences of hyphen delimiter
    if (pos >= strTime.size()) return 0;

    fields.tm_year = atoi((strTime.substr(oldPos, pos)).c_str()) - 1900;
    if ((fields.tm_year < 70) || (fields.tm_year > 137)) 
      throw BadTimeInput("facilities::Timestamp  bad year");
    oldPos = pos + 1;
    pos = strTime.find(delim, oldPos);

    // Should have at least two occurrences of delim
    if (pos >= strTime.size()) 
      throw BadTimeInput("Bad string format for facilities::Timestamp");

    fields.tm_mon = atoi((strTime.substr(oldPos, pos)).c_str()) - 1;
    if ((fields.tm_mon < 0) || (fields.tm_mon > 11)) 
      throw BadTimeInput("facilities::Timestamp bad month");

    // day
    oldPos = pos + 1;

    // A space separates time from date (if time is present at all)
    delim = ' ';
    pos = strTime.find(delim, oldPos);

    fields.tm_mday = atoi((strTime.substr(oldPos, pos)).c_str());

    if ((fields.tm_mday < 1) || (fields.tm_mday > 31))
    throw BadTimeInput("facilities::Timestamp bad day of month");

    // Remaining fields in string representation default to 0.
    fields.tm_hour = fields.tm_min = fields.tm_sec = 0;

    if (pos < strTime.size() ) {   // more fields to process
      delim = ':';
      oldPos = pos + 1;

      pos = strTime.find(delim, oldPos);

      fields.tm_hour = atoi((strTime.substr(oldPos, pos)).c_str());
      if ((fields.tm_hour > 23) || (fields.tm_hour < 0)) 
      throw BadTimeInput("facilities::Timestamp bad hour");

      
      if (pos < strTime.size() ) {
        oldPos = pos + 1;
        pos = strTime.find(delim, oldPos);
        fields.tm_min = atoi((strTime.substr(oldPos, pos)).c_str());
        if ((fields.tm_min > 59) || (fields.tm_hour < 0))
          throw BadTimeInput("facilities::Timestamp bad minutes");

        if (pos < strTime.size() ) {
          oldPos = pos + 1;
          pos = strTime.find(delim, oldPos);
          fields.tm_sec = atoi((strTime.substr(oldPos, pos)).c_str());
          if ((fields.tm_sec > 59) || (fields.tm_hour < 0)) 
            throw BadTimeInput("facilities::Timestamp bad seconds");
        }
      }
    }

    fields.tm_wday = -1;
    fields.tm_yday = -1;
    fields.tm_isdst = 0;
    return mktime(&fields)  - Timestamp::s_tz.m_tzseconds;
  }

void facilities::Timestamp::toString	(	time_t	bin,
		std::string &	strTime
	)			[static, private]

Assemble string rep. from count of seconds.

Definition at line 185 of file Timestamp.cxx.

Referenced by getString().

                                                         {
    struct tm * fields = gmtime(&bin);

    strTime.resize(0);
    
    char buf[20];
    char* bufPtr = &buf[0];
    sprintf(buf, "%i", fields->tm_year + 1900);
    strTime += bufPtr; strTime +=  "-";
    sprintf(buf, "%02i", fields->tm_mon +1);
    strTime += bufPtr; strTime +=  "-";
    sprintf(buf, "%02i", fields->tm_mday);
    strTime += bufPtr; strTime +=  " ";
    sprintf(buf, "%02i", fields->tm_hour);
    strTime += bufPtr; strTime +=  ":";
    sprintf(buf, "%02i", fields->tm_min);
    strTime += bufPtr; strTime +=  ":";
    sprintf(buf, "%02i", fields->tm_sec);
    strTime += bufPtr;
  }

---

Member Data Documentation

const double facilities::Timestamp::inverseNano = 1000 * 1000 * 1000 [static, private]

Definition at line 129 of file Timestamp.h.

Referenced by getJulian(), and Timestamp().

const int facilities::Timestamp::inverseNanoInt = 1000 * 1000 * 1000 [static, private]

Definition at line 130 of file Timestamp.h.

Referenced by Timestamp().

const double facilities::Timestamp::julian1970 = 2440587.5 [static, private]

Definition at line 127 of file Timestamp.h.

Referenced by getJulian(), and Timestamp().

int facilities::Timestamp::m_nano [protected]

Save fractional seconds separately (associated with m_time).

Definition at line 156 of file Timestamp.h.

Referenced by getJulian(), getNano(), operator<(), operator=(), operator==(), and Timestamp().

time_t facilities::Timestamp::m_time [protected]

internal binary rep of time; count seconds from Jan 1, 1970

Definition at line 153 of file Timestamp.h.

Referenced by getClibTime(), getJulian(), getString(), operator<(), operator=(), operator==(), and Timestamp().

const long int facilities::Timestamp::maxInt = 0x7fffffff [static, private]

Definition at line 131 of file Timestamp.h.

Referenced by Timestamp().

Timestamp::TZOffset facilities::Timestamp::s_tz [static, private]

Definition at line 143 of file Timestamp.h.

Referenced by Timestamp(), and toBinary().

const int facilities::Timestamp::secPerDay = (24*60*60) [static, private]

Definition at line 128 of file Timestamp.h.

Referenced by getJulian(), and Timestamp().

---