Boost C++ Libraries of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of Boost. Click here to view this page for the latest version.

Class template custom_time_zone_base

boost::local_time::custom_time_zone_base — A real time zone.


// In header: <boost/date_time/local_time/custom_time_zone.hpp>

template<typename CharT> 
class custom_time_zone_base {
  // 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;         

  // construct/copy/destruct
  custom_time_zone_base(const time_zone_names &, const time_duration_type &, 
                        const dst_adjustment_offsets &, 
                        boost::shared_ptr< dst_calc_rule >);

  // public member functions
  string_type dst_zone_abbrev() const;
  string_type std_zone_abbrev() const;
  string_type dst_zone_name() const;
  string_type std_zone_name() const;
  bool has_dst() const;
  posix_time::ptime dst_local_start_time(gregorian::greg_year) const;
  posix_time::ptime dst_local_end_time(gregorian::greg_year) const;
  time_duration_type base_utc_offset() const;
  time_duration_type dst_offset() const;
  string_type to_posix_string() const;


custom_time_zone_base public construct/copy/destruct

  1. 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);
  2. ~custom_time_zone_base();

custom_time_zone_base public member functions

  1. string_type dst_zone_abbrev() const;
  2. string_type std_zone_abbrev() const;
  3. string_type dst_zone_name() const;
  4. string_type std_zone_name() const;
  5. bool has_dst() const;
    True if zone uses daylight savings adjustments.
  6. posix_time::ptime dst_local_start_time(gregorian::greg_year y) const;
    Local time that DST starts -- NADT if has_dst is false.
  7. posix_time::ptime dst_local_end_time(gregorian::greg_year y) const;
    Local time that DST ends -- NADT if has_dst is false.
  8. time_duration_type base_utc_offset() const;
    Base offset from UTC for zone (eg: -07:30:00).
  9. time_duration_type dst_offset() const;
    Adjustment forward or back made while DST is in effect.
  10. string_type to_posix_string() const;
    Returns a POSIX time_zone string for this object.