ceph/src/boost/libs/date_time/xmldoc/local_time_autodoc.xml

   1 <?xml version="1.0" standalone="yes"?>
   2 <library-reference id="local_time_reference"><title>Local Time Reference</title><header name="boost/date_time/local_time/conversion.hpp">
   3 <namespace name="boost">
   4 <namespace name="local_time">
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17 <function name="to_tm"><type>std::tm</type><parameter name="lt"><paramtype>const <classname>local_date_time</classname> &amp;</paramtype></parameter><purpose>Function that creates a tm struct from a local_date_time. </purpose></function>
  18 </namespace>
  19 </namespace>
  20 </header>
  21 <header name="boost/date_time/local_time/custom_time_zone.hpp">
  22 <namespace name="boost">
  23 <namespace name="local_time">
  24 <class name="custom_time_zone_base"><template>
  25       <template-type-parameter name="CharT"/>
  26     </template><inherit access="public">date_time::time_zone_base&lt; posix_time::ptime, CharT &gt;</inherit><purpose>A real time zone. </purpose><typedef name="time_duration_type"><type>boost::posix_time::time_duration</type></typedef>
  27 <typedef name="base_type"><type>date_time::time_zone_base&lt; posix_time::ptime, CharT &gt;</type></typedef>
  28 <typedef name="string_type"><type>base_type::string_type</type></typedef>
  29 <typedef name="stringstream_type"><type>base_type::stringstream_type</type></typedef>
  30 <typedef name="time_zone_names"><type>date_time::time_zone_names_base&lt; CharT &gt;</type></typedef>
  31 <typedef name="char_type"><type>CharT</type></typedef>
  32 <method-group name="public member functions">
  33 <method name="dst_zone_abbrev" cv="const" specifiers="virtual"><type>string_type</type></method>
  34 <method name="std_zone_abbrev" cv="const" specifiers="virtual"><type>string_type</type></method>
  35 <method name="dst_zone_name" cv="const" specifiers="virtual"><type>string_type</type></method>
  36 <method name="std_zone_name" cv="const" specifiers="virtual"><type>string_type</type></method>
  37 <method name="has_dst" cv="const" specifiers="virtual"><type>bool</type><purpose>True if zone uses daylight savings adjustments. </purpose></method>
  38 <method name="dst_local_start_time" cv="const" specifiers="virtual"><type>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>
  39 <method name="dst_local_end_time" cv="const" specifiers="virtual"><type>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>
  40 <method name="base_utc_offset" cv="const" specifiers="virtual"><type>time_duration_type</type><purpose>Base offset from UTC for zone (eg: -07:30:00) </purpose></method>
  41 <method name="dst_offset" cv="const" specifiers="virtual"><type>time_duration_type</type><purpose>Adjustment forward or back made while DST is in effect. </purpose></method>
  42 <method name="to_posix_string" cv="const" specifiers="virtual"><type>string_type</type><purpose>Returns a POSIX time_zone string for this object. </purpose></method>
  43 </method-group>
  44 <constructor><parameter name="zone_names"><paramtype>const time_zone_names &amp;</paramtype></parameter><parameter name="utc_offset"><paramtype>const time_duration_type &amp;</paramtype></parameter><parameter name="dst_shift"><paramtype>const dst_adjustment_offsets &amp;</paramtype></parameter><parameter name="calc_rule"><paramtype>boost::shared_ptr&lt; dst_calc_rule &gt;</paramtype></parameter></constructor>
  45 <destructor/>
  46 </class><typedef name="dst_calc_rule_ptr"><type>boost::shared_ptr&lt; dst_calc_rule &gt;</type></typedef>
  47 <typedef name="custom_time_zone"><type><classname>custom_time_zone_base</classname>&lt; char &gt;</type></typedef>
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61 </namespace>
  62 </namespace>
  63 </header>
  64 <header name="boost/date_time/local_time/date_duration_operators.hpp">
  65 <para>Operators for local_date_time and optional gregorian types. Operators use snap-to-end-of-month behavior. Further details on this behavior can be found in reference for date_time/date_duration_types.hpp and documentation for month and year iterators. </para><namespace name="boost">
  66 <namespace name="local_time">
  67
  68
  69
  70
  71 <function name="operator+"><type><classname>local_date_time</classname></type><parameter name="t"><paramtype>const <classname>local_date_time</classname> &amp;</paramtype></parameter><parameter name="m"><paramtype>const boost::gregorian::months &amp;</paramtype></parameter><description><para>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 </para></description></function>
  72 <function name="operator+="><type><classname>local_date_time</classname></type><parameter name="t"><paramtype><classname>local_date_time</classname> &amp;</paramtype></parameter><parameter name="m"><paramtype>const boost::gregorian::months &amp;</paramtype></parameter><description><para>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 </para></description></function>
  73 <function name="operator-"><type><classname>local_date_time</classname></type><parameter name="t"><paramtype>const <classname>local_date_time</classname> &amp;</paramtype></parameter><parameter name="m"><paramtype>const boost::gregorian::months &amp;</paramtype></parameter><description><para>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 </para></description></function>
  74 <function name="operator-="><type><classname>local_date_time</classname></type><parameter name="t"><paramtype><classname>local_date_time</classname> &amp;</paramtype></parameter><parameter name="m"><paramtype>const boost::gregorian::months &amp;</paramtype></parameter><description><para>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 </para></description></function>
  75 <function name="operator+"><type><classname>local_date_time</classname></type><parameter name="t"><paramtype>const <classname>local_date_time</classname> &amp;</paramtype></parameter><parameter name="y"><paramtype>const boost::gregorian::years &amp;</paramtype></parameter><description><para>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 </para></description></function>
  76 <function name="operator+="><type><classname>local_date_time</classname></type><parameter name="t"><paramtype><classname>local_date_time</classname> &amp;</paramtype></parameter><parameter name="y"><paramtype>const boost::gregorian::years &amp;</paramtype></parameter><description><para>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 </para></description></function>
  77 <function name="operator-"><type><classname>local_date_time</classname></type><parameter name="t"><paramtype>const <classname>local_date_time</classname> &amp;</paramtype></parameter><parameter name="y"><paramtype>const boost::gregorian::years &amp;</paramtype></parameter><description><para>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 </para></description></function>
  78 <function name="operator-="><type><classname>local_date_time</classname></type><parameter name="t"><paramtype><classname>local_date_time</classname> &amp;</paramtype></parameter><parameter name="y"><paramtype>const boost::gregorian::years &amp;</paramtype></parameter><description><para>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 </para></description></function>
  79
  80 </namespace>
  81 </namespace>
  82 </header>
  83 <header name="boost/date_time/local_time/dst_transition_day_rules.hpp">
  84 <namespace name="boost">
  85 <namespace name="local_time">
  86 <struct name="partial_date_rule_spec"><typedef name="date_type"><type>gregorian::date</type></typedef>
  87 <typedef name="start_rule"><type>gregorian::partial_date</type></typedef>
  88 <typedef name="end_rule"><type>gregorian::partial_date</type></typedef>
  89 </struct><struct name="first_last_rule_spec"><typedef name="date_type"><type>gregorian::date</type></typedef>
  90 <typedef name="start_rule"><type>gregorian::first_kday_of_month</type></typedef>
  91 <typedef name="end_rule"><type>gregorian::last_kday_of_month</type></typedef>
  92 </struct><struct name="last_last_rule_spec"><typedef name="date_type"><type>gregorian::date</type></typedef>
  93 <typedef name="start_rule"><type>gregorian::last_kday_of_month</type></typedef>
  94 <typedef name="end_rule"><type>gregorian::last_kday_of_month</type></typedef>
  95 </struct><struct name="nth_last_rule_spec"><typedef name="date_type"><type>gregorian::date</type></typedef>
  96 <typedef name="start_rule"><type>gregorian::nth_kday_of_month</type></typedef>
  97 <typedef name="end_rule"><type>gregorian::last_kday_of_month</type></typedef>
  98 </struct><struct name="nth_kday_rule_spec"><typedef name="date_type"><type>gregorian::date</type></typedef>
  99 <typedef name="start_rule"><type>gregorian::nth_kday_of_month</type></typedef>
 100 <typedef name="end_rule"><type>gregorian::nth_kday_of_month</type></typedef>
 101 </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>
 102 <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; <classname>partial_date_rule_spec</classname> &gt;</type></typedef>
 103 <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; <classname>first_last_rule_spec</classname> &gt;</type></typedef>
 104 <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; <classname>last_last_rule_spec</classname> &gt;</type></typedef>
 105 <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; <classname>nth_last_rule_spec</classname> &gt;</type></typedef>
 106 <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; <classname>nth_kday_rule_spec</classname> &gt;</type></typedef>
 107 <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; <classname>nth_kday_rule_spec</classname> &gt;</type></typedef>
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121 </namespace>
 122 </namespace>
 123 </header>
 124 <header name="boost/date_time/local_time/local_date_time.hpp">
 125 <namespace name="boost">
 126 <namespace name="local_time">
 127 <struct name="ambiguous_result"><inherit access="public">logic_error</inherit><purpose>simple exception for reporting when STD or DST cannot be determined </purpose><method-group name="public member functions">
 128 </method-group>
 129 <constructor><parameter name="msg"><paramtype>std::string const &amp;</paramtype><default>std::string()</default></parameter></constructor>
 130 </struct><struct name="time_label_invalid"><inherit access="public">logic_error</inherit><purpose>simple exception for when time label given cannot exist </purpose><method-group name="public member functions">
 131 </method-group>
 132 <constructor><parameter name="msg"><paramtype>std::string const &amp;</paramtype><default>std::string()</default></parameter></constructor>
 133 </struct><struct name="dst_not_valid"><inherit access="public">logic_error</inherit><method-group name="public member functions">
 134 </method-group>
 135 <constructor><parameter name="msg"><paramtype>std::string const &amp;</paramtype><default>std::string()</default></parameter></constructor>
 136 </struct><class name="local_date_time_base"><template>
 137       <template-type-parameter name="utc_time_"><default>posix_time::ptime</default></template-type-parameter>
 138       <template-type-parameter name="tz_type"><default>date_time::time_zone_base&lt;utc_time_,char&gt;</default></template-type-parameter>
 139     </template><inherit access="public">date_time::base_time&lt; utc_time_, boost::posix_time::posix_time_system &gt;</inherit><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><enum name="DST_CALC_OPTIONS"><enumvalue name="EXCEPTION_ON_ERROR"/><enumvalue name="NOT_DATE_TIME_ON_ERROR"/></enum>
 140 <typedef name="utc_time_type"><type>utc_time_</type></typedef>
 141 <typedef name="time_duration_type"><type>utc_time_type::time_duration_type</type></typedef>
 142 <typedef name="date_type"><type>utc_time_type::date_type</type></typedef>
 143 <typedef name="date_duration_type"><type>date_type::duration_type</type></typedef>
 144 <typedef name="time_system_type"><type>utc_time_type::time_system_type</type></typedef>
 145 <method-group name="public member functions">
 146 <method name="zone" cv="const"><type>boost::shared_ptr&lt; tz_type &gt;</type><purpose>returns time zone associated with calling instance </purpose></method>
 147 <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>
 148 <method name="utc_time" cv="const"><type>utc_time_type</type><purpose>Returns object's time value as a utc representation. </purpose></method>
 149 <method name="local_time" cv="const"><type>utc_time_type</type><purpose>Returns object's time value as a local representation. </purpose></method>
 150 <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>
 151 <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 <classname alt="boost::local_time::local_date_time_base">local_date_time_base</classname> in the given time zone with the optional time_duration added. </para></description></method>
 152 <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>
 153 <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>
 154 <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>
 155 <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><description><para>Equality comparison operator </para></description></method>
 156 <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>
 157 <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>
 158 <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>
 159 <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>
 160 <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>
 161 <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>
 162 <method name="operator+="><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>
 163 <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>
 164 <method name="operator-="><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>
 165 <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>
 166 <method name="operator+="><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>
 167 <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>
 168 <method name="operator-="><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>
 169 <method name="operator-" cv="const"><type>time_duration_type</type><parameter name="rhs"><paramtype>const <classname>local_date_time_base</classname> &amp;</paramtype></parameter><purpose>local_date_time -= local_date_time –&gt; time_duration_type </purpose></method>
 170 </method-group>
 171 <constructor><parameter name="t"><paramtype>utc_time_type</paramtype><description><para>A UTC time </para></description></parameter><parameter name="tz"><paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype><description><para>Timezone for to adjust the UTC time to. </para></description></parameter><description><para>This constructor interprets the passed time as a UTC time. So, for example, if the passed timezone is UTC-5 then the time will be adjusted back 5 hours. The time zone allows for automatic calculation of whether the particular time is adjusted for daylight savings, etc. If the time zone shared pointer is null then time stays unadjusted.
 172 </para></description></constructor>
 173 <constructor><parameter name="d"><paramtype>date_type</paramtype></parameter><parameter name="td"><paramtype>time_duration_type</paramtype></parameter><parameter name="tz"><paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype></parameter><parameter name="dst_flag"><paramtype>bool</paramtype></parameter><description><para>This constructs a local time – the passed time information understood to be in the passed tz. The DST flag must be passed to indicate whether the time is in daylight savings or not.
 174 </para></description><throws><simpara><classname>&amp;ndash;</classname> <classname alt="boost::local_time::time_label_invalid">time_label_invalid</classname> if the time passed does not exist in the given locale. The non-existent case occurs typically during the shift-back from daylight savings time. When the clock is shifted forward a range of times (2 am to 3 am in the US) is skipped and hence is invalid. <classname alt="boost::local_time::dst_not_valid">dst_not_valid</classname> if the DST flag is passed for a period where DST is not active. </simpara></throws></constructor>
 175 <constructor><parameter name="d"><paramtype>date_type</paramtype></parameter><parameter name="td"><paramtype>time_duration_type</paramtype></parameter><parameter name="tz"><paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype></parameter><parameter name="calc_option"><paramtype>DST_CALC_OPTIONS</paramtype></parameter><description><para>This constructs a local time – the passed time information understood to be in the passed tz. The DST flag is calculated according to the specified rule. </para></description></constructor>
 176 <destructor><purpose>Simple destructor, releases time zone if last referrer. </purpose></destructor>
 177 <constructor><parameter name="rhs"><paramtype>const <classname>local_date_time_base</classname> &amp;</paramtype></parameter><purpose>Copy constructor. </purpose></constructor>
 178 <constructor specifiers="explicit"><parameter name="sv"><paramtype>const boost::date_time::special_values</paramtype></parameter><parameter name="tz"><paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype><default>boost::shared_ptr&lt; tz_type &gt;()</default></parameter><purpose>Special values constructor. </purpose></constructor>
 179 <method-group name="public static functions">
 180 <method name="check_dst" specifiers="static"><type>time_is_dst_result</type><parameter name="d"><paramtype>date_type</paramtype></parameter><parameter name="td"><paramtype>time_duration_type</paramtype></parameter><parameter name="tz"><paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype></parameter><purpose>Determines if given time label is in daylight savings for given zone. </purpose><description><para>Determines if given time label is in daylight savings for given zone. Takes a date and time_duration representing a local time, along with time zone, and returns a time_is_dst_result object as result. </para></description></method>
 181 </method-group>
 182 <method-group name="private member functions">
 183 <method name="construction_adjustment"><type>utc_time_type</type><parameter name="t"><paramtype>utc_time_type</paramtype></parameter><parameter name="z"><paramtype>boost::shared_ptr&lt; tz_type &gt;</paramtype></parameter><parameter name="dst_flag"><paramtype>bool</paramtype></parameter><description><para>Adjust the passed in time to UTC? </para></description></method>
 184 <method name="zone_as_offset" cv="const"><type>std::string</type><parameter name="td"><paramtype>const time_duration_type &amp;</paramtype></parameter><parameter name="separator"><paramtype>const std::string &amp;</paramtype></parameter><description><para>Simple formatting code – todo remove this? </para></description></method>
 185 </method-group>
 186 </class><typedef name="local_date_time"><purpose>Use the default parameters to define local_date_time. </purpose><type><classname>local_date_time_base</classname></type></typedef>
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200 </namespace>
 201 </namespace>
 202 </header>
 203 <header name="boost/date_time/local_time/local_time.hpp">
 204 </header>
 205 <header name="boost/date_time/local_time/local_time_io.hpp">
 206 <namespace name="boost">
 207 <namespace name="local_time">
 208 <typedef name="wlocal_time_facet"><type>boost::date_time::time_facet&lt; <classname>local_date_time</classname>, wchar_t &gt;</type></typedef>
 209 <typedef name="local_time_facet"><type>boost::date_time::time_facet&lt; <classname>local_date_time</classname>, char &gt;</type></typedef>
 210 <typedef name="wlocal_time_input_facet"><type>boost::date_time::time_input_facet&lt; local_date_time::utc_time_type, wchar_t &gt;</type></typedef>
 211 <typedef name="local_time_input_facet"><type>boost::date_time::time_input_facet&lt; local_date_time::utc_time_type, char &gt;</type></typedef>
 212 <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
 213           <template-type-parameter name="CharT"/>
 214           <template-type-parameter name="TraitsT"/>
 215         </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="ldt"><paramtype>const <classname>local_date_time</classname> &amp;</paramtype></parameter><purpose>operator&lt;&lt; for local_date_time - see local_time docs for formatting details </purpose></function>
 216 <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
 217           <template-type-parameter name="CharT"/>
 218           <template-type-parameter name="Traits"/>
 219         </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="ldt"><paramtype><classname>local_date_time</classname> &amp;</paramtype></parameter><purpose>input operator for local_date_time </purpose></function>
 220 <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
 221           <template-type-parameter name="CharT"/>
 222           <template-type-parameter name="TraitsT"/>
 223         </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="p"><paramtype>const boost::local_time::local_time_period &amp;</paramtype></parameter><purpose>output operator for local_time_period </purpose></function>
 224 <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
 225           <template-type-parameter name="CharT"/>
 226           <template-type-parameter name="Traits"/>
 227         </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="tp"><paramtype>boost::local_time::local_time_period &amp;</paramtype></parameter><purpose>input operator for local_time_period </purpose></function>
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237 </namespace>
 238 </namespace>
 239 </header>
 240 <header name="boost/date_time/local_time/local_time_types.hpp">
 241 <namespace name="boost">
 242 <namespace name="local_time">
 243 <typedef name="local_time_period"><type>boost::date_time::period&lt; <classname>local_date_time</classname>, boost::posix_time::time_duration &gt;</type></typedef>
 244 <typedef name="local_time_iterator"><type>date_time::time_itr&lt; <classname>local_date_time</classname> &gt;</type></typedef>
 245 <typedef name="local_sec_clock"><type>date_time::second_clock&lt; <classname>local_date_time</classname> &gt;</type></typedef>
 246 <typedef name="local_microsec_clock"><type>date_time::microsec_clock&lt; <classname>local_date_time</classname> &gt;</type></typedef>
 247 <typedef name="time_zone"><type>date_time::time_zone_base&lt; posix_time::ptime, char &gt;</type></typedef>
 248 <typedef name="wtime_zone"><type>date_time::time_zone_base&lt; posix_time::ptime, wchar_t &gt;</type></typedef>
 249 <typedef name="time_zone_ptr"><purpose>Shared Pointer for custom_time_zone and posix_time_zone objects. </purpose><type>boost::shared_ptr&lt; time_zone &gt;</type></typedef>
 250 <typedef name="wtime_zone_ptr"><type>boost::shared_ptr&lt; wtime_zone &gt;</type></typedef>
 251 <typedef name="time_zone_names"><type>date_time::time_zone_names_base&lt; char &gt;</type></typedef>
 252 <typedef name="wtime_zone_names"><type>date_time::time_zone_names_base&lt; wchar_t &gt;</type></typedef>
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266 </namespace>
 267 </namespace>
 268 </header>
 269 <header name="boost/date_time/local_time/posix_time_zone.hpp">
 270 <namespace name="boost">
 271 <namespace name="local_time">
 272 <struct name="bad_offset"><inherit access="public">out_of_range</inherit><purpose>simple exception for UTC and Daylight savings start/end offsets </purpose><method-group name="public member functions">
 273 </method-group>
 274 <constructor><parameter name="msg"><paramtype>std::string const &amp;</paramtype><default>std::string()</default></parameter></constructor>
 275 </struct><struct name="bad_adjustment"><inherit access="public">out_of_range</inherit><purpose>simple exception for UTC daylight savings adjustment </purpose><method-group name="public member functions">
 276 </method-group>
 277 <constructor><parameter name="msg"><paramtype>std::string const &amp;</paramtype><default>std::string()</default></parameter></constructor>
 278 </struct><class name="posix_time_zone_base"><template>
 279       <template-type-parameter name="CharT"/>
 280     </template><inherit access="public">date_time::time_zone_base&lt; posix_time::ptime, CharT &gt;</inherit><purpose>A time zone class constructed from a POSIX time zone string. </purpose><description><para>A POSIX time zone string takes the form of:<sbr/>
 281  "std offset dst [offset],start[/time],end[/time]" (w/no spaces) 'std' specifies the abbrev of the time zone.<sbr/>
 282  'offset' is the offset from UTC.<sbr/>
 283  'dst' specifies the abbrev of the time zone during daylight savings time.<sbr/>
 284  The second offset is how many hours changed during DST. Default=1<sbr/>
 285  'start' and'end' are the dates when DST goes into (and out of) effect.<sbr/>
 286  'offset' takes the form of: [+|-]hh[:mm[:ss]] {h=0-23, m/s=0-59}<sbr/>
 287  'time' and 'offset' take the same form. Time defaults=02:00:00<sbr/>
 288  'start' and 'end' can be one of three forms:<sbr/>
 289  Mm.w.d {month=1-12, week=1-5 (5 is always last), day=0-6}<sbr/>
 290  Jn {n=1-365 Feb29 is never counted}<sbr/>
 291  n {n=0-365 Feb29 is counted in leap years}<sbr/>
 292  Example "PST-5PDT01:00:00,M4.1.0/02:00:00,M10.1.0/02:00:00" <sbr/>
 293  Exceptions will be thrown under these conditions:<sbr/>
 294  An invalid date spec (see date class)<sbr/>
 295  A <classname alt="boost::local_time::bad_offset">boost::local_time::bad_offset</classname> exception will be thrown for:<sbr/>
 296  A DST start or end offset that is negative or more than 24 hours<sbr/>
 297  A UTC zone that is greater than +14 or less than -12 hours<sbr/>
 298  A <classname alt="boost::local_time::bad_adjustment">boost::local_time::bad_adjustment</classname> exception will be thrown for:<sbr/>
 299  A DST adjustment that is 24 hours or more (positive or negative)<sbr/>
 300 </para><para>Note that UTC zone offsets can be greater than +12: <ulink url="http://www.worldtimezone.com/utc/utc+1200.html">http://www.worldtimezone.com/utc/utc+1200.html</ulink> </para></description><typedef name="time_duration_type"><type>boost::posix_time::time_duration</type></typedef>
 301 <typedef name="time_zone_names"><type>date_time::time_zone_names_base&lt; CharT &gt;</type></typedef>
 302 <typedef name="base_type"><type>date_time::time_zone_base&lt; posix_time::ptime, CharT &gt;</type></typedef>
 303 <typedef name="string_type"><type>base_type::string_type</type></typedef>
 304 <typedef name="char_type"><type>CharT</type></typedef>
 305 <typedef name="stringstream_type"><type>base_type::stringstream_type</type></typedef>
 306 <typedef name="char_separator_type"><type>boost::char_separator&lt; char_type, std::char_traits&lt; char_type &gt; &gt;</type></typedef>
 307 <typedef name="tokenizer_type"><type>boost::tokenizer&lt; char_separator_type, typename string_type::const_iterator, string_type &gt;</type></typedef>
 308 <typedef name="tokenizer_iterator_type"><type>tokenizer_type::iterator</type></typedef>
 309 <method-group name="public member functions">
 310 <method name="std_zone_abbrev" cv="const" specifiers="virtual"><type>string_type</type><purpose>String for the zone when not in daylight savings (eg: EST) </purpose></method>
 311 <method name="dst_zone_abbrev" cv="const" specifiers="virtual"><type>string_type</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>
 312 <method name="std_zone_name" cv="const" specifiers="virtual"><type>string_type</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>
 313 <method name="dst_zone_name" cv="const" specifiers="virtual"><type>string_type</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>
 314 <method name="has_dst" cv="const" specifiers="virtual"><type>bool</type><purpose>True if zone uses daylight savings adjustments otherwise false. </purpose></method>
 315 <method name="dst_local_start_time" cv="const" specifiers="virtual"><type>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>
 316 <method name="dst_local_end_time" cv="const" specifiers="virtual"><type>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>
 317 <method name="base_utc_offset" cv="const" specifiers="virtual"><type>time_duration_type</type><purpose>Base offset from UTC for zone (eg: -07:30:00) </purpose></method>
 318 <method name="dst_offset" cv="const" specifiers="virtual"><type>time_duration_type</type><purpose>Adjustment forward or back made while DST is in effect. </purpose></method>
 319 <method name="to_posix_string" cv="const" specifiers="virtual"><type>string_type</type><purpose>Returns a POSIX time_zone string for this object. </purpose></method>
 320 </method-group>
 321 <constructor><parameter name="s"><paramtype>const string_type &amp;</paramtype></parameter><purpose>Construct from a POSIX time zone string. </purpose></constructor>
 322 <destructor/>
 323 <method-group name="private member functions">
 324 <method name="calc_zone"><type>void</type><parameter name="obj"><paramtype>const string_type &amp;</paramtype></parameter><description><para>Extract time zone abbreviations for STD &amp; DST as well as the offsets for the time shift that 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>
 325 <method name="calc_rules"><type>void</type><parameter name="start"><paramtype>const string_type &amp;</paramtype></parameter><parameter name="end"><paramtype>const string_type &amp;</paramtype></parameter></method>
 326 <method name="M_func"><type>void</type><parameter name="s"><paramtype>const string_type &amp;</paramtype></parameter><parameter name="e"><paramtype>const string_type &amp;</paramtype></parameter></method>
 327 <method name="julian_no_leap"><type>void</type><parameter name="s"><paramtype>const string_type &amp;</paramtype></parameter><parameter name="e"><paramtype>const string_type &amp;</paramtype></parameter><purpose>Julian day. Feb29 is never counted, even in leap years. </purpose></method>
 328 <method name="julian_day"><type>void</type><parameter name="s"><paramtype>const string_type &amp;</paramtype></parameter><parameter name="e"><paramtype>const string_type &amp;</paramtype></parameter><purpose>Julian day. Feb29 is always counted, but exception thrown in non-leap years. </purpose></method>
 329 </method-group>
 330 <method-group name="private static functions">
 331 <method name="td_as_string" specifiers="static"><type>std::string</type><parameter name="td"><paramtype>const time_duration_type &amp;</paramtype></parameter><purpose>helper function used when throwing exceptions </purpose></method>
 332 </method-group>
 333 </class><typedef name="dst_adjustment_offsets"><type>boost::date_time::dst_adjustment_offsets&lt; boost::posix_time::time_duration &gt;</type></typedef>
 334 <typedef name="posix_time_zone"><type><classname>posix_time_zone_base</classname>&lt; char &gt;</type></typedef>
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348 </namespace>
 349 </namespace>
 350 </header>
 351 <header name="boost/date_time/local_time/tz_database.hpp">
 352 <namespace name="boost">
 353 <namespace name="local_time">
 354 <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>
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368 </namespace>
 369 </namespace>
 370 </header>
 371 </library-reference>