CppCMS
Public Member Functions
booster::locale::date_time Class Reference

this class represents a date time and allows to perform various operation according to the locale settings. More...

#include <booster/booster/locale/date_time.h>

List of all members.

Public Member Functions

 date_time ()
 date_time (date_time const &other)
 date_time (date_time const &other, date_time_period_set const &set)
date_time const & operator= (date_time const &other)
 date_time (double time)
 date_time (double time, calendar const &cal)
 date_time (calendar const &cal)
 date_time (date_time_period_set const &set)
 date_time (date_time_period_set const &set, calendar const &cal)
date_time const & operator= (date_time_period_set const &f)
void set (period::period_type f, int v)
int get (period::period_type f) const
int operator/ (period::period_type f) const
date_time operator+ (period::period_type f) const
date_time operator- (period::period_type f) const
date_time const & operator+= (period::period_type f)
date_time const & operator-= (period::period_type f)
date_time operator<< (period::period_type f) const
date_time operator>> (period::period_type f) const
date_time const & operator<<= (period::period_type f)
date_time const & operator>>= (period::period_type f)
date_time operator+ (date_time_period const &v) const
date_time operator- (date_time_period const &v) const
date_time const & operator+= (date_time_period const &v)
date_time const & operator-= (date_time_period const &v)
date_time operator<< (date_time_period const &v) const
date_time operator>> (date_time_period const &v) const
date_time const & operator<<= (date_time_period const &v)
date_time const & operator>>= (date_time_period const &v)
date_time operator+ (date_time_period_set const &v) const
date_time operator- (date_time_period_set const &v) const
date_time const & operator+= (date_time_period_set const &v)
date_time const & operator-= (date_time_period_set const &v)
date_time operator<< (date_time_period_set const &v) const
date_time operator>> (date_time_period_set const &v) const
date_time const & operator<<= (date_time_period_set const &v)
date_time const & operator>>= (date_time_period_set const &v)
double time () const
void time (double v)
bool operator== (date_time const &other) const
bool operator!= (date_time const &other) const
bool operator< (date_time const &other) const
bool operator> (date_time const &other) const
bool operator<= (date_time const &other) const
bool operator>= (date_time const &other) const
void swap (date_time &other)
int difference (date_time const &other, period::period_type f) const
int minimum (period::period_type f) const
int maximum (period::period_type f) const
bool is_in_daylight_saving_time () const

Detailed Description

this class represents a date time and allows to perform various operation according to the locale settings.

This class allows to manipulate various aspects of dates and times easily using arithmetic operations with periods.

General arithmetic functions:

You can also assign specific periods using assignment operator like: some_time = year * 1995 that sets the year to 1995.


Constructor & Destructor Documentation

Dafault constructor, uses default calendar initialized date_time object to current time.

Note:
throws std::bad_cast if the global locale does not have calendar_facet facet installed

copy date_time

copy date_time and change some fields according to the set

Create a date_time object using POSIX time time and default calendar

Note:
throws std::bad_cast if the global locale does not have calendar_facet facet installed
booster::locale::date_time::date_time ( double  time,
calendar const &  cal 
)

Create a date_time object using POSIX time time and calendar cal

Create a date_time object using calendar cal and initializes it to current time.

Create a date_time object using default calendar and define values given in set

Note:
throws std::bad_cast if the global locale does not have calendar_facet facet installed

Create a date_time object using calendar cal and define values given in set


Member Function Documentation

calculate the distance from this date_time to other in terms of perios f

Referenced by booster::locale::date_time_duration::get(), and booster::locale::date_time_duration::operator/().

Check if *this time point is in daylight saving time

Get minimal possible value for *this time point for a period f. For example in February maximum(day) may be 28 or 29, in January maximum(day)==31

Get minimal possible value for *this time point for a period f.

bool booster::locale::date_time::operator!= ( date_time const &  other) const

compare date_time in the timeline (ignores difference in calendar, timezone etc)

date_time booster::locale::date_time::operator+ ( period::period_type  f) const [inline]

add single period f to the current date_time

date_time booster::locale::date_time::operator+ ( date_time_period const &  v) const

add date_time_period to the current date_time

