group__date__time.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>Boost.Locale: Date, Time, Timezone and Calendar manipulations</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. $(window).load(resizeHeight);
  17. </script>
  18. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19. </head>
  20. <body>
  21. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22. <div id="titlearea">
  23. <table cellspacing="0" cellpadding="0">
  24. <tbody>
  25. <tr style="height: 56px;">
  26. <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
  27. <td style="padding-left: 0.5em;">
  28. <div id="projectname">Boost.Locale
  29. </div>
  30. </td>
  31. </tr>
  32. </tbody>
  33. </table>
  34. </div>
  35. <!-- end header part -->
  36. <!-- Generated by Doxygen 1.8.6 -->
  37. <div id="navrow1" class="tabs">
  38. <ul class="tablist">
  39. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  43. <li><a href="annotated.html"><span>Classes</span></a></li>
  44. <li><a href="files.html"><span>Files</span></a></li>
  45. <li><a href="examples.html"><span>Examples</span></a></li>
  46. </ul>
  47. </div>
  48. </div><!-- top -->
  49. <div id="side-nav" class="ui-resizable side-nav-resizable">
  50. <div id="nav-tree">
  51. <div id="nav-tree-contents">
  52. <div id="nav-sync" class="sync"></div>
  53. </div>
  54. </div>
  55. <div id="splitbar" style="-moz-user-select:none;"
  56. class="ui-resizable-handle">
  57. </div>
  58. </div>
  59. <script type="text/javascript">
  60. $(document).ready(function(){initNavTree('group__date__time.html','');});
  61. </script>
  62. <div id="doc-content">
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#namespaces">Namespaces</a> &#124;
  66. <a href="#nested-classes">Classes</a> &#124;
  67. <a href="#func-members">Functions</a> </div>
  68. <div class="headertitle">
  69. <div class="title">Date, Time, Timezone and Calendar manipulations</div> </div>
  70. </div><!--header-->
  71. <div class="contents">
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
  74. Namespaces</h2></td></tr>
  75. <tr class="memitem:namespaceboost_1_1locale_1_1period"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1locale_1_1period.html">boost::locale::period</a></td></tr>
  76. <tr class="memdesc:namespaceboost_1_1locale_1_1period"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace that contains various types for manipulation with dates. <br/></td></tr>
  77. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:namespaceboost_1_1locale_1_1time__zone"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1locale_1_1time__zone.html">boost::locale::time_zone</a></td></tr>
  79. <tr class="memdesc:namespaceboost_1_1locale_1_1time__zone"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace that holds functions for operating with global time zone <br/></td></tr>
  80. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. </table><table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  83. Classes</h2></td></tr>
  84. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__error.html">boost::locale::date_time_error</a></td></tr>
  85. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This error is thrown in case of invalid state that occurred. <a href="classboost_1_1locale_1_1date__time__error.html#details">More...</a><br/></td></tr>
  86. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1date__time__period.html">boost::locale::date_time_period</a></td></tr>
  88. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class represents a pair of period_type and the integer values that describes its amount. For example 3 days or 4 years. <a href="structboost_1_1locale_1_1date__time__period.html#details">More...</a><br/></td></tr>
  89. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__period__set.html">boost::locale::date_time_period_set</a></td></tr>
  91. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">this class that represents a set of periods, <a href="classboost_1_1locale_1_1date__time__period__set.html#details">More...</a><br/></td></tr>
  92. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1calendar.html">boost::locale::calendar</a></td></tr>
  94. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">this class provides an access to general calendar information. <a href="classboost_1_1locale_1_1calendar.html#details">More...</a><br/></td></tr>
  95. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time.html">boost::locale::date_time</a></td></tr>
  97. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">this class represents a date time and allows to perform various operation according to the locale settings. <a href="classboost_1_1locale_1_1date__time.html#details">More...</a><br/></td></tr>
  98. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__duration.html">boost::locale::date_time_duration</a></td></tr>
  100. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class represents a period: a pair of two <a class="el" href="classboost_1_1locale_1_1date__time.html" title="this class represents a date time and allows to perform various operation according to the locale set...">date_time</a> objects. <a href="classboost_1_1locale_1_1date__time__duration.html#details">More...</a><br/></td></tr>
  101. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table><table class="memberdecls">
  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  104. Functions</h2></td></tr>
  105. <tr class="memitem:gaa7e728633f76cae8fa19e76cfb5e113b"><td class="memItemLeft" align="right" valign="top">date_time_period_set&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__date__time.html#gaa7e728633f76cae8fa19e76cfb5e113b">boost::locale::operator+</a> (date_time_period_set const &amp;a, date_time_period_set const &amp;b)</td></tr>
  106. <tr class="separator:gaa7e728633f76cae8fa19e76cfb5e113b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ga023333646e070abf361be3890c12560b"><td class="memItemLeft" align="right" valign="top">date_time_period_set&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__date__time.html#ga023333646e070abf361be3890c12560b">boost::locale::operator-</a> (date_time_period_set const &amp;a, date_time_period_set const &amp;b)</td></tr>
  108. <tr class="separator:ga023333646e070abf361be3890c12560b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ga759109f4470f00ec3d91f5797db82b9b"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
  110. <tr class="memitem:ga759109f4470f00ec3d91f5797db82b9b"><td class="memTemplItemLeft" align="right" valign="top">std::basic_ostream&lt; CharType &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__date__time.html#ga759109f4470f00ec3d91f5797db82b9b">boost::locale::operator&lt;&lt;</a> (std::basic_ostream&lt; CharType &gt; &amp;out, date_time const &amp;t)</td></tr>
  111. <tr class="separator:ga759109f4470f00ec3d91f5797db82b9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:gaf6e30351fc67e887e37853723c228484"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
  113. <tr class="memitem:gaf6e30351fc67e887e37853723c228484"><td class="memTemplItemLeft" align="right" valign="top">std::basic_istream&lt; CharType &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__date__time.html#gaf6e30351fc67e887e37853723c228484">boost::locale::operator&gt;&gt;</a> (std::basic_istream&lt; CharType &gt; &amp;in, date_time &amp;t)</td></tr>
  114. <tr class="separator:gaf6e30351fc67e887e37853723c228484"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:ga13c05afeb4ea7904b944b42f6c685022"><td class="memItemLeft" align="right" valign="top">date_time_duration&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__date__time.html#ga13c05afeb4ea7904b944b42f6c685022">boost::locale::operator-</a> (date_time const &amp;later, date_time const &amp;earlier)</td></tr>
  116. <tr class="separator:ga13c05afeb4ea7904b944b42f6c685022"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table>
  118. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  119. <p>This module provides various calendar, timezone and date time services </p>
  120. <h2 class="groupheader">Function Documentation</h2>
  121. <a class="anchor" id="gaa7e728633f76cae8fa19e76cfb5e113b"></a>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="mlabels">
  125. <tr>
  126. <td class="mlabels-left">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">date_time_period_set boost::locale::operator+ </td>
  130. <td>(</td>
  131. <td class="paramtype">date_time_period_set const &amp;&#160;</td>
  132. <td class="paramname"><em>a</em>, </td>
  133. </tr>
  134. <tr>
  135. <td class="paramkey"></td>
  136. <td></td>
  137. <td class="paramtype">date_time_period_set const &amp;&#160;</td>
  138. <td class="paramname"><em>b</em>&#160;</td>
  139. </tr>
  140. <tr>
  141. <td></td>
  142. <td>)</td>
  143. <td></td><td></td>
  144. </tr>
  145. </table>
  146. </td>
  147. <td class="mlabels-right">
  148. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. <p>Append two periods sets. Note this operator is not commutative </p>
  153. </div>
  154. </div>
  155. <a class="anchor" id="ga023333646e070abf361be3890c12560b"></a>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="mlabels">
  159. <tr>
  160. <td class="mlabels-left">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">date_time_period_set boost::locale::operator- </td>
  164. <td>(</td>
  165. <td class="paramtype">date_time_period_set const &amp;&#160;</td>
  166. <td class="paramname"><em>a</em>, </td>
  167. </tr>
  168. <tr>
  169. <td class="paramkey"></td>
  170. <td></td>
  171. <td class="paramtype">date_time_period_set const &amp;&#160;</td>
  172. <td class="paramname"><em>b</em>&#160;</td>
  173. </tr>
  174. <tr>
  175. <td></td>
  176. <td>)</td>
  177. <td></td><td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <p>Append two period sets when all periods of set <b>change</b> their sign </p>
  187. </div>
  188. </div>
  189. <a class="anchor" id="ga13c05afeb4ea7904b944b42f6c685022"></a>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="mlabels">
  193. <tr>
  194. <td class="mlabels-left">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">date_time_duration boost::locale::operator- </td>
  198. <td>(</td>
  199. <td class="paramtype">date_time const &amp;&#160;</td>
  200. <td class="paramname"><em>later</em>, </td>
  201. </tr>
  202. <tr>
  203. <td class="paramkey"></td>
  204. <td></td>
  205. <td class="paramtype">date_time const &amp;&#160;</td>
  206. <td class="paramname"><em>earlier</em>&#160;</td>
  207. </tr>
  208. <tr>
  209. <td></td>
  210. <td>)</td>
  211. <td></td><td></td>
  212. </tr>
  213. </table>
  214. </td>
  215. <td class="mlabels-right">
  216. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>Calculates the difference between two dates, the left operand is a later point on time line. Returns <a class="el" href="classboost_1_1locale_1_1date__time__duration.html" title="This class represents a period: a pair of two date_time objects. ">date_time_duration</a> object. </p>
  221. </div>
  222. </div>
  223. <a class="anchor" id="ga759109f4470f00ec3d91f5797db82b9b"></a>
  224. <div class="memitem">
  225. <div class="memproto">
  226. <div class="memtemplate">
  227. template&lt;typename CharType &gt; </div>
  228. <table class="memname">
  229. <tr>
  230. <td class="memname">std::basic_ostream&lt;CharType&gt;&amp; boost::locale::operator&lt;&lt; </td>
  231. <td>(</td>
  232. <td class="paramtype">std::basic_ostream&lt; CharType &gt; &amp;&#160;</td>
  233. <td class="paramname"><em>out</em>, </td>
  234. </tr>
  235. <tr>
  236. <td class="paramkey"></td>
  237. <td></td>
  238. <td class="paramtype">date_time const &amp;&#160;</td>
  239. <td class="paramname"><em>t</em>&#160;</td>
  240. </tr>
  241. <tr>
  242. <td></td>
  243. <td>)</td>
  244. <td></td><td></td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>Writes <a class="el" href="classboost_1_1locale_1_1date__time.html" title="this class represents a date time and allows to perform various operation according to the locale set...">date_time</a> <em>t</em> to output stream <em>out</em>.</p>
  249. <p>This function uses locale, calendar and time zone of the target stream <em>in</em>.</p>
  250. <p>For example: </p>
  251. <div class="fragment"><div class="line">date_time now(<a class="code" href="group__manipulators.html#gae669b101cbeaed6f6d246ebdcaa8f39c">time</a>(0),hebrew_calendar)</div>
  252. <div class="line">cout &lt;&lt; &quot;Year: &quot; &lt;&lt; period::year(now) &lt;&lt;&quot; Full Date:&quot;&lt;&lt; now;</div>
  253. </div><!-- fragment --><p>The output may be Year:5770 Full Date:Jan 1, 2010 </p>
  254. </div>
  255. </div>
  256. <a class="anchor" id="gaf6e30351fc67e887e37853723c228484"></a>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <div class="memtemplate">
  260. template&lt;typename CharType &gt; </div>
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">std::basic_istream&lt;CharType&gt;&amp; boost::locale::operator&gt;&gt; </td>
  264. <td>(</td>
  265. <td class="paramtype">std::basic_istream&lt; CharType &gt; &amp;&#160;</td>
  266. <td class="paramname"><em>in</em>, </td>
  267. </tr>
  268. <tr>
  269. <td class="paramkey"></td>
  270. <td></td>
  271. <td class="paramtype">date_time &amp;&#160;</td>
  272. <td class="paramname"><em>t</em>&#160;</td>
  273. </tr>
  274. <tr>
  275. <td></td>
  276. <td>)</td>
  277. <td></td><td></td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. <p>Reads <a class="el" href="classboost_1_1locale_1_1date__time.html" title="this class represents a date time and allows to perform various operation according to the locale set...">date_time</a> <em>t</em> from output stream <em>in</em> </p>
  282. <p>This function uses locale, calendar and time zone of the source stream <em>in</em>. </p>
  283. </div>
  284. </div>
  285. </div><!-- contents -->
  286. </div><!-- doc-content -->
  287. <li class="footer">
  288. &copy; Copyright 2009-2012 Artyom Beilis, Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.
  289. </li>
  290. </ul>
  291. </div>
  292. </body>
  293. </html>