Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::local_time Namespace Reference

Classes

struct  ambiguous_result
 simple exception for reporting when STD or DST cannot be determined More...
 
struct  bad_adjustment
 simple exception for UTC daylight savings adjustment More...
 
struct  bad_offset
 simple exception for UTC and Daylight savings start/end offsets More...
 
class  custom_time_zone_base
 A real time zone. More...
 
struct  dst_not_valid
 
struct  first_last_rule_spec
 
struct  last_last_rule_spec
 
class  local_date_time_base
 Representation of "wall-clock" time in a particular time zone. More...
 
struct  nth_kday_rule_spec
 
struct  nth_last_rule_spec
 
struct  partial_date_rule_spec
 
class  posix_time_zone_base
 A time zone class constructed from a POSIX time zone string. More...
 
struct  time_label_invalid
 simple exception for when time label given cannot exist More...
 

Typedefs

typedef
boost::date_time::dst_adjustment_offsets
< boost::posix_time::time_duration
dst_adjustment_offsets
 
typedef boost::shared_ptr
< dst_calc_rule
dst_calc_rule_ptr
 
typedef custom_time_zone_base
< char > 
custom_time_zone
 
typedef
date_time::dst_day_calc_rule
< gregorian::date
dst_calc_rule
 Provides rule of the form starting Apr 30 ending Oct 21. More...
 
typedef
date_time::day_calc_dst_rule
< partial_date_rule_spec
partial_date_dst_rule
 Provides rule of the form first Sunday in April, last Saturday in Oct. More...
 
typedef
date_time::day_calc_dst_rule
< first_last_rule_spec
first_last_dst_rule
 Provides rule of the form first Sunday in April, last Saturday in Oct. More...
 
typedef
date_time::day_calc_dst_rule
< last_last_rule_spec
last_last_dst_rule
 Provides rule of the form last Sunday in April, last Saturday in Oct. More...
 
typedef
date_time::day_calc_dst_rule
< nth_last_rule_spec
nth_last_dst_rule
 Provides rule in form of [1st|2nd|3rd|4th] Sunday in April, last Sunday in Oct. More...
 
typedef
date_time::day_calc_dst_rule
< nth_kday_rule_spec
nth_kday_dst_rule
 Provides rule in form of [1st|2nd|3rd|4th] Sunday in April/October. More...
 
typedef
date_time::day_calc_dst_rule
< nth_kday_rule_spec
nth_day_of_the_week_in_month_dst_rule
 Provides rule in form of [1st|2nd|3rd|4th] Sunday in April/October. More...
 
typedef local_date_time_base local_date_time
 Use the default parameters to define local_date_time. More...
 
typedef
boost::date_time::time_facet
< local_date_time, wchar_t > 
wlocal_time_facet
 
typedef
boost::date_time::time_facet
< local_date_time, char > 
local_time_facet
 
typedef
boost::date_time::time_input_facet
< local_date_time::utc_time_type,
wchar_t > 
wlocal_time_input_facet
 
typedef
boost::date_time::time_input_facet
< local_date_time::utc_time_type,
char > 
local_time_input_facet
 
typedef
boost::date_time::period
< local_date_time,
boost::posix_time::time_duration
local_time_period
 
typedef date_time::time_itr
< local_date_time
local_time_iterator
 
typedef
date_time::second_clock
< local_date_time
local_sec_clock
 
typedef
date_time::microsec_clock
< local_date_time
local_microsec_clock
 
typedef
date_time::time_zone_base
< posix_time::ptime, char > 
time_zone
 
typedef
date_time::time_zone_base
< posix_time::ptime, wchar_t > 
wtime_zone
 
typedef boost::shared_ptr
< time_zone
time_zone_ptr
 Shared Pointer for custom_time_zone and posix_time_zone objects. More...
 
typedef boost::shared_ptr
< wtime_zone
wtime_zone_ptr
 
typedef
date_time::time_zone_names_base
< char > 
time_zone_names
 
typedef
date_time::time_zone_names_base
< wchar_t > 
wtime_zone_names
 
typedef posix_time_zone_base
< char > 
posix_time_zone
 
typedef date_time::tz_db_base
< custom_time_zone,
nth_kday_dst_rule
tz_database
 Object populated with boost::shared_ptr<time_zone_base> objects. More...
 

Functions

std::tm to_tm (const local_date_time &lt)
 Function that creates a tm struct from a local_date_time. More...
 
local_date_time operator+ (const local_date_time &t, const boost::gregorian::months &m)
 Adds a months object and a local_date_time. More...
 
local_date_time operator+= (local_date_time &t, const boost::gregorian::months &m)
 Adds a months object to a local_date_time. More...
 
local_date_time operator- (const local_date_time &t, const boost::gregorian::months &m)
 Subtracts a months object and a local_date_time. More...
 
local_date_time operator-= (local_date_time &t, const boost::gregorian::months &m)
 Subtracts a months object from a local_date_time. More...
 
local_date_time operator+ (const local_date_time &t, const boost::gregorian::years &y)
 Adds a years object and a local_date_time. More...
 
local_date_time operator+= (local_date_time &t, const boost::gregorian::years &y)
 Adds a years object to a local_date_time. More...
 
local_date_time operator- (const local_date_time &t, const boost::gregorian::years &y)
 Subtracts a years object and a local_date_time. More...
 
local_date_time operator-= (local_date_time &t, const boost::gregorian::years &y)
 Subtracts a years object from a local_date_time. More...
 
template<class CharT , class TraitsT >
std::basic_ostream< CharT,
TraitsT > & 
operator<< (std::basic_ostream< CharT, TraitsT > &os, const local_date_time &ldt)
 operator<< for local_date_time - see local_time docs for formatting details More...
 
