Auxiliary class for date and time. More...

#include <JDateAndTime.hh>

Inheritance diagram for JSYSTEM::JDateAndTime:

Public Member Functions
	JDateAndTime (const bool utc=false)
	Constructor.

	JDateAndTime (const time_t t1, const bool utc=false)
	Constructor.

	JDateAndTime (const time_t t1, const float f1, const bool utc=false)
	Constructor.

	JDateAndTime (const std::string &buffer)
	Constructor.

	JDateAndTime (const char *const buffer)
	Constructor.

bool	less (const JDateAndTime &object) const
	Less than method.

const tm *	operator-> () const
	Smart pointer.

bool	isUTC () const
	Check if UTC time.

time_t	getTime () const
	time

int	getSeconds () const
	seconds after the minute [0-59]

int	getMinutes () const
	minutes after the hour [0-59]

int	getHour () const
	hours after midnight [0-23]

int	getDay () const
	day of the month [1-31]

int	getMonth () const
	month of the year [1-12]

int	getYear () const
	year a.d.

int	getDST () const
	daylight saving time

float	getFS () const
	fraction of second

	operator std::string () const
	Type conversion operator.

std::string	toString () const
	Get ASCII formatted date and time.

const JDateAndTime &	operator() (const bool utc=false)
	Set date and time.

void	set (const bool utc=false)
	Set to current local time.

void	set (const time_t t1, const bool utc=false)
	Set to given time.

void	set (const time_t t1, const float f1, const bool utc=false)
	Set to given time.

void	add (const time_t t1)
	Add given time.

void	sub (const time_t t1)
	Subtract given time.

double	getElapsedTime (const JDateAndTime &object) const
	Get elapsed time to given date and time.

Static Public Member Functions
static JDateAndTime	min (const bool utc=false)
	Get minimum date and time.

static JDateAndTime	max (const bool utc=false)
	Get maximum date and time.

static bool	isISO8601 (const std::string &buffer)
	Function to check ISO-8601 conformity.

Private Member Functions
tm *	get () const
	Get representation.

Private Attributes
time_t	ts
	value

float	fs = 0.0
	fraction of second

tm *	tp
	representation

bool	utc = false
	UTC.

Friends
std::istream &	operator>> (std::istream &in, JDateAndTime &object)
	Read date and time from input stream.

std::ostream &	operator<< (std::ostream &out, const JDateAndTime &object)
	Write date and time to output stream.

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 79 of file JDateAndTime.hh.

Constructor & Destructor Documentation

◆ JDateAndTime() [1/5]

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

inline

Constructor.

Parameters

utc UTC

Definition at line 87 of file JDateAndTime.hh.

    {
      set(utc);
    }

◆ JDateAndTime() [2/5]

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

inline

Constructor.

Parameters

t1	time [s]
utc	UTC

Definition at line 99 of file JDateAndTime.hh.

    {
      set(t1, utc);
    }

◆ JDateAndTime() [3/5]

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

inline

Constructor.

Parameters

t1	time [s]
f1	fraction of seconds
utc	UTC

Definition at line 112 of file JDateAndTime.hh.

    {
      set(t1, f1, utc);
    }

◆ JDateAndTime() [4/5]

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

inline

Constructor.

Parameters

buffer date and time

Definition at line 123 of file JDateAndTime.hh.

    {
      std::istringstream is(buffer);
 
      is >> *this;
    }

◆ JDateAndTime() [5/5]

JSYSTEM::JDateAndTime::JDateAndTime ( const char *const buffer )

inline

Constructor.

Parameters

buffer date and time

Definition at line 136 of file JDateAndTime.hh.

    {
      std::istringstream is(buffer);
 
      is >> *this;
    }

Member Function Documentation

◆ less()

bool JSYSTEM::JDateAndTime::less ( const JDateAndTime & object ) const

inline

Less than method.

Parameters

object date and time

Returns: true if this date and time is less than given date and time; else false

Definition at line 150 of file JDateAndTime.hh.

    {
      return getElapsedTime(object) > 0.0;
    }

◆ operator->()

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

inline

Smart pointer.

Returns: pointer to time structure

Definition at line 161 of file JDateAndTime.hh.

    {
      return get();
    }

