local_time_autodoc.boostbook

C++的一个好库。。。现在很流行

 Jn {n=1-365 Feb29 is never counted}
 n {n=0-365 Feb29 is counted in leap years}
 Example "PST-5PDT01:00:00,M4.1.0/02:00:00,M10.1.0/02:00:00" 
 Exceptions will be thrown under these conditions:<br> An invalid date spec (see date class)
 A boost::local_time::bad_offset exception will be thrown for:<br> A DST start or end offset that is negative or more than 24 hours
 A UTC zone that is greater than +12 or less than -12 hours
 A boost::local_time::bad_adjustment exception will be thrown for:<br> A DST adjustment that is 24 hours or more (positive or negative)
 </para>
          </description>
          <typedef name="time_duration_type">
            <type>boost::posix_time::time_duration</type>
          </typedef>
          <typedef name="tokenizer">
            <type>boost::tokenizer&lt; boost::char_separator&lt; char &gt; &gt;</type>
          </typedef>
          <typedef name="base_type">
            <type>
              <classname>time_zone</classname>
            </type>
          </typedef>
          <typedef name="string_type">
            <type>base_type::string_type</type>
          </typedef>
          <typedef name="stringstream_type">
            <type>base_type::stringstream_type</type>
          </typedef>
          <method-group name="public member functions">
            <method name="std_zone_abbrev" cv="const">
              <type>virtual std::string</type>
              <purpose>String for the zone when not in daylight savings (eg: EST). </purpose>
            </method>
            <method name="dst_zone_abbrev" cv="const">
              <type>virtual std::string</type>
              <purpose>String for the timezone when in daylight savings (eg: EDT). </purpose>
              <description>
                <para>For those time zones that have no DST, an empty string is used </para>
              </description>
            </method>
            <method name="std_zone_name" cv="const">
              <type>virtual std::string</type>
              <purpose>String for the zone when not in daylight savings (eg: Eastern Standard Time). </purpose>
              <description>
                <para>The full STD name is not extracted from the posix time zone string. Therefore, the STD abbreviation is used in it's place </para>
              </description>
            </method>
            <method name="dst_zone_name" cv="const">
              <type>virtual std::string</type>
              <purpose>String for the timezone when in daylight savings (eg: Eastern Daylight Time). </purpose>
              <description>
                <para>The full DST name is not extracted from the posix time zone string. Therefore, the STD abbreviation is used in it's place. For time zones that have no DST, an empty string is used </para>
              </description>
            </method>
            <method name="has_dst" cv="const">
              <type>virtual bool</type>
              <purpose>True if zone uses daylight savings adjustments otherwise false. </purpose>
            </method>
            <method name="dst_local_start_time" cv="const">
              <type>virtual posix_time::ptime</type>
              <parameter name="y">
                <paramtype>gregorian::greg_year</paramtype>
              </parameter>
              <purpose>Local time that DST starts -- NADT if has_dst is false. </purpose>
            </method>
            <method name="dst_local_end_time" cv="const">
              <type>virtual posix_time::ptime</type>
              <parameter name="y">
                <paramtype>gregorian::greg_year</paramtype>
              </parameter>
              <purpose>Local time that DST ends -- NADT if has_dst is false. </purpose>
            </method>
            <method name="base_utc_offset" cv="const">
              <type>virtual time_duration_type</type>
              <purpose>Base offset from UTC for zone (eg: -07:30:00). </purpose>
            </method>
            <method name="dst_offset" cv="const">
              <type>virtual time_duration_type</type>
              <purpose>Adjustment forward or back made while DST is in effect. </purpose>
            </method>
            <method name="to_posix_string" cv="const">
              <type>virtual string_type</type>
              <purpose>Returns a POSIX time_zone string for this object. </purpose>
            </method>
          </method-group>
          <constructor>
            <parameter name="s">
              <paramtype>const std::string &amp;</paramtype>
            </parameter>
            <purpose>Construct from a POSIX time zone string. </purpose>
          </constructor>
          <destructor/>
          <method-group name="private member functions">
            <method name="calc_zone" cv="">
              <type>void</type>
              <parameter name="obj">
                <paramtype>const std::string &amp;</paramtype>
              </parameter>
              <description>
                <para>Extract time zone abbreviations for STD &amp; DST as well as the offsets for the time the shift occurs and how much of a shift. At this time full time zone names are NOT extracted so the abbreviations are used in their place </para>
              </description>
            </method>
            <method name="calc_rules" cv="">
              <type>void</type>
              <parameter name="start">
                <paramtype>const std::string &amp;</paramtype>
              </parameter>
              <parameter name="end">
                <paramtype>const std::string &amp;</paramtype>
              </parameter>
            </method>
            <method name="M_func" cv="">
              <type>void</type>
              <parameter name="s">
                <paramtype>const std::string &amp;</paramtype>
              </parameter>
              <parameter name="e">
                <paramtype>const std::string &amp;</paramtype>
              </parameter>
            </method>
            <method name="julian_no_leap" cv="">
              <type>void</type>
              <parameter name="s">
                <paramtype>const std::string &amp;</paramtype>
              </parameter>
              <parameter name="e">
                <paramtype>const std::string &amp;</paramtype>
              </parameter>
              <purpose>Julian day. Feb29 is never counted, even in leap years. </purpose>
            </method>
            <method name="julian_day" cv="">
              <type>void</type>
              <parameter name="s">
                <paramtype>const std::string &amp;</paramtype>
              </parameter>
              <parameter name="e">
                <paramtype>const std::string &amp;</paramtype>
              </parameter>
              <purpose>Julian day. Feb29 is always counted, but exception thrown in non-leap years. </purpose>
            </method>
          </method-group>
          <method-group name="private static functions">
            <method name="td_as_string" cv="">
              <type>std::string</type>
              <parameter name="td">
                <paramtype>const time_duration_type &amp;</paramtype>
              </parameter>
              <purpose>helper function used when throwing exceptions </purpose>
            </method>
          </method-group>
        </class>
        <typedef name="time_zone_names">
          <type>boost::date_time::time_zone_names</type>
        </typedef>
        <typedef name="dst_adjustment_offsets">
          <type>boost::date_time::dst_adjustment_offsets&lt; boost::posix_time::time_duration &gt;</type>
        </typedef>
        <typedef name="time_zone">
          <type>boost::date_time::time_zone_base&lt; boost::posix_time::ptime &gt;</type>
        </typedef>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/local_time/time_zone.hpp">
    <namespace name="boost">
      <namespace name="local_time">
        <class name="time_zone">
          <purpose>A real time zone. </purpose>
          <typedef name="time_duration_type">
            <type>boost::posix_time::time_duration</type>
          </typedef>
          <typedef name="base_type">
            <type>time_zone_base</type>
          </typedef>
          <typedef name="string_type">
            <type>base_type::string_type</type>
          </typedef>
          <typedef name="stringstream_type">
            <type>base_type::stringstream_type</type>
          </typedef>
          <method-group name="public member functions">
            <method name="dst_zone_abbrev" cv="const">
              <type>virtual std::string</type>
            </method>
            <method name="std_zone_abbrev" cv="const">
              <type>virtual std::string</type>
            </method>
            <method name="dst_zone_name" cv="const">
              <type>virtual std::string</type>
            </method>
            <method name="std_zone_name" cv="const">
              <type>virtual std::string</type>
            </method>
            <method name="has_dst" cv="const">
              <type>virtual bool</type>
              <purpose>True if zone uses daylight savings adjustments. </purpose>
            </method>
            <method name="dst_local_start_time" cv="const">
              <type>virtual posix_time::ptime</type>
              <parameter name="y">
                <paramtype>gregorian::greg_year</paramtype>
              </parameter>
              <purpose>Local time that DST starts -- NADT if has_dst is false. </purpose>
            </method>
            <method name="dst_local_end_time" cv="const">
              <type>virtual posix_time::ptime</type>
              <parameter name="y">
                <paramtype>gregorian::greg_year</paramtype>
              </parameter>
              <purpose>Local time that DST ends -- NADT if has_dst is false. </purpose>
            </method>
            <method name="base_utc_offset" cv="const">
              <type>virtual time_duration_type</type>
              <purpose>Base offset from UTC for zone (eg: -07:30:00). </purpose>
            </method>
            <method name="dst_offset" cv="const">
              <type>virtual time_duration_type</type>
              <purpose>Adjustment forward or back made while DST is in effect. </purpose>
            </method>
            <method name="to_posix_string" cv="const">
              <type>virtual string_type</type>
              <purpose>Returns a POSIX time_zone string for this object. </purpose>
            </method>
          </method-group>
          <constructor>
            <parameter name="zone_names">
              <paramtype>const time_zone_names &amp;</paramtype>
            </parameter>
            <parameter name="base_utc_offset">
              <paramtype>const time_duration_type &amp;</paramtype>
            </parameter>
            <parameter name="dst_offset">
              <paramtype>const dst_adjustment_offsets &amp;</paramtype>
            </parameter>
            <parameter name="calc_rule">
              <paramtype>boost::shared_ptr&lt; dst_calc_rule &gt;</paramtype>
            </parameter>
          </constructor>
          <destructor/>
        </class>
        <typedef name="time_zone_names">
          <type>boost::date_time::time_zone_names</type>
        </typedef>
        <typedef name="dst_adjustment_offsets">
          <type>boost::date_time::dst_adjustment_offsets&lt; boost::posix_time::time_duration &gt;</type>
        </typedef>
        <typedef name="time_zone">
          <type>boost::date_time::time_zone_base&lt; boost::posix_time::ptime &gt;</type>
        </typedef>
        <typedef name="dst_calc_rule_ptr">
          <type>boost::shared_ptr&lt; dst_calc_rule &gt;</type>
        </typedef>
        <typedef name="time_zone_base">
          <type>boost::date_time::time_zone_base&lt; boost::posix_time::ptime &gt;</type>
        </typedef>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/local_time/tz_database.hpp">
    <namespace name="boost">
      <namespace name="local_time">
        <typedef name="tz_database">
          <purpose>Object populated with boost::shared_ptr&lt;time_zone_base&gt; objects. </purpose>
          <description>
            <para>Object populated with boost::shared_ptr&lt;time_zone_base&gt; objects Database is populated from specs stored in external csv file. See date_time::tz_db_base for greater detail </para>
          </description>
          <type>date_time::tz_db_base&lt; <classname>custom_time_zone</classname>, nth_kday_dst_rule &gt;</type>
        </typedef>
      </namespace>
    </namespace>
  </header>
</section>