template<class CharT , class Traits >
std::basic_istream< CharT,
Traits > & 
operator>> (std::basic_istream< CharT, Traits > &is, local_date_time &ldt)
 input operator for local_date_time More...
 
template<class CharT , class TraitsT >
std::basic_ostream< CharT,
TraitsT > & 
operator<< (std::basic_ostream< CharT, TraitsT > &os, const boost::local_time::local_time_period &p)
 output operator for local_time_period More...
 
template<class CharT , class Traits >
std::basic_istream< CharT,
Traits > & 
operator>> (std::basic_istream< CharT, Traits > &is, boost::local_time::local_time_period &tp)
 input operator for local_time_period More...
 

Typedef Documentation

Provides rule of the form starting Apr 30 ending Oct 21.

Provides rule of the form first Sunday in April, last Saturday in Oct.

Provides rule of the form last Sunday in April, last Saturday in Oct.

Use the default parameters to define local_date_time.

typedef date_time::microsec_clock<local_date_time> boost::local_time::local_microsec_clock

Provides rule in form of [1st|2nd|3rd|4th] Sunday in April/October.

Provides rule in form of [1st|2nd|3rd|4th] Sunday in April/October.

Provides rule in form of [1st|2nd|3rd|4th] Sunday in April, last Sunday in Oct.

Provides rule of the form first Sunday in April, last Saturday in Oct.

Shared Pointer for custom_time_zone and posix_time_zone objects.

Object populated with boost::shared_ptr<time_zone_base> objects.

Object populated with boost::shared_ptr<time_zone_base> objects Database is populated from specs stored in external csv file. See date_time::tz_db_base for greater detail

Function Documentation

local_date_time boost::local_time::operator+ ( const local_date_time &  t,
const boost::gregorian::months m 
)
inline

Adds a months object and a local_date_time.

Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details

References boost::date_time::months_duration< base_config >::get_offset(), and boost::local_time::local_date_time_base< utc_time_, tz_type >::utc_time().

local_date_time boost::local_time::operator+ ( const local_date_time &  t,
const boost::gregorian::years y 
)
inline

Adds a years object and a local_date_time.

Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details

References boost::date_time::years_duration< base_config >::get_offset(), and boost::local_time::local_date_time_base< utc_time_, tz_type >::utc_time().

local_date_time boost::local_time::operator+= ( local_date_time &  t,
const boost::gregorian::months m 
)
inline

Adds a months object to a local_date_time.

Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details

References boost::date_time::months_duration< base_config >::get_offset(), and boost::local_time::local_date_time_base< utc_time_, tz_type >::utc_time().

local_date_time boost::local_time::operator+= ( local_date_time &  t,
const boost::gregorian::years y 
)
inline

Adds a years object to a local_date_time.

Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details

References boost::date_time::years_duration< base_config >::get_offset(), and boost::local_time::local_date_time_base< utc_time_, tz_type >::utc_time().

local_date_time boost::local_time::operator- ( const local_date_time &  t,
const boost::gregorian::months m 
)
inline

Subtracts a months object and a local_date_time.

Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details

References boost::date_time::months_duration< base_config >::get_neg_offset(), and boost::local_time::local_date_time_base< utc_time_, tz_type >::utc_time().

local_date_time boost::local_time::operator- ( const local_date_time &  t,
const boost::gregorian::years y 
)
inline

Subtracts a years object and a local_date_time.

Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details

References boost::date_time::years_duration< base_config >::get_neg_offset(), and boost::local_time::local_date_time_base< utc_time_, tz_type >::utc_time().

local_date_time boost::local_time::operator-= ( local_date_time &  t,
const boost::gregorian::months m 
)
inline

Subtracts a months object from a local_date_time.

Result will be same day-of-month as local_date_time unless original day was the last day of month. see date_time::months_duration for more details

References boost::date_time::months_duration< base_config >::get_neg_offset(), and boost::local_time::local_date_time_base< utc_time_, tz_type >::utc_time().

Referenced by boost::rational< IntType >::operator-=().

local_date_time boost::local_time::operator-= ( local_date_time &  t,
const boost::gregorian::years y 
)
inline

Subtracts a years object from a local_date_time.

Result will be same month and day-of-month as local_date_time unless original day was the last day of month. see date_time::years_duration for more details

References boost::date_time::years_duration< base_config >::get_neg_offset(), and boost::local_time::local_date_time_base< utc_time_, tz_type >::utc_time().

template<class CharT , class TraitsT >
std::basic_ostream<CharT, TraitsT>& boost::local_time::operator<< ( std::basic_ostream< CharT, TraitsT > &  os,
const local_date_time &  ldt 
)
inline

operator<< for local_date_time - see local_time docs for formatting details

References boost::put().

template<class CharT , class TraitsT >
std::basic_ostream<CharT, TraitsT>& boost::local_time::operator<< ( std::basic_ostream< CharT, TraitsT > &  os,
const boost::local_time::local_time_period p 
)
inline

output operator for local_time_period

References boost::multiprecision::backends::p, and boost::put().

template<class CharT , class Traits >
std::basic_istream<CharT, Traits>& boost::local_time::operator>> ( std::basic_istream< CharT, Traits > &  is,
local_date_time &  ldt 
)
inline
template<class CharT , class Traits >
std::basic_istream<CharT, Traits>& boost::local_time::operator>> ( std::basic_istream< CharT, Traits > &  is,
boost::local_time::local_time_period tp 
)
inline

input operator for local_time_period

References boost::regex_constants::failbit.

std::tm boost::local_time::to_tm ( const local_date_time &  lt)
inline