◆ isUTC()

bool JSYSTEM::JDateAndTime::isUTC ( ) const

inline

Check if UTC time.

Returns: true if UTC time; else false

Definition at line 172 of file JDateAndTime.hh.

    {
      return utc;
    }

◆ getTime()

time_t JSYSTEM::JDateAndTime::getTime ( ) const

inline

time

Definition at line 178 of file JDateAndTime.hh.

◆ getSeconds()

int JSYSTEM::JDateAndTime::getSeconds ( ) const

inline

seconds after the minute [0-59]

Definition at line 180 of file JDateAndTime.hh.

◆ getMinutes()

int JSYSTEM::JDateAndTime::getMinutes ( ) const

inline

minutes after the hour [0-59]

Definition at line 181 of file JDateAndTime.hh.

◆ getHour()

int JSYSTEM::JDateAndTime::getHour ( ) const

inline

hours after midnight [0-23]

Definition at line 182 of file JDateAndTime.hh.

◆ getDay()

int JSYSTEM::JDateAndTime::getDay ( ) const

inline

day of the month [1-31]

Definition at line 183 of file JDateAndTime.hh.

◆ getMonth()

int JSYSTEM::JDateAndTime::getMonth ( ) const

inline

month of the year [1-12]

Definition at line 184 of file JDateAndTime.hh.

◆ getYear()

int JSYSTEM::JDateAndTime::getYear ( ) const

inline

year a.d.

Definition at line 185 of file JDateAndTime.hh.

◆ getDST()

int JSYSTEM::JDateAndTime::getDST ( ) const

inline

daylight saving time

Definition at line 186 of file JDateAndTime.hh.

◆ getFS()

float JSYSTEM::JDateAndTime::getFS ( ) const

inline

fraction of second

Definition at line 188 of file JDateAndTime.hh.

◆ min()

static JDateAndTime JSYSTEM::JDateAndTime::min ( const bool utc = false )

inlinestatic

Get minimum date and time.

Parameters

utc UTC

Returns: value

Definition at line 197 of file JDateAndTime.hh.

    {
      return JDateAndTime(0, utc);
    }

◆ max()

static JDateAndTime JSYSTEM::JDateAndTime::max ( const bool utc = false )

inlinestatic

Get maximum date and time.

Parameters

utc UTC

Returns: value

Definition at line 209 of file JDateAndTime.hh.

    {
      return JDateAndTime(std::numeric_limits<time_t>::max(), utc);
    }

◆ operator std::string()

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

inline

Type conversion operator.

Returns: ASCII formatted date and time

Definition at line 220 of file JDateAndTime.hh.

    {
      return this->toString();
    }

◆ isISO8601()

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 232 of file JDateAndTime.hh.

    {
      using namespace std;
 
      try {
 
        JDateAndTime t1(buffer);
 
        return true;
      }
      catch(const std::exception& error) {
        return false;
      }
    }

◆ toString()

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

inline

Get ASCII formatted date and time.

Returns: ASCII formatted date and time

Definition at line 253 of file JDateAndTime.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->get());
 
      return string(buffer, pos);
    }

◆ operator()()

const JDateAndTime & JSYSTEM::JDateAndTime::operator() ( const bool utc = false )

inline

Set date and time.

Parameters

utc UTC

Returns: date and time

Definition at line 272 of file JDateAndTime.hh.

    {
      set(utc);
 
      return *this;
    }

◆ set() [1/3]

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

inline

Set to current local time.

Parameters

utc UTC

Definition at line 285 of file JDateAndTime.hh.

    {
      time_t tx;
 
      time(&tx);
 
      set(tx, utc);
    }

◆ set() [2/3]

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

inline

Set to given time.

Parameters

t1	time [s]
utc	UTC

Definition at line 301 of file JDateAndTime.hh.

    {
      this->ts  = t1;
      this->utc = utc;
    }

◆ set() [3/3]

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

inline

Set to given time.

Parameters

t1	time [s]
f1	fraction of seconds
utc	UTC

Definition at line 315 of file JDateAndTime.hh.

    {
      this->ts  = t1;
      this->fs  = f1;
      this->utc = utc;
    }

◆ add()

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

inline

Add given time.