date_time booster::locale::date_time::operator+ ( date_time_period_set const &  v) const

add date_time_period_set v to the current date_time

date_time const& booster::locale::date_time::operator+= ( period::period_type  f) [inline]

add single period f to the current date_time

date_time const& booster::locale::date_time::operator+= ( date_time_period const &  v)

add date_time_period to the current date_time

date_time const& booster::locale::date_time::operator+= ( date_time_period_set const &  v)

add date_time_period_set v to the current date_time

date_time booster::locale::date_time::operator- ( period::period_type  f) const [inline]

subtract single period f from the current date_time

date_time booster::locale::date_time::operator- ( date_time_period const &  v) const

subtract date_time_period from the current date_time

date_time booster::locale::date_time::operator- ( date_time_period_set const &  v) const

subtract date_time_period_set v from the current date_time

date_time const& booster::locale::date_time::operator-= ( period::period_type  f) [inline]

subtract single period f from the current date_time

date_time const& booster::locale::date_time::operator-= ( date_time_period const &  v)

subtract date_time_period from the current date_time

date_time const& booster::locale::date_time::operator-= ( date_time_period_set const &  v)

subtract date_time_period_set v from the current date_time

int booster::locale::date_time::operator/ ( period::period_type  f) const [inline]

syntactic sugar for get(f)

bool booster::locale::date_time::operator< ( date_time const &  other) const

compare date_time in the timeline (ignores difference in calendar, timezone etc)

date_time booster::locale::date_time::operator<< ( period::period_type  f) const [inline]

roll forward a date by single period f.

date_time booster::locale::date_time::operator<< ( date_time_period const &  v) const

roll current date_time forward by date_time_period v

date_time booster::locale::date_time::operator<< ( date_time_period_set const &  v) const

roll current date_time forward by date_time_period_set v

date_time const& booster::locale::date_time::operator<<= ( period::period_type  f) [inline]

roll forward a date by single period f.

date_time const& booster::locale::date_time::operator<<= ( date_time_period const &  v)

roll current date_time forward by date_time_period v

date_time const& booster::locale::date_time::operator<<= ( date_time_period_set const &  v)

roll current date_time forward by date_time_period_set v

bool booster::locale::date_time::operator<= ( date_time const &  other) const

compare date_time in the timeline (ignores difference in calendar, timezone etc)

date_time const& booster::locale::date_time::operator= ( date_time const &  other)

assign the date_time

date_time const& booster::locale::date_time::operator= ( date_time_period_set const &  f)

assign values to various periods in set f

bool booster::locale::date_time::operator== ( date_time const &  other) const

compare date_time in the timeline (ignores difference in calendar, timezone etc)

bool booster::locale::date_time::operator> ( date_time const &  other) const

compare date_time in the timeline (ignores difference in calendar, timezone etc)

bool booster::locale::date_time::operator>= ( date_time const &  other) const

compare date_time in the timeline (ignores difference in calendar, timezone etc)

date_time booster::locale::date_time::operator>> ( period::period_type  f) const [inline]

roll backward a date by single period f.

date_time booster::locale::date_time::operator>> ( date_time_period const &  v) const

roll current date_time backward by date_time_period v

date_time booster::locale::date_time::operator>> ( date_time_period_set const &  v) const

roll current date_time backward by date_time_period_set v

date_time const& booster::locale::date_time::operator>>= ( period::period_type  f) [inline]

roll backward a date by single period f.

date_time const& booster::locale::date_time::operator>>= ( date_time_period const &  v)

roll current date_time backward by date_time_period v

date_time const& booster::locale::date_time::operator>>= ( date_time_period_set const &  v)

roll current date_time backward by date_time_period_set v

set specific period f value to v

swaps two dates - efficient, does not throw

Get POSIX time

The POSIX time is number of seconds since January 1st, 1970 00:00 UTC, ignoring leap seconds.

Referenced by booster::locale::operator<<(), and booster::locale::operator>>().

set POSIX time

The POSIX time is number of seconds since January 1st, 1970 00:00 UTC, ignoring leap seconds. This time can be fetched from Operating system clock using C function time, gettimeofday and others.


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