JSYSTEM::JDateAndTime Struct Reference

Auxiliary class for date and time. More...

#include <JDate.hh>

Public Member Functions
	JDateAndTime ()
	Default constructor. More...
	JDateAndTime (const time_t t1, const bool utc=false)
	Constructor. More...
	JDateAndTime (const std::string &buffer)
	Constructor. More...
const tm *	operator-> () const
	Smart pointer. More...
tm *	operator-> ()
	Smart pointer. More...
bool	isUTC () const
	Check if UTC time. More...
time_t	getTime () const
	time More...
int	getSeconds () const
	seconds after the minute [0-59] More...
int	getMinutes () const
	minutes after the hour [0-59] More...
int	getHour () const
	hours after midnight [0-23] More...
int	getDay () const
	day of the month [1-31] More...
int	getMonth () const
	month of the year [1-12] More...
int	getYear () const
	year a.d. More...
int	getDST () const
	daylight saving time More...
	operator std::string () const
	Type conversion operator. More...
std::string	toString () const
	Get ASCII formatted date and time. More...
const JDateAndTime &	operator() ()
	Set date and time. More...
void	set (const bool utc=false)
	Set to current local time. More...
void	set (const time_t t1, const bool utc=false)
	Set to given time. More...
void	add (const time_t t1)
	Add given time. More...
void	sub (const time_t t1)
	Subtract given time. More...
double	getElapsedTime (const JDateAndTime &object) const
	Get elapsed time to given date and time. More...

Static Public Member Functions
static bool	isISO8601 (const std::string &buffer)
	Function to check ISO-8601 conformity. More...

Private Attributes
time_t	ts
	value More...
tm *	tp
	representation More...
bool	utc = false
	UTC. More...

Friends
std::istream &	operator>> (std::istream &in, JDateAndTime &object)
	Read date and time from input stream. More...
std::ostream &	operator<< (std::ostream &out, const JDateAndTime &object)
	Write date and time to output stream. More...

Detailed Description

Auxiliary class for date and time.

The data structure time_t is used for the internal value and the data structure tm for the representation.

The I/O format conforms with ISO-8601 standard but it is also possible to parse ROOT TTimeStamp::AsString("c").

Definition at line 75 of file JSystem/JDate.hh.

Constructor & Destructor Documentation

JSYSTEM::JDateAndTime::JDateAndTime ( )

inline

Default constructor.

Definition at line 79 of file JSystem/JDate.hh.

    {
      set();
    }

JSYSTEM::JDateAndTime::JDateAndTime ( const time_t  t1, const bool  utc = false  )

inline

Constructor.

Parameters

t1	time
utc	UTC

Definition at line 91 of file JSystem/JDate.hh.

    {
      set(t1, utc);
    }

JSYSTEM::JDateAndTime::JDateAndTime ( const std::string &  buffer )

inline

Constructor.

Parameters

buffer

date and time

Definition at line 102 of file JSystem/JDate.hh.

    {
      using namespace std;

      // separation of date and time from optional time zone

      const size_t pos = (buffer.find('Z') != string::npos ? buffer.find('Z') :
                          buffer.find('+') != string::npos ? buffer.find('+') : buffer.rfind('-'));

      if (pos == string::npos) {
        THROW(JParseError, "invalid input <" << buffer << ">");
      }

      tm   tx;
      long ns = 0;

      const string td = buffer.substr(0, pos);
      const char*  pd = NULL;

      switch (td.length()) {

      case 29:
        pd = strptime(td.c_str(), "%Y-%m-%d %H:%M:%S.", &tx); sscanf(pd, "%9ld", &ns); pd += 9;
        break;

      case 19:
        pd = strptime(td.c_str(), "%Y-%m-%dT%H:%M:%S",  &tx);
        break;

      case 15:
        pd = strptime(td.c_str(), "%Y%m%dT%H%M%s",      &tx);
        break;
      
      case 10:
        pd = strptime(td.c_str(), "%Y-%m-%d",           &tx);
        break;
      }

      if (pd == NULL || *pd != '\0') {
        THROW(JParseError, "invalid input <" << buffer << ">");
      }

      tm   ty;

      const string tz = buffer.substr(pos + 1);
      const char*  pz = tz.c_str();

      ty.tm_hour = 0;
      ty.tm_min  = 0;

      switch (tz.length()) {

      case 0:
        break;

      case 2:
        pz = strptime(tz.c_str(), "%H",                 &ty);
        break;

      case 4:
        pz = strptime(tz.c_str(), "%H%M",               &ty);
        break;
            
      case 5:
        pz = strptime(tz.c_str(), "%H:%M",              &ty);
        break;
      }

      if (pz == NULL || *pz != '\0') {
        THROW(JParseError, "invalid input <" << buffer << ">");
      }

      tx.tm_isdst = 0;

      time_t t1 = mktime(&tx);

      t1 -= (ty.tm_hour * 60 + ty.tm_min) * 60;                // apply read time zone
      t1 += mktime(localtime(&t1)) - mktime(gmtime(&t1));      // 

      set(t1, buffer[pos] == 'Z');
    }

Member Function Documentation

const tm* JSYSTEM::JDateAndTime::operator-> ( ) const

inline

Smart pointer.

Returns

pointer to time structure

Definition at line 190 of file JSystem/JDate.hh.

    {
      return this->tp;
    }

tm* JSYSTEM::JDateAndTime::operator-> ( )

inline

Smart pointer.

Returns

pointer to time structure

