local_time_autodoc.boostbook

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

          </typedef>
        </struct>
        <struct name="nth_kday_rule_spec">
          <typedef name="date_type">
            <type>gregorian::date</type>
          </typedef>
          <typedef name="start_rule">
            <type>gregorian::nth_kday_of_month</type>
          </typedef>
          <typedef name="end_rule">
            <type>gregorian::nth_kday_of_month</type>
          </typedef>
        </struct>
        <typedef name="dst_calc_rule">
          <purpose>Provides rule of the form starting Apr 30 ending Oct 21. </purpose>
          <type>date_time::dst_day_calc_rule&lt; gregorian::date &gt;</type>
        </typedef>
        <typedef name="partial_date_dst_rule">
          <purpose>Provides rule of the form first Sunday in April, last Saturday in Oct. </purpose>
          <type>date_time::day_calc_dst_rule&lt; partial_date_rule_spec &gt;</type>
        </typedef>
        <typedef name="first_last_dst_rule">
          <purpose>Provides rule of the form first Sunday in April, last Saturday in Oct. </purpose>
          <type>date_time::day_calc_dst_rule&lt; first_last_rule_spec &gt;</type>
        </typedef>
        <typedef name="last_last_dst_rule">
          <purpose>Provides rule of the form last Sunday in April, last Saturday in Oct. </purpose>
          <type>date_time::day_calc_dst_rule&lt; last_last_rule_spec &gt;</type>
        </typedef>
        <typedef name="nth_last_dst_rule">
          <purpose>Provides rule in form of [1st|2nd|3rd|4th] Sunday in April, last Sunday in Oct. </purpose>
          <type>date_time::day_calc_dst_rule&lt; nth_last_rule_spec &gt;</type>
        </typedef>
        <typedef name="nth_kday_dst_rule">
          <purpose>Provides rule in form of [1st|2nd|3rd|4th] Sunday in April/October. </purpose>
          <type>date_time::day_calc_dst_rule&lt; nth_kday_rule_spec &gt;</type>
        </typedef>
        <typedef name="nth_day_of_the_week_in_month_dst_rule">
          <purpose>Provides rule in form of [1st|2nd|3rd|4th] Sunday in April/October. </purpose>
          <type>date_time::day_calc_dst_rule&lt; nth_kday_rule_spec &gt;</type>
        </typedef>
      </namespace>
    </namespace>
  </header>
  <header name="boost/date_time/local_time/local_date_time.hpp">
    <namespace name="boost">
      <namespace name="local_time">
        <struct name="ambiguous_result">
          <purpose>simple exception for reporting when STD or DST cannot be determined </purpose>
          <method-group name="public member functions"/>
          <constructor>
            <parameter name="_msg">
              <paramtype>std::string</paramtype>
              <default>""</default>
            </parameter>
          </constructor>
        </struct>
        <struct name="time_label_invalid">
          <purpose>simple exception for when time label given cannot exist </purpose>
          <method-group name="public member functions"/>
          <constructor>
            <parameter name="_msg">
              <paramtype>std::string</paramtype>
              <default>""</default>
            </parameter>
          </constructor>
        </struct>
        <struct name="dst_not_valid">
          <method-group name="public member functions"/>
          <constructor>
            <parameter name="_msg">
              <paramtype>std::string</paramtype>
              <default>""</default>
            </parameter>
          </constructor>
        </struct>
        <class name="local_date_time_base">
          <template>
      <template-type-parameter name="utc_time_"><default>posix_time::ptime</default></template-type-parameter>
      <template-type-parameter name="tz_type"><default>date_time::time_zone_base&lt;utc_time_&gt;</default></template-type-parameter>
    </template>
          <purpose>Representation of "wall-clock" time in a particular time zone. </purpose>
          <description>
            <para>Representation of "wall-clock" time in a particular time zone Local_date_time_base holds a time value (date and time offset from 00:00) along with a time zone. The time value is stored as UTC and conversions to wall clock time are made as needed. This approach allows for operations between wall-clock times in different time zones, and daylight savings time considerations, to be made. Time zones are required to be in the form of a boost::shared_ptr&lt;time_zone_base&gt;. </para>
          </description>
          <typedef name="utc_time_type">
            <type>utc_time_</type>
          </typedef>
          <typedef name="time_duration_type">
            <type>utc_time_type::time_duration_type</type>
          </typedef>
          <typedef name="date_type">
            <type>utc_time_type::date_type</type>
          </typedef>
          <typedef name="date_duration_type">
            <type>date_type::duration_type</type>
          </typedef>
          <typedef name="time_system_type">
            <type>utc_time_type::time_system_type</type>
          </typedef>
          <enum name="DST_CALC_OPTIONS">
            <enumvalue name="EXCEPTION_ON_ERROR"/>
            <enumvalue name="NOT_DATE_TIME_ON_ERROR"/>
          </enum>
          <method-group name="public member functions">
            <method name="zone" cv="const">
              <type>boost::shared_ptr&lt; tz_type &gt;</type>
              <purpose>returns time zone associated with calling instance </purpose>
            </method>
            <method name="is_dst" cv="const">
              <type>bool</type>
              <purpose>returns false is time_zone is NULL and if time value is a special_value </purpose>
            </method>
            <method name="utc_time" cv="const">
              <type>utc_time_type</type>
              <purpose>Returns object's time value as a utc representation. </purpose>
            </method>
            <method name="local_time" cv="const">
              <type>utc_time_type</type>
              <purpose>Returns object's time value as a local representation. </purpose>
            </method>
            <method name="to_string" cv="const">
              <type>std::string</type>
              <purpose>Returns string in the form "2003-Aug-20 05:00:00 EDT". </purpose>
              <description>
                <para>Returns string in the form "2003-Aug-20 05:00:00 EDT". If time_zone is NULL the time zone abbreviation will be "UTC". The time zone abbrev will not be included if calling object is a special_value </para>
              </description>
            </method>
            <method name="local_time_in" cv="const">
              <type>
                <classname>local_date_time_base</classname>
              </type>
              <parameter name="new_tz">
                <paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype>
              </parameter>
              <parameter name="td">
                <paramtype>time_duration_type</paramtype>
                <default>time_duration_type(0, 0, 0)</default>
              </parameter>
              <description>
                <para>returns a local_date_time_base in the given time zone with the optional time_duration added. </para>
              </description>
            </method>
            <method name="zone_name" cv="const">
              <type>std::string</type>
              <parameter name="as_offset">
                <paramtype>bool</paramtype>
                <default>false</default>
              </parameter>
              <purpose>Returns name of associated time zone or "Coordinated Universal Time". </purpose>
              <description>
                <para>Optional bool parameter will return time zone as an offset (ie "+07:00" extended iso format). Empty string is returned for classes that do not use a time_zone </para>
              </description>
            </method>
            <method name="zone_abbrev" cv="const">
              <type>std::string</type>
              <parameter name="as_offset">
                <paramtype>bool</paramtype>
                <default>false</default>
              </parameter>
              <purpose>Returns abbreviation of associated time zone or "UTC". </purpose>
              <description>
                <para>Optional bool parameter will return time zone as an offset (ie "+0700" iso format). Empty string is returned for classes that do not use a time_zone </para>
              </description>
            </method>
            <method name="zone_as_posix_string" cv="const">
              <type>std::string</type>
              <purpose>returns a posix_time_zone string for the associated time_zone. If no time_zone, "UTC+00" is returned. </purpose>
            </method>
            <method name="operator==" cv="const">
              <type>bool</type>
              <parameter name="rhs">
                <paramtype>const <classname>local_date_time_base</classname> &amp;</paramtype>
              </parameter>
              <purpose>Equality comparison operator. </purpose>
            </method>
            <method name="operator!=" cv="const">
              <type>bool</type>
              <parameter name="rhs">
                <paramtype>const <classname>local_date_time_base</classname> &amp;</paramtype>
              </parameter>
              <purpose>Non-Equality comparison operator. </purpose>
            </method>
            <method name="operator&lt;" cv="const">
              <type>bool</type>
              <parameter name="rhs">
                <paramtype>const <classname>local_date_time_base</classname> &amp;</paramtype>
              </parameter>
              <purpose>Less than comparison operator. </purpose>
            </method>
            <method name="operator&lt;=" cv="const">
              <type>bool</type>
              <parameter name="rhs">
                <paramtype>const <classname>local_date_time_base</classname> &amp;</paramtype>
              </parameter>
              <purpose>Less than or equal to comparison operator. </purpose>
            </method>
            <method name="operator&gt;" cv="const">
              <type>bool</type>
              <parameter name="rhs">
                <paramtype>const <classname>local_date_time_base</classname> &amp;</paramtype>
              </parameter>
              <purpose>Greater than comparison operator. </purpose>
            </method>
            <method name="operator&gt;=" cv="const">
              <type>bool</type>
              <parameter name="rhs">
                <paramtype>const <classname>local_date_time_base</classname> &amp;</paramtype>
              </parameter>
              <purpose>Greater than or equal to comparison operator. </purpose>
            </method>
            <method name="operator+" cv="const">
              <type>
                <classname>local_date_time_base</classname>
              </type>
              <parameter name="dd">
                <paramtype>const date_duration_type &amp;</paramtype>
              </parameter>
              <purpose>Local_date_time + date_duration. </purpose>
            </method>
            <method name="operator+=" cv="">
              <type>
                <classname>local_date_time_base</classname>
              </type>
              <parameter name="dd">
                <paramtype>const date_duration_type &amp;</paramtype>
              </parameter>
              <purpose>Local_date_time += date_duration. </purpose>
            </method>
            <method name="operator-" cv="const">
              <type>
                <classname>local_date_time_base</classname>
              </type>
              <parameter name="dd">
                <paramtype>const date_duration_type &amp;</paramtype>
              </parameter>
              <purpose>Local_date_time - date_duration. </purpose>
            </method>
            <method name="operator-=" cv="">
              <type>
                <classname>local_date_time_base</classname>
              </type>
              <parameter name="dd">
                <paramtype>const date_duration_type &amp;</paramtype>
              </parameter>
              <purpose>Local_date_time -= date_duration. </purpose>
            </method>
            <method name="operator+" cv="const">
              <type>
                <classname>local_date_time_base</classname>
              </type>
              <parameter name="td">
                <paramtype>const time_duration_type &amp;</paramtype>
              </parameter>
              <purpose>Local_date_time + time_duration. </purpose>
            </method>
            <method name="operator+=" cv="">
              <type>
                <classname>local_date_time_base</classname>
              </type>
              <parameter name="td">
                <paramtype>const time_duration_type &amp;</paramtype>
              </parameter>
              <purpose>Local_date_time += time_duration. </purpose>
            </method>
            <method name="operator-" cv="const">
              <type>
                <classname>local_date_time_base</classname>
              </type>
              <parameter name="td">
                <paramtype>const time_duration_type &amp;</paramtype>