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::custom_time_zone_base< CharT > Class Template Referenceabstract

A real time zone. More...

#include <custom_time_zone.hpp>

Inheritance diagram for boost::local_time::custom_time_zone_base< CharT >:
Collaboration diagram for boost::local_time::custom_time_zone_base< CharT >:

Public Types

typedef
boost::posix_time::time_duration 
time_duration_type
 
typedef
date_time::time_zone_base
< posix_time::ptime, CharT > 
base_type
 
typedef base_type::string_type string_type
 
typedef
base_type::stringstream_type 
stringstream_type
 
typedef
date_time::time_zone_names_base
< CharT > 
time_zone_names
 
typedef CharT char_type
 
typedef
posix_time::ptime::date_type::year_type 
year_type
 

Public Member Functions

 custom_time_zone_base (const time_zone_names &zone_names, const time_duration_type &utc_offset, const dst_adjustment_offsets &dst_shift, boost::shared_ptr< dst_calc_rule > calc_rule)
 
virtual ~custom_time_zone_base ()
 
virtual string_type dst_zone_abbrev () const
 String for the timezone when in daylight savings (eg: EDT) More...
 
virtual string_type std_zone_abbrev () const
 String for the zone when not in daylight savings (eg: EST) More...
 
virtual string_type dst_zone_name () const
 String for the timezone when in daylight savings (eg: Eastern Daylight Time) More...
 
virtual string_type std_zone_name () const
 String for the zone when not in daylight savings (eg: Eastern Standard Time) More...
 
virtual bool has_dst () const
 True if zone uses daylight savings adjustments. More...
 
virtual posix_time::ptime dst_local_start_time (gregorian::greg_year y) const
 Local time that DST starts – NADT if has_dst is false. More...
 
virtual posix_time::ptime dst_local_end_time (gregorian::greg_year y) const
 Local time that DST ends – NADT if has_dst is false. More...
 
virtual time_duration_type base_utc_offset () const
 Base offset from UTC for zone (eg: -07:30:00) More...
 
virtual time_duration_type dst_offset () const
 Adjustment forward or back made while DST is in effect. More...
 
virtual string_type to_posix_string () const
 Returns a POSIX time_zone string for this object. More...
 
virtual posix_time::ptime dst_local_start_time (year_type y) const =0
 Local time that DST starts – undefined if has_dst is false. More...
 
virtual posix_time::ptime dst_local_end_time (year_type y) const =0
 Local time that DST ends – undefined if has_dst is false. More...
 

Detailed Description

template<class CharT>
class boost::local_time::custom_time_zone_base< CharT >

A real time zone.

Member Typedef Documentation

template<class CharT >
typedef CharT boost::local_time::custom_time_zone_base< CharT >::char_type
typedef posix_time::ptime ::date_type::year_type boost::date_time::time_zone_base< posix_time::ptime , CharT >::year_type
inherited

Constructor & Destructor Documentation

template<class CharT >
boost::local_time::custom_time_zone_base< CharT >::custom_time_zone_base ( const time_zone_names zone_names,
const time_duration_type utc_offset,
const dst_adjustment_offsets dst_shift,
boost::shared_ptr< dst_calc_rule calc_rule 
)
inline
template<class CharT >
virtual boost::local_time::custom_time_zone_base< CharT >::~custom_time_zone_base ( )
inlinevirtual

Member Function Documentation

template<class CharT >
virtual time_duration_type boost::local_time::custom_time_zone_base< CharT >::base_utc_offset ( ) const
inlinevirtual
virtual posix_time::ptime boost::date_time::time_zone_base< posix_time::ptime , CharT >::dst_local_end_time ( year_type  y) const
pure virtualinherited

Local time that DST ends – undefined if has_dst is false.

template<class CharT >
virtual posix_time::ptime boost::local_time::custom_time_zone_base< CharT >::dst_local_end_time ( gregorian::greg_year  y) const
inlinevirtual

Local time that DST ends – NADT if has_dst is false.

References boost::date_time::dst_adjustment_offsets< time_duration_type >::dst_end_offset_, and boost::date_time::not_a_date_time.

virtual posix_time::ptime boost::date_time::time_zone_base< posix_time::ptime , CharT >::dst_local_start_time ( year_type  y) const
pure virtualinherited

Local time that DST starts – undefined if has_dst is false.

template<class CharT >
virtual posix_time::ptime boost::local_time::custom_time_zone_base< CharT >::dst_local_start_time ( gregorian::greg_year  y) const
inlinevirtual

Local time that DST starts – NADT if has_dst is false.

References boost::date_time::dst_adjustment_offsets< time_duration_type >::dst_start_offset_, and boost::date_time::not_a_date_time.

template<class CharT >
virtual time_duration_type boost::local_time::custom_time_zone_base< CharT >::dst_offset ( ) const
inlinevirtual
template<class CharT >
virtual string_type boost::local_time::custom_time_zone_base< CharT >::dst_zone_abbrev ( ) const
inlinevirtual
template<class CharT >
virtual string_type boost::local_time::custom_time_zone_base< CharT >::dst_zone_name ( ) const
inlinevirtual

String for the timezone when in daylight savings (eg: Eastern Daylight Time)

Implements boost::date_time::time_zone_base< posix_time::ptime, CharT >.

References boost::date_time::time_zone_names_base< CharT >::dst_zone_name().

template<class CharT >
virtual bool boost::local_time::custom_time_zone_base< CharT >::has_dst ( ) const
inlinevirtual

True if zone uses daylight savings adjustments.

Implements boost::date_time::time_zone_base< posix_time::ptime, CharT >.

template<class CharT >
virtual string_type boost::local_time::custom_time_zone_base< CharT >::std_zone_abbrev ( ) const
inlinevirtual
template<class CharT >
virtual string_type boost::local_time::custom_time_zone_base< CharT >::std_zone_name ( ) const
inlinevirtual

String for the zone when not in daylight savings (eg: Eastern Standard Time)

Implements boost::date_time::time_zone_base< posix_time::ptime, CharT >.

References boost::date_time::time_zone_names_base< CharT >::std_zone_name().


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