JSYSTEM::JDateAndTime Struct Reference

Auxililary class to get date and time. More...

#include <JDate.hh>

Public Member Functions
	JDateAndTime ()
	Default constructor. More...
	JDateAndTime (const time_t t1)
	Constructor. More...
tm *	operator-> ()
	Smart pointer. More...
const tm *	operator-> () const
	Smart pointer. 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...
	operator std::string () const
	Type conversion operator. More...
std::string	toString (const JDateAndTimeFormat option=HUMAN_READABLE) const
	Get ASCII formatted date and time. More...
const JDateAndTime &	operator() () const
	Set date and time. More...
void	set () const
	Set to actual time. More...
void	set (const time_t t1) const
	Set to given time. More...
double	getElapsedTime (const JDateAndTime &object) const
	Get elapsed time since given date and time. More...

Private Attributes
time_t	ts
tm *	tp

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

Detailed Description

Auxililary class to get date and time.

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

Constructor & Destructor Documentation

JSYSTEM::JDateAndTime::JDateAndTime ( )

inline

Default constructor.

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

    {
      set();
    }

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

inline

Constructor.

Parameters

t1

time

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

    {
      set(t1);
    }

Member Function Documentation

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

inline

Smart pointer.

Returns

pointer to time structure

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

    {
      return tp;
    }

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

inline

Smart pointer.

Returns

pointer to time structure

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

    {
      return tp;
    }

int JSYSTEM::JDateAndTime::getSeconds ( ) const

inline

seconds after the minute [0-59]

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

int JSYSTEM::JDateAndTime::getMinutes ( ) const

inline

minutes after the hour [0-59]

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

int JSYSTEM::JDateAndTime::getHour ( ) const

inline

hours after midnight [0-23]

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

int JSYSTEM::JDateAndTime::getDay ( ) const

inline

day of the month [1-31]

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

int JSYSTEM::JDateAndTime::getMonth ( ) const

inline

month of the year [1-12]

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

int JSYSTEM::JDateAndTime::getYear ( ) const

inline

year a.d.

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

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

inline

Type conversion operator.

Returns

ASCII formatted date and time

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

    {
      return toString();
    }

std::string JSYSTEM::JDateAndTime::toString ( const JDateAndTimeFormat  option = HUMAN_READABLE ) const

inline

Get ASCII formatted date and time.

Parameters

option

formatting option

Returns

ASCII formatted date and time

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

    {
      using namespace std;

      mktime(tp);
      
      static const int        MAX_SIZE = 256;
      static char      buffer[MAX_SIZE];
      
      switch (option) {
        
      case ISO8601:
        strftime(buffer, MAX_SIZE, "%FT%T%z",           tp);
        break;
        
      case HUMAN_READABLE:
        strftime(buffer, MAX_SIZE, "%a %b %d %X %Z %Y", tp);
        break;

      default:
        THROW(JLANG::JValueOutOfRange, "JDateAndTime::toString(): Invalid formatting option.");
      }
      
      // remove the last character (carriage return) from the date string
      
      buffer[MAX_SIZE-1] = '\0';
      
      return string(buffer);
    }

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

inline

Set date and time.

Returns

date and time

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

    {
      set();

      return *this;
    }

void JSYSTEM::JDateAndTime::set ( ) const

inline

Set to actual time.

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

    {
      time(&ts);

      tp = localtime(&ts);
    }

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

inline

Set to given time.

Parameters

t1

time

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

    {
      ts = t1;
      tp = localtime(&t1);
    }

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

inline

Get elapsed time since given date and time.

Parameters

object

date and time

Returns

time [s]

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

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

Friends And Related Function Documentation

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

friend

Write date and time to output.

Parameters

out	output stream
object	date and time

Returns

output stream

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

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

Member Data Documentation

time_t JSYSTEM::JDateAndTime::ts

mutableprivate

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

tm* JSYSTEM::JDateAndTime::tp

mutableprivate

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

---

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

• JSystem/JDate.hh