classboost_1_1locale_1_1date__time__duration.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  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: boost::locale::date_time_duration Class Reference</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 class="current"><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 id="navrow2" class="tabs2">
  49. <ul class="tablist">
  50. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  51. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  52. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  53. </ul>
  54. </div>
  55. </div><!-- top -->
  56. <div id="side-nav" class="ui-resizable side-nav-resizable">
  57. <div id="nav-tree">
  58. <div id="nav-tree-contents">
  59. <div id="nav-sync" class="sync"></div>
  60. </div>
  61. </div>
  62. <div id="splitbar" style="-moz-user-select:none;"
  63. class="ui-resizable-handle">
  64. </div>
  65. </div>
  66. <script type="text/javascript">
  67. $(document).ready(function(){initNavTree('classboost_1_1locale_1_1date__time__duration.html','');});
  68. </script>
  69. <div id="doc-content">
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="classboost_1_1locale_1_1date__time__duration-members.html">List of all members</a> </div>
  74. <div class="headertitle">
  75. <div class="title">boost::locale::date_time_duration Class Reference<div class="ingroups"><a class="el" href="group__date__time.html">Date, Time, Timezone and Calendar manipulations</a></div></div> </div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p>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.
  79. <a href="classboost_1_1locale_1_1date__time__duration.html#details">More...</a></p>
  80. <p><code>#include &lt;<a class="el" href="date__time_8hpp_source.html">boost/locale/date_time.hpp</a>&gt;</code></p>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  83. Public Member Functions</h2></td></tr>
  84. <tr class="memitem:ac4b0d49c998032003553e8faf0e5f2cb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__duration.html#ac4b0d49c998032003553e8faf0e5f2cb">date_time_duration</a> (<a class="el" href="classboost_1_1locale_1_1date__time.html">date_time</a> const &amp;first, <a class="el" href="classboost_1_1locale_1_1date__time.html">date_time</a> const &amp;second)</td></tr>
  85. <tr class="separator:ac4b0d49c998032003553e8faf0e5f2cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a5d1b702c281d205e1dafbb15ce85b447"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__duration.html#a5d1b702c281d205e1dafbb15ce85b447">get</a> (<a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period::period_type</a> f) const </td></tr>
  87. <tr class="separator:a5d1b702c281d205e1dafbb15ce85b447"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ac1a04091cc80b98f6faf7e5e73ce5f35"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__duration.html#ac1a04091cc80b98f6faf7e5e73ce5f35">operator/</a> (<a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period::period_type</a> f) const </td></tr>
  89. <tr class="separator:ac1a04091cc80b98f6faf7e5e73ce5f35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:afc2f075595d1774c866250d192b9db31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1locale_1_1date__time.html">date_time</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__duration.html#afc2f075595d1774c866250d192b9db31">start</a> () const </td></tr>
  91. <tr class="separator:afc2f075595d1774c866250d192b9db31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a100bac2003f4e07ea498e10d0dd1f6b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1locale_1_1date__time.html">date_time</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__duration.html#a100bac2003f4e07ea498e10d0dd1f6b1">end</a> () const </td></tr>
  93. <tr class="separator:a100bac2003f4e07ea498e10d0dd1f6b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table>
  95. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  96. <div class="textblock"><p>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. </p>
  97. <p>It is generally used as syntactic sugar to calculate difference between two dates.</p>
  98. <p>Note: it stores references to the original objects, so it is not recommended to be used outside of the equation you calculate the difference in. </p>
  99. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  100. <a class="anchor" id="ac4b0d49c998032003553e8faf0e5f2cb"></a>
  101. <div class="memitem">
  102. <div class="memproto">
  103. <table class="mlabels">
  104. <tr>
  105. <td class="mlabels-left">
  106. <table class="memname">
  107. <tr>
  108. <td class="memname">boost::locale::date_time_duration::date_time_duration </td>
  109. <td>(</td>
  110. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1date__time.html">date_time</a> const &amp;&#160;</td>
  111. <td class="paramname"><em>first</em>, </td>
  112. </tr>
  113. <tr>
  114. <td class="paramkey"></td>
  115. <td></td>
  116. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1date__time.html">date_time</a> const &amp;&#160;</td>
  117. <td class="paramname"><em>second</em>&#160;</td>
  118. </tr>
  119. <tr>
  120. <td></td>
  121. <td>)</td>
  122. <td></td><td></td>
  123. </tr>
  124. </table>
  125. </td>
  126. <td class="mlabels-right">
  127. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  128. </tr>
  129. </table>
  130. </div><div class="memdoc">
  131. <p>Create an object were <em>first</em> represents earlier point on time line and <em>second</em> is later point. </p>
  132. </div>
  133. </div>
  134. <h2 class="groupheader">Member Function Documentation</h2>
  135. <a class="anchor" id="a100bac2003f4e07ea498e10d0dd1f6b1"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="mlabels">
  139. <tr>
  140. <td class="mlabels-left">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname"><a class="el" href="classboost_1_1locale_1_1date__time.html">date_time</a> const&amp; boost::locale::date_time_duration::end </td>
  144. <td>(</td>
  145. <td class="paramname"></td><td>)</td>
  146. <td> const</td>
  147. </tr>
  148. </table>
  149. </td>
  150. <td class="mlabels-right">
  151. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. <p>Get ending point </p>
  156. </div>
  157. </div>
  158. <a class="anchor" id="a5d1b702c281d205e1dafbb15ce85b447"></a>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="mlabels">
  162. <tr>
  163. <td class="mlabels-left">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">int boost::locale::date_time_duration::get </td>
  167. <td>(</td>
  168. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period::period_type</a>&#160;</td>
  169. <td class="paramname"><em>f</em></td><td>)</td>
  170. <td> const</td>
  171. </tr>
  172. </table>
  173. </td>
  174. <td class="mlabels-right">
  175. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>find a difference in terms of period_type <em>f</em> </p>
  180. </div>
  181. </div>
  182. <a class="anchor" id="ac1a04091cc80b98f6faf7e5e73ce5f35"></a>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="mlabels">
  186. <tr>
  187. <td class="mlabels-left">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">int boost::locale::date_time_duration::operator/ </td>
  191. <td>(</td>
  192. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period::period_type</a>&#160;</td>
  193. <td class="paramname"><em>f</em></td><td>)</td>
  194. <td> const</td>
  195. </tr>
  196. </table>
  197. </td>
  198. <td class="mlabels-right">
  199. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  200. </tr>
  201. </table>
  202. </div><div class="memdoc">
  203. <p>Syntactic sugar for get(f) </p>
  204. </div>
  205. </div>
  206. <a class="anchor" id="afc2f075595d1774c866250d192b9db31"></a>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="mlabels">
  210. <tr>
  211. <td class="mlabels-left">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname"><a class="el" href="classboost_1_1locale_1_1date__time.html">date_time</a> const&amp; boost::locale::date_time_duration::start </td>
  215. <td>(</td>
  216. <td class="paramname"></td><td>)</td>
  217. <td> const</td>
  218. </tr>
  219. </table>
  220. </td>
  221. <td class="mlabels-right">
  222. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Get starting point </p>
  227. </div>
  228. </div>
  229. <hr/>The documentation for this class was generated from the following file:<ul>
  230. <li>boost/locale/<a class="el" href="date__time_8hpp_source.html">date_time.hpp</a></li>
  231. </ul>
  232. </div><!-- contents -->
  233. </div><!-- doc-content -->
  234. <li class="footer">
  235. &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.
  236. </li>
  237. </ul>
  238. </div>
  239. </body>
  240. </html>