Parameters

t1 time [s]

Definition at line 328 of file JDateAndTime.hh.

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

◆ sub()

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

inline

Subtract given time.

Parameters

t1 time [s]

Definition at line 339 of file JDateAndTime.hh.

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

◆ getElapsedTime()

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 351 of file JDateAndTime.hh.

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

◆ get()

tm * JSYSTEM::JDateAndTime::get ( ) const

inlineprivate

Get representation.

Definition at line 492 of file JDateAndTime.hh.

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

Friends And Related Symbol Documentation

◆ operator>>

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 364 of file JDateAndTime.hh.

    {
      using namespace std;
 
      const size_t LENGTH = 10;                                     // date may contain '-' and/or be followed by ' '
 
      string buffer;
 
      for (int c; (c = in.peek()) != EOF && isspace((char) in.peek()); ) {
        in.ignore(1);
      }
 
      for (int c; (c = in.get()) != EOF && (c != ' ' || buffer.length() == LENGTH); ) {
        buffer.push_back((char) c);
      }
 
      if (in.bad()) {
        THROW(JIOException, "");
      }
 
      // separation of date and time from optional time zone
 
      size_t pos = string::npos;
 
      if (pos == string::npos) { pos = buffer.find('Z', LENGTH); }  // UTC
      if (pos == string::npos) { pos = buffer.find('+', LENGTH); }  // optional time zone
      if (pos == string::npos) { pos = buffer.find('-', LENGTH); }  // optional time zone
 
      tm     tx;
      object.fs = 0;                                                // fraction of seconds
      int    nd = 0;
 
      const string td = buffer.substr(0, pos);
      const char*  pd = NULL;
 
      switch (td.length()) {
 
      case 29:
      case 28:
      case 27:
      case 26:
      case 25:
      case 24:
      case 23:
      case 22:
      case 21:
        pd = strptime(td.c_str(), "%Y-%m-%d %H:%M:%S",  &tx);  sscanf(pd, "%f%n", &object.fs, &nd);  pd += nd;
        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;
 
      ty.tm_hour = 0;
      ty.tm_min  = 0;
 
      if (pos != string::npos && (buffer[pos] == '+' || 
                                  buffer[pos] == '-')) {
 
        const string tz = buffer.substr(pos + 1);
        const char*  pz = tz.c_str();
 
        switch (tz.length()) {
 
        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;                                              // switch off day light saving time
 
      time_t t1 = mktime(&tx);
 
      t1  -=  (ty.tm_hour * 60 + ty.tm_min) * 60;                   // correct time zone
      t1  +=  mktime(localtime(&t1)) - mktime(gmtime(&t1));         // 
 
      object.set(t1, buffer[pos] == 'Z');
      
      return in;
    }

◆ operator<<

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 481 of file JDateAndTime.hh.

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

Member Data Documentation

◆ ts

time_t JSYSTEM::JDateAndTime::ts

private

value

Definition at line 497 of file JDateAndTime.hh.

◆ fs

float JSYSTEM::JDateAndTime::fs = 0.0

private

fraction of second

Definition at line 498 of file JDateAndTime.hh.

◆ tp

tm* JSYSTEM::JDateAndTime::tp

mutableprivate

representation

Definition at line 499 of file JDateAndTime.hh.

◆ utc

bool JSYSTEM::JDateAndTime::utc = false

private

UTC.

Definition at line 500 of file JDateAndTime.hh.

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

JDateAndTime.hh

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JDateAndTime() [1/5]

◆ JDateAndTime() [2/5]

◆ JDateAndTime() [3/5]

◆ JDateAndTime() [4/5]

◆ JDateAndTime() [5/5]

Member Function Documentation

◆ less()

◆ operator->()

◆ isUTC()

◆ getTime()

◆ getSeconds()

◆ getMinutes()

◆ getHour()

◆ getDay()

◆ getMonth()

◆ getYear()

◆ getDST()

◆ getFS()

◆ min()

◆ max()

◆ operator std::string()

◆ isISO8601()

◆ toString()

◆ operator()()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ add()

◆ sub()

◆ getElapsedTime()

◆ get()

Friends And Related Symbol Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ ts

◆ fs

◆ tp

◆ utc