posix_time_autodoc.xml 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851
  1. <?xml version="1.0" standalone="yes"?>
  2. <library-reference id="posix_time_reference"><title>Posix Time Reference</title><header name="boost/date_time/posix_time/conversion.hpp">
  3. <namespace name="boost">
  4. <namespace name="posix_time">
  5. <function name="from_time_t"><type><classname>ptime</classname></type><parameter name="t"><paramtype>std::time_t</paramtype></parameter><purpose>Function that converts a time_t into a ptime. </purpose></function>
  6. <function name="to_time_t"><type>std::time_t</type><parameter name="pt"><paramtype><classname>ptime</classname></paramtype></parameter><purpose>Function that converts a ptime into a time_t. </purpose></function>
  7. <function name="to_tm"><type>std::tm</type><parameter name="t"><paramtype>const <classname>boost::posix_time::ptime</classname> &amp;</paramtype></parameter><purpose>Convert a time to a tm structure truncating any fractional seconds. </purpose></function>
  8. <function name="to_tm"><type>std::tm</type><parameter name="td"><paramtype>const <classname>boost::posix_time::time_duration</classname> &amp;</paramtype></parameter><purpose>Convert a <classname alt="boost::posix_time::time_duration">time_duration</classname> to a tm structure truncating any fractional seconds and zeroing fields for date components. </purpose></function>
  9. <function name="ptime_from_tm"><type><classname>ptime</classname></type><parameter name="timetm"><paramtype>const std::tm &amp;</paramtype></parameter><purpose>Convert a tm struct to a ptime ignoring is_dst flag. </purpose></function>
  10. <function name="from_ftime"><type>TimeT</type><template>
  11. <template-type-parameter name="TimeT"/>
  12. <template-type-parameter name="FileTimeT"/>
  13. </template><parameter name="ft"><paramtype>const FileTimeT &amp;</paramtype></parameter><purpose>Function to create a time object from an initialized FILETIME struct. </purpose><description><para>Function to create a time object from an initialized FILETIME struct. A FILETIME struct holds 100-nanosecond units (0.0000001). When built with microsecond resolution the FILETIME's sub second value will be truncated. Nanosecond resolution has no truncation.</para><para><note><para>FILETIME is part of the Win32 API, so it is not portable to non-windows platforms.</para>
  14. </note>
  15. <note><para>The function is templated on the FILETIME type, so that it can be used with both native FILETIME and the ad-hoc boost::detail::winapi::FILETIME_ type. </para>
  16. </note>
  17. </para></description></function>
  18. </namespace>
  19. </namespace>
  20. </header>
  21. <header name="boost/date_time/posix_time/date_duration_operators.hpp">
  22. <para>Operators for ptime 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">
  23. <namespace name="posix_time">
  24. <function name="operator+"><type><classname>ptime</classname></type><parameter name="t"><paramtype>const <classname>ptime</classname> &amp;</paramtype></parameter><parameter name="m"><paramtype>const boost::gregorian::months &amp;</paramtype></parameter><description><para>Adds a months object and a ptime. Result will be same day-of-month as ptime unless original day was the last day of month. see date_time::months_duration for more details </para></description></function>
  25. <function name="operator+="><type><classname>ptime</classname></type><parameter name="t"><paramtype><classname>ptime</classname> &amp;</paramtype></parameter><parameter name="m"><paramtype>const boost::gregorian::months &amp;</paramtype></parameter><description><para>Adds a months object to a ptime. Result will be same day-of-month as ptime unless original day was the last day of month. see date_time::months_duration for more details </para></description></function>
  26. <function name="operator-"><type><classname>ptime</classname></type><parameter name="t"><paramtype>const <classname>ptime</classname> &amp;</paramtype></parameter><parameter name="m"><paramtype>const boost::gregorian::months &amp;</paramtype></parameter><description><para>Subtracts a months object and a ptime. Result will be same day-of-month as ptime unless original day was the last day of month. see date_time::months_duration for more details </para></description></function>
  27. <function name="operator-="><type><classname>ptime</classname></type><parameter name="t"><paramtype><classname>ptime</classname> &amp;</paramtype></parameter><parameter name="m"><paramtype>const boost::gregorian::months &amp;</paramtype></parameter><description><para>Subtracts a months object from a ptime. Result will be same day-of-month as ptime unless original day was the last day of month. see date_time::months_duration for more details </para></description></function>
  28. <function name="operator+"><type><classname>ptime</classname></type><parameter name="t"><paramtype>const <classname>ptime</classname> &amp;</paramtype></parameter><parameter name="y"><paramtype>const boost::gregorian::years &amp;</paramtype></parameter><description><para>Adds a years object and a ptime. Result will be same month and day-of-month as ptime unless original day was the last day of month. see date_time::years_duration for more details </para></description></function>
  29. <function name="operator+="><type><classname>ptime</classname></type><parameter name="t"><paramtype><classname>ptime</classname> &amp;</paramtype></parameter><parameter name="y"><paramtype>const boost::gregorian::years &amp;</paramtype></parameter><description><para>Adds a years object to a ptime. Result will be same month and day-of-month as ptime unless original day was the last day of month. see date_time::years_duration for more details </para></description></function>
  30. <function name="operator-"><type><classname>ptime</classname></type><parameter name="t"><paramtype>const <classname>ptime</classname> &amp;</paramtype></parameter><parameter name="y"><paramtype>const boost::gregorian::years &amp;</paramtype></parameter><description><para>Subtracts a years object and a ptime. Result will be same month and day-of-month as ptime unless original day was the last day of month. see date_time::years_duration for more details </para></description></function>
  31. <function name="operator-="><type><classname>ptime</classname></type><parameter name="t"><paramtype><classname>ptime</classname> &amp;</paramtype></parameter><parameter name="y"><paramtype>const boost::gregorian::years &amp;</paramtype></parameter><description><para>Subtracts a years object from a ptime. Result will be same month and day-of-month as ptime unless original day was the last day of month. see date_time::years_duration for more details </para></description></function>
  32. </namespace>
  33. </namespace>
  34. </header>
  35. <header name="boost/date_time/posix_time/posix_time.hpp">
  36. <para>Global header file to get all of posix time types </para></header>
  37. <header name="boost/date_time/posix_time/posix_time_config.hpp">
  38. <namespace name="boost">
  39. <namespace name="posix_time">
  40. <class name="millisec_posix_time_system_config"><typedef name="time_rep_type"><type>boost::int64_t</type></typedef>
  41. <typedef name="date_type"><type>gregorian::date</type></typedef>
  42. <typedef name="date_duration_type"><type>gregorian::date_duration</type></typedef>
  43. <typedef name="time_duration_type"><type><classname>time_duration</classname></type></typedef>
  44. <typedef name="int_type"><type>time_res_traits::tick_type</type></typedef>
  45. <typedef name="impl_type"><type>time_res_traits::impl_type</type></typedef>
  46. <typedef name="resolution_traits"><type>time_res_traits</type></typedef>
  47. <method-group name="public member functions">
  48. <method name="BOOST_STATIC_CONSTANT"><type/><parameter name=""><paramtype>boost::int64_t</paramtype></parameter><parameter name=""><paramtype>tick_per_second</paramtype><default>1000000</default></parameter></method>
  49. </method-group>
  50. </class><class name="posix_time_system_config"><typedef name="time_rep_type"><type><classname>simple_time_rep</classname></type></typedef>
  51. <typedef name="date_type"><type>gregorian::date</type></typedef>
  52. <typedef name="date_duration_type"><type>gregorian::date_duration</type></typedef>
  53. <typedef name="time_duration_type"><type><classname>time_duration</classname></type></typedef>
  54. <typedef name="int_type"><type>time_res_traits::tick_type</type></typedef>
  55. <typedef name="resolution_traits"><type>time_res_traits</type></typedef>
  56. <method-group name="public member functions">
  57. <method name="BOOST_STATIC_CONSTANT"><type/><parameter name=""><paramtype>boost::int64_t</paramtype></parameter><parameter name=""><paramtype>tick_per_second</paramtype><default>1000000000</default></parameter></method>
  58. </method-group>
  59. </class><struct name="simple_time_rep"><purpose>Simple implementation for the time rep. </purpose><typedef name="date_type"><type>gregorian::date</type></typedef>
  60. <typedef name="time_duration_type"><type><classname>time_duration</classname></type></typedef>
  61. <data-member name="day"><type>date_type</type></data-member>
  62. <data-member name="time_of_day"><type><classname>time_duration_type</classname></type></data-member>
  63. <method-group name="public member functions">
  64. <method name="is_special" cv="const"><type>bool</type></method>
  65. <method name="is_pos_infinity" cv="const"><type>bool</type></method>
  66. <method name="is_neg_infinity" cv="const"><type>bool</type></method>
  67. <method name="is_not_a_date_time" cv="const"><type>bool</type></method>
  68. </method-group>
  69. <constructor><parameter name="d"><paramtype>date_type</paramtype></parameter><parameter name="tod"><paramtype><classname>time_duration_type</classname></paramtype></parameter></constructor>
  70. </struct><class name="time_duration"><inherit access="public">date_time::time_duration&lt; time_duration, time_res_traits &gt;</inherit><purpose>Base time duration type. </purpose><typedef name="rep_type"><type>time_res_traits</type></typedef>
  71. <typedef name="day_type"><type>time_res_traits::day_type</type></typedef>
  72. <typedef name="hour_type"><type>time_res_traits::hour_type</type></typedef>
  73. <typedef name="min_type"><type>time_res_traits::min_type</type></typedef>
  74. <typedef name="sec_type"><type>time_res_traits::sec_type</type></typedef>
  75. <typedef name="fractional_seconds_type"><type>time_res_traits::fractional_seconds_type</type></typedef>
  76. <typedef name="tick_type"><type>time_res_traits::tick_type</type></typedef>
  77. <typedef name="impl_type"><type>time_res_traits::impl_type</type></typedef>
  78. <method-group name="public member functions">
  79. </method-group>
  80. <constructor><parameter name="hour"><paramtype>hour_type</paramtype></parameter><parameter name="min"><paramtype>min_type</paramtype></parameter><parameter name="sec"><paramtype>sec_type</paramtype></parameter><parameter name="fs"><paramtype>fractional_seconds_type</paramtype><default>0</default></parameter></constructor>
  81. <constructor/>
  82. <constructor><parameter name="sv"><paramtype>boost::date_time::special_values</paramtype></parameter><purpose>Construct from special_values. </purpose></constructor>
  83. <method-group name="protected member functions">
  84. </method-group>
  85. <constructor specifiers="explicit"><parameter name="tick_count"><paramtype>impl_type</paramtype></parameter></constructor>
  86. </class><typedef name="time_res_traits"><type>date_time::time_resolution_traits&lt; boost::date_time::time_resolution_traits_adapted64_impl, boost::date_time::nano, 1000000000, 9 &gt;</type></typedef>
  87. </namespace>
  88. </namespace>
  89. </header>
  90. <header name="boost/date_time/posix_time/posix_time_duration.hpp">
  91. <namespace name="boost">
  92. <namespace name="posix_time">
  93. <class name="hours"><inherit access="public">boost::posix_time::time_duration</inherit><description><para>Allows expression of durations as an hour count The argument must be an integral type </para></description><method-group name="public member functions">
  94. </method-group>
  95. <constructor specifiers="explicit"><template>
  96. <template-type-parameter name="T"/>
  97. </template><parameter name="h"><paramtype>T const &amp;</paramtype></parameter><parameter name=""><paramtype>typename boost::enable_if&lt; boost::is_integral&lt; T &gt;, void &gt;::type *</paramtype><default>BOOST_DATE_TIME_NULLPTR</default></parameter></constructor>
  98. </class><class name="minutes"><inherit access="public">boost::posix_time::time_duration</inherit><description><para>Allows expression of durations as a minute count The argument must be an integral type </para></description><method-group name="public member functions">
  99. </method-group>
  100. <constructor specifiers="explicit"><template>
  101. <template-type-parameter name="T"/>
  102. </template><parameter name="m"><paramtype>T const &amp;</paramtype></parameter><parameter name=""><paramtype>typename boost::enable_if&lt; boost::is_integral&lt; T &gt;, void &gt;::type *</paramtype><default>BOOST_DATE_TIME_NULLPTR</default></parameter></constructor>
  103. </class><class name="seconds"><inherit access="public">boost::posix_time::time_duration</inherit><description><para>Allows expression of durations as a seconds count The argument must be an integral type </para></description><method-group name="public member functions">
  104. </method-group>
  105. <constructor specifiers="explicit"><template>
  106. <template-type-parameter name="T"/>
  107. </template><parameter name="s"><paramtype>T const &amp;</paramtype></parameter><parameter name=""><paramtype>typename boost::enable_if&lt; boost::is_integral&lt; T &gt;, void &gt;::type *</paramtype><default>BOOST_DATE_TIME_NULLPTR</default></parameter></constructor>
  108. </class><typedef name="millisec"><purpose>Allows expression of durations as milli seconds. </purpose><type>date_time::subsecond_duration&lt; <classname>time_duration</classname>, 1000 &gt;</type></typedef>
  109. <typedef name="milliseconds"><type>date_time::subsecond_duration&lt; <classname>time_duration</classname>, 1000 &gt;</type></typedef>
  110. <typedef name="microsec"><purpose>Allows expression of durations as micro seconds. </purpose><type>date_time::subsecond_duration&lt; <classname>time_duration</classname>, 1000000 &gt;</type></typedef>
  111. <typedef name="microseconds"><type>date_time::subsecond_duration&lt; <classname>time_duration</classname>, 1000000 &gt;</type></typedef>
  112. <typedef name="nanosec"><purpose>Allows expression of durations as nano seconds. </purpose><type>date_time::subsecond_duration&lt; <classname>time_duration</classname>, 1000000000 &gt;</type></typedef>
  113. <typedef name="nanoseconds"><type>date_time::subsecond_duration&lt; <classname>time_duration</classname>, 1000000000 &gt;</type></typedef>
  114. </namespace>
  115. </namespace>
  116. </header>
  117. <header name="boost/date_time/posix_time/posix_time_io.hpp">
  118. <namespace name="boost">
  119. <namespace name="posix_time">
  120. <typedef name="wtime_facet"><purpose>wptime_facet is depricated and will be phased out. use wtime_facet instead </purpose><description><para>ptime_facet is depricated and will be phased out. use time_facet instead wptime_input_facet is depricated and will be phased out. use wtime_input_facet instead ptime_input_facet is depricated and will be phased out. use time_input_facet instead </para></description><type>boost::date_time::time_facet&lt; <classname>ptime</classname>, wchar_t &gt;</type></typedef>
  121. <typedef name="time_facet"><type>boost::date_time::time_facet&lt; <classname>ptime</classname>, char &gt;</type></typedef>
  122. <typedef name="wtime_input_facet"><type>boost::date_time::time_input_facet&lt; <classname>ptime</classname>, wchar_t &gt;</type></typedef>
  123. <typedef name="time_input_facet"><type>boost::date_time::time_input_facet&lt; <classname>ptime</classname>, char &gt;</type></typedef>
  124. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  125. <template-type-parameter name="CharT"/>
  126. <template-type-parameter name="TraitsT"/>
  127. </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="p"><paramtype>const <classname>ptime</classname> &amp;</paramtype></parameter></function>
  128. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  129. <template-type-parameter name="CharT"/>
  130. <template-type-parameter name="Traits"/>
  131. </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="pt"><paramtype><classname>ptime</classname> &amp;</paramtype></parameter><purpose>input operator for ptime </purpose></function>
  132. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</type><template>
  133. <template-type-parameter name="CharT"/>
  134. <template-type-parameter name="TraitsT"/>
  135. </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, TraitsT &gt; &amp;</paramtype></parameter><parameter name="p"><paramtype>const boost::posix_time::time_period &amp;</paramtype></parameter></function>
  136. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  137. <template-type-parameter name="CharT"/>
  138. <template-type-parameter name="Traits"/>
  139. </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="tp"><paramtype>time_period &amp;</paramtype></parameter><purpose>input operator for time_period </purpose></function>
  140. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; CharT, Traits &gt; &amp;</type><template>
  141. <template-type-parameter name="CharT"/>
  142. <template-type-parameter name="Traits"/>
  143. </template><parameter name="os"><paramtype>std::basic_ostream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="td"><paramtype>const <classname>time_duration</classname> &amp;</paramtype></parameter><purpose>ostream operator for <classname alt="boost::posix_time::time_duration">posix_time::time_duration</classname> </purpose></function>
  144. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; CharT, Traits &gt; &amp;</type><template>
  145. <template-type-parameter name="CharT"/>
  146. <template-type-parameter name="Traits"/>
  147. </template><parameter name="is"><paramtype>std::basic_istream&lt; CharT, Traits &gt; &amp;</paramtype></parameter><parameter name="td"><paramtype><classname>time_duration</classname> &amp;</paramtype></parameter><purpose>input operator for <classname alt="boost::posix_time::time_duration">time_duration</classname> </purpose></function>
  148. </namespace>
  149. </namespace>
  150. </header>
  151. <header name="boost/date_time/posix_time/posix_time_legacy_io.hpp">
  152. <namespace name="boost">
  153. <namespace name="posix_time">
  154. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  155. <template-type-parameter name="charT"/>
  156. <template-type-parameter name="traits"/>
  157. </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="td"><paramtype>const <classname>time_duration</classname> &amp;</paramtype></parameter><purpose>ostream operator for <classname alt="boost::posix_time::time_duration">posix_time::time_duration</classname> </purpose></function>
  158. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  159. <template-type-parameter name="charT"/>
  160. <template-type-parameter name="traits"/>
  161. </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="t"><paramtype>const <classname>ptime</classname> &amp;</paramtype></parameter><purpose>ostream operator for <classname alt="boost::posix_time::ptime">posix_time::ptime</classname> </purpose></function>
  162. <function name="operator&lt;&lt;"><type>std::basic_ostream&lt; charT, traits &gt; &amp;</type><template>
  163. <template-type-parameter name="charT"/>
  164. <template-type-parameter name="traits"/>
  165. </template><parameter name="os"><paramtype>std::basic_ostream&lt; charT, traits &gt; &amp;</paramtype></parameter><parameter name="tp"><paramtype>const time_period &amp;</paramtype></parameter><purpose>ostream operator for posix_time::time_period </purpose></function>
  166. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
  167. <template-type-parameter name="charT"/>
  168. </template><parameter name="is"><paramtype>std::basic_istream&lt; charT &gt; &amp;</paramtype></parameter><parameter name="td"><paramtype><classname>time_duration</classname> &amp;</paramtype></parameter></function>
  169. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
  170. <template-type-parameter name="charT"/>
  171. </template><parameter name="is"><paramtype>std::basic_istream&lt; charT &gt; &amp;</paramtype></parameter><parameter name="pt"><paramtype><classname>ptime</classname> &amp;</paramtype></parameter></function>
  172. <function name="operator&gt;&gt;"><type>std::basic_istream&lt; charT &gt; &amp;</type><template>
  173. <template-type-parameter name="charT"/>
  174. </template><parameter name="is"><paramtype>std::basic_istream&lt; charT &gt; &amp;</paramtype></parameter><parameter name="tp"><paramtype>time_period &amp;</paramtype></parameter><description><para>operator&gt;&gt; for time_period. time_period must be in "[date time_duration/date time_duration]" format. </para></description></function>
  175. </namespace>
  176. </namespace>
  177. </header>
  178. <header name="boost/date_time/posix_time/posix_time_system.hpp">
  179. <namespace name="boost">
  180. <namespace name="posix_time">
  181. <typedef name="posix_time_system"><type>date_time::split_timedate_system&lt; <classname>posix_time_system_config</classname>, 1000000000 &gt;</type></typedef>
  182. <typedef name="int64_time_rep"><type>date_time::counted_time_rep&lt; <classname>millisec_posix_time_system_config</classname> &gt;</type></typedef>
  183. </namespace>
  184. </namespace>
  185. </header>
  186. <header name="boost/date_time/posix_time/posix_time_types.hpp">
  187. <namespace name="boost">
  188. <namespace name="posix_time">
  189. <typedef name="time_iterator"><purpose>Iterator over a defined time duration. </purpose><type>date_time::time_itr&lt; <classname>ptime</classname> &gt;</type></typedef>
  190. <typedef name="second_clock"><purpose>A time clock that has a resolution of one second. </purpose><type>date_time::second_clock&lt; <classname>ptime</classname> &gt;</type></typedef>
  191. <typedef name="microsec_clock"><purpose>A time clock that has a resolution of one microsecond. </purpose><type>date_time::microsec_clock&lt; <classname>ptime</classname> &gt;</type></typedef>
  192. <typedef name="no_dst"><purpose>Define a dst null dst rule for the posix_time system. </purpose><type>date_time::null_dst_rules&lt; ptime::date_type, <classname>time_duration</classname> &gt;</type></typedef>
  193. <typedef name="us_dst"><purpose>Define US dst rule calculator for the posix_time system. </purpose><type>date_time::us_dst_rules&lt; ptime::date_type, <classname>time_duration</classname> &gt;</type></typedef>
  194. </namespace>
  195. </namespace>
  196. </header>
  197. <header name="boost/date_time/posix_time/ptime.hpp">
  198. <namespace name="boost">
  199. <namespace name="posix_time">
  200. <class name="ptime"><inherit access="public">date_time::base_time&lt; ptime, posix_time_system &gt;</inherit><purpose>Time type with no timezone or other adjustments. </purpose><typedef name="time_system_type"><type>posix_time_system</type></typedef>
  201. <typedef name="time_rep_type"><type>time_system_type::time_rep_type</type></typedef>
  202. <typedef name="time_duration_type"><type>time_system_type::time_duration_type</type></typedef>
  203. <typedef name="time_type"><type><classname>ptime</classname></type></typedef>
  204. <method-group name="public member functions">
  205. </method-group>
  206. <constructor><parameter name="d"><paramtype>gregorian::date</paramtype></parameter><parameter name="td"><paramtype>time_duration_type</paramtype></parameter><purpose>Construct with date and offset in day. </purpose></constructor>
  207. <constructor specifiers="explicit"><parameter name="d"><paramtype>gregorian::date</paramtype></parameter><purpose>Construct a time at start of the given day (midnight) </purpose></constructor>
  208. <constructor><parameter name="rhs"><paramtype>const time_rep_type &amp;</paramtype></parameter><purpose>Copy from time_rep. </purpose></constructor>
  209. <constructor><parameter name="sv"><paramtype>const special_values</paramtype></parameter><purpose>Construct from special value. </purpose></constructor>
  210. <constructor/>
  211. </class>
  212. </namespace>
  213. </namespace>
  214. </header>
  215. <header name="boost/date_time/posix_time/time_formatters.hpp">
  216. <namespace name="boost">
  217. <namespace name="posix_time">
  218. <function name="to_simple_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  219. <template-type-parameter name="charT"/>
  220. </template><parameter name="td"><paramtype><classname>time_duration</classname></paramtype></parameter></function>
  221. <function name="to_iso_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  222. <template-type-parameter name="charT"/>
  223. </template><parameter name="td"><paramtype><classname>time_duration</classname></paramtype></parameter></function>
  224. <function name="to_simple_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  225. <template-type-parameter name="charT"/>
  226. </template><parameter name="t"><paramtype><classname>ptime</classname></paramtype></parameter><purpose>Time to simple format CCYY-mmm-dd hh:mm:ss.fffffff. </purpose></function>
  227. <function name="to_simple_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  228. <template-type-parameter name="charT"/>
  229. </template><parameter name="tp"><paramtype>time_period</paramtype></parameter></function>
  230. <function name="to_iso_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  231. <template-type-parameter name="charT"/>
  232. </template><parameter name="t"><paramtype><classname>ptime</classname></paramtype></parameter></function>
  233. <function name="to_iso_extended_string_type"><type>std::basic_string&lt; charT &gt;</type><template>
  234. <template-type-parameter name="charT"/>
  235. </template><parameter name="t"><paramtype><classname>ptime</classname></paramtype></parameter></function>
  236. <function name="to_simple_wstring"><type>std::wstring</type><parameter name="td"><paramtype><classname>time_duration</classname></paramtype></parameter><purpose>Time duration to wstring -hh::mm::ss.fffffff. Example: 10:09:03.0123456. </purpose></function>
  237. <function name="to_iso_wstring"><type>std::wstring</type><parameter name="td"><paramtype><classname>time_duration</classname></paramtype></parameter><purpose>Time duration in iso format -hhmmss,fffffff Example: 10:09:03,0123456. </purpose></function>
  238. <function name="to_simple_wstring"><type>std::wstring</type><parameter name="t"><paramtype><classname>ptime</classname></paramtype></parameter></function>
  239. <function name="to_simple_wstring"><type>std::wstring</type><parameter name="tp"><paramtype>time_period</paramtype></parameter><purpose>Convert to wstring of form [YYYY-mmm-DD HH:MM::SS.ffffff/YYYY-mmm-DD HH:MM::SS.fffffff]. </purpose></function>
  240. <function name="to_iso_wstring"><type>std::wstring</type><parameter name="t"><paramtype><classname>ptime</classname></paramtype></parameter><purpose>Convert iso short form YYYYMMDDTHHMMSS where T is the date-time separator. </purpose></function>
  241. <function name="to_iso_extended_wstring"><type>std::wstring</type><parameter name="t"><paramtype><classname>ptime</classname></paramtype></parameter><purpose>Convert to form YYYY-MM-DDTHH:MM:SS where T is the date-time separator. </purpose></function>
  242. </namespace>
  243. </namespace>
  244. </header>
  245. <header name="boost/date_time/posix_time/time_formatters_limited.hpp">
  246. <namespace name="boost">
  247. <namespace name="posix_time">
  248. <function name="to_simple_string"><type>std::string</type><parameter name="td"><paramtype><classname>time_duration</classname></paramtype></parameter><purpose>Time duration to string -hh::mm::ss.fffffff. Example: 10:09:03.0123456. </purpose></function>
  249. <function name="to_iso_string"><type>std::string</type><parameter name="td"><paramtype><classname>time_duration</classname></paramtype></parameter><purpose>Time duration in iso format -hhmmss,fffffff Example: 10:09:03,0123456. </purpose></function>
  250. <function name="to_simple_string"><type>std::string</type><parameter name="t"><paramtype><classname>ptime</classname></paramtype></parameter><purpose>Time to simple format CCYY-mmm-dd hh:mm:ss.fffffff. </purpose></function>
  251. <function name="to_simple_string"><type>std::string</type><parameter name="tp"><paramtype>time_period</paramtype></parameter><purpose>Convert to string of form [YYYY-mmm-DD HH:MM::SS.ffffff/YYYY-mmm-DD HH:MM::SS.fffffff]. </purpose></function>
  252. <function name="to_iso_string"><type>std::string</type><parameter name="t"><paramtype><classname>ptime</classname></paramtype></parameter><purpose>Convert iso short form YYYYMMDDTHHMMSS where T is the date-time separator. </purpose></function>
  253. <function name="to_iso_extended_string"><type>std::string</type><parameter name="t"><paramtype><classname>ptime</classname></paramtype></parameter><purpose>Convert to form YYYY-MM-DDTHH:MM:SS where T is the date-time separator. </purpose></function>
  254. </namespace>
  255. </namespace>
  256. </header>
  257. <header name="boost/date_time/posix_time/time_parsers.hpp">
  258. <namespace name="boost">
  259. <namespace name="posix_time">
  260. <function name="duration_from_string"><type><classname>time_duration</classname></type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter><purpose>Creates a <classname alt="boost::posix_time::time_duration">time_duration</classname> object from a delimited string. </purpose><description><para>Expected format for string is "[-]h[h][:mm][:ss][.fff]". A negative duration will be created if the first character in string is a '-', all other '-' will be treated as delimiters. Accepted delimiters are "-:,.". </para></description></function>
  261. <function name="time_from_string"><type><classname>ptime</classname></type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter></function>
  262. <function name="from_iso_string"><type><classname>ptime</classname></type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter></function>
  263. <function name="from_iso_extended_string"><type><classname>ptime</classname></type><parameter name="s"><paramtype>const std::string &amp;</paramtype></parameter></function>
  264. </namespace>
  265. </namespace>
  266. </header>
  267. <header name="boost/date_time/posix_time/time_period.hpp">
  268. <namespace name="boost">
  269. <namespace name="posix_time">
  270. <typedef name="time_period"><purpose>Time period type. </purpose><type>date_time::period&lt; <classname>ptime</classname>, <classname>time_duration</classname> &gt;</type></typedef>
  271. </namespace>
  272. </namespace>
  273. </header>
  274. <header name="boost/date_time/posix_time/time_serialize.hpp">
  275. </header>
  276. </library-reference>