Definition at line 201 of file JSystem/JDate.hh.

    {
      return this->tp;
    }

bool JSYSTEM::JDateAndTime::isUTC ( ) const

inline

Check if UTC time.

Returns

true if UTC time; else false

Definition at line 212 of file JSystem/JDate.hh.

    {
      return utc;
    }

time_t JSYSTEM::JDateAndTime::getTime ( ) const

inline

time

Definition at line 218 of file JSystem/JDate.hh.

int JSYSTEM::JDateAndTime::getSeconds ( ) const

inline

seconds after the minute [0-59]

Definition at line 220 of file JSystem/JDate.hh.

int JSYSTEM::JDateAndTime::getMinutes ( ) const

inline

minutes after the hour [0-59]

Definition at line 221 of file JSystem/JDate.hh.

int JSYSTEM::JDateAndTime::getHour ( ) const

inline

hours after midnight [0-23]

Definition at line 222 of file JSystem/JDate.hh.

int JSYSTEM::JDateAndTime::getDay ( ) const

inline

day of the month [1-31]

Definition at line 223 of file JSystem/JDate.hh.

int JSYSTEM::JDateAndTime::getMonth ( ) const

inline

month of the year [1-12]

Definition at line 224 of file JSystem/JDate.hh.

int JSYSTEM::JDateAndTime::getYear ( ) const

inline

year a.d.

Definition at line 225 of file JSystem/JDate.hh.

int JSYSTEM::JDateAndTime::getDST ( ) const

inline

daylight saving time

Definition at line 226 of file JSystem/JDate.hh.

JSYSTEM::JDateAndTime::operator std::string ( ) const

inline

Type conversion operator.

Returns

ASCII formatted date and time

Definition at line 234 of file JSystem/JDate.hh.

    {
      return this->toString();
    }

static bool JSYSTEM::JDateAndTime::isISO8601 ( const std::string &  buffer )

inlinestatic

Function to check ISO-8601 conformity.

Parameters

buffer

date and time

Returns

true if date and time are ISO-8601 conform; else false

Definition at line 246 of file JSystem/JDate.hh.

    {
      using namespace std;

      try {

        JDateAndTime t1(buffer);

        return true;
      }
      catch(const std::exception& error) {
        return false;
      }
    }

std::string JSYSTEM::JDateAndTime::toString ( ) const

inline

Get ASCII formatted date and time.

Returns

ASCII formatted date and time

Definition at line 267 of file JSystem/JDate.hh.

    {
      using namespace std;
      
      static const size_t     MAX_SIZE = 256;
      static char      buffer[MAX_SIZE];

      const size_t pos = strftime(buffer, MAX_SIZE, (isUTC() ? "%FT%TZ" : "%FT%T%z"), this->tp);

      return string(buffer, pos);
    }

const JDateAndTime& JSYSTEM::JDateAndTime::operator() ( )

inline

Set date and time.

Returns

date and time

Definition at line 285 of file JSystem/JDate.hh.

    {
      set();

      return *this;
    }

void JSYSTEM::JDateAndTime::set ( const bool  utc = false )

inline

Set to current local time.

Parameters

utc

UTC

Definition at line 298 of file JSystem/JDate.hh.

    {
      time_t tx;

      time(&tx);

      set(tx, utc);
    }

void JSYSTEM::JDateAndTime::set ( const time_t  t1, const bool  utc = false  )

inline

Set to given time.

Parameters

t1	time
utc	UTC

Definition at line 314 of file JSystem/JDate.hh.

    {
      this->ts  = t1;
      this->tp  = (utc ? gmtime(&t1) : localtime(&t1));
      this->utc = utc;
    }

void JSYSTEM::JDateAndTime::add ( const time_t  t1 )

inline

Add given time.

Parameters

t1

time

Definition at line 327 of file JSystem/JDate.hh.

    {
      set(this->ts + t1, this->utc);
    }

void JSYSTEM::JDateAndTime::sub ( const time_t  t1 )

inline

Subtract given time.

Parameters

t1

time

Definition at line 338 of file JSystem/JDate.hh.

    {
      set(this->ts - t1, this->utc);
    }

double JSYSTEM::JDateAndTime::getElapsedTime ( const JDateAndTime &  object ) const

inline

Get elapsed time to given date and time.

Parameters

object

date and time

Returns

time [s]

Definition at line 350 of file JSystem/JDate.hh.

    {
      return difftime(object.ts, this->ts);
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JDateAndTime &  object  )

friend

Read date and time from input stream.

Parameters

in	input stream
object	date and time

Returns

input stream

Definition at line 363 of file JSystem/JDate.hh.

    {
      std::string buffer;

      if (in >> buffer) {
        object = JDateAndTime(buffer);
      }
      
      return in;
    }

std::ostream& operator<< ( std::ostream &  out, const JDateAndTime &  object  )

friend

Write date and time to output stream.

Parameters

out	output stream
object	date and time

Returns

output stream

Definition at line 382 of file JSystem/JDate.hh.

    {
      return out << object.toString();
    }

Member Data Documentation

time_t JSYSTEM::JDateAndTime::ts

private

value

Definition at line 389 of file JSystem/JDate.hh.

tm* JSYSTEM::JDateAndTime::tp

private

representation

Definition at line 390 of file JSystem/JDate.hh.

bool JSYSTEM::JDateAndTime::utc = false

private

UTC.

Definition at line 391 of file JSystem/JDate.hh.

---

The documentation for this struct was generated from the following file:

• JSystem/JDate.hh