structboost_1_1locale_1_1date__time__period.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  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_period Struct 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('structboost_1_1locale_1_1date__time__period.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="#pub-attribs">Public Attributes</a> &#124;
  74. <a href="structboost_1_1locale_1_1date__time__period-members.html">List of all members</a> </div>
  75. <div class="headertitle">
  76. <div class="title">boost::locale::date_time_period Struct Reference<div class="ingroups"><a class="el" href="group__date__time.html">Date, Time, Timezone and Calendar manipulations</a></div></div> </div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p>This class represents a pair of period_type and the integer values that describes its amount. For example 3 days or 4 years.
  80. <a href="structboost_1_1locale_1_1date__time__period.html#details">More...</a></p>
  81. <p><code>#include &lt;<a class="el" href="date__time_8hpp_source.html">boost/locale/date_time.hpp</a>&gt;</code></p>
  82. <table class="memberdecls">
  83. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  84. Public Member Functions</h2></td></tr>
  85. <tr class="memitem:a219fa833071824e308a45dc44384fb99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1locale_1_1date__time__period.html">date_time_period</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1date__time__period.html#a219fa833071824e308a45dc44384fb99">operator+</a> () const </td></tr>
  86. <tr class="separator:a219fa833071824e308a45dc44384fb99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ab3937bd69fcfeac096dceeee0f13437e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structboost_1_1locale_1_1date__time__period.html">date_time_period</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1date__time__period.html#ab3937bd69fcfeac096dceeee0f13437e">operator-</a> () const </td></tr>
  88. <tr class="separator:ab3937bd69fcfeac096dceeee0f13437e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a61b11b2243098412dddd804ca7e104af"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1date__time__period.html#a61b11b2243098412dddd804ca7e104af">date_time_period</a> (<a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period::period_type</a> f=<a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period::period_type</a>(), int v=1)</td></tr>
  90. <tr class="separator:a61b11b2243098412dddd804ca7e104af"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table><table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  93. Public Attributes</h2></td></tr>
  94. <tr class="memitem:aa6511600eb5264c8597f700668e9c628"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6511600eb5264c8597f700668e9c628"></a>
  95. <a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period::period_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1date__time__period.html#aa6511600eb5264c8597f700668e9c628">type</a></td></tr>
  96. <tr class="memdesc:aa6511600eb5264c8597f700668e9c628"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of period, i.e. era, year, day etc. <br/></td></tr>
  97. <tr class="separator:aa6511600eb5264c8597f700668e9c628"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:aec776b16ed46a22833308a4112886ca4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1date__time__period.html#aec776b16ed46a22833308a4112886ca4">value</a></td></tr>
  99. <tr class="separator:aec776b16ed46a22833308a4112886ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. </table>
  101. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  102. <div class="textblock"><p>This class represents a pair of period_type and the integer values that describes its amount. For example 3 days or 4 years. </p>
  103. <p>Usually obtained as product of period_type and integer or my calling a representative functions For example day()*3 == date_time_period(day(),3) == day(3) </p>
  104. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  105. <a class="anchor" id="a61b11b2243098412dddd804ca7e104af"></a>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="mlabels">
  109. <tr>
  110. <td class="mlabels-left">
  111. <table class="memname">
  112. <tr>
  113. <td class="memname">boost::locale::date_time_period::date_time_period </td>
  114. <td>(</td>
  115. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period::period_type</a>&#160;</td>
  116. <td class="paramname"><em>f</em> = <code><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period::period_type</a>()</code>, </td>
  117. </tr>
  118. <tr>
  119. <td class="paramkey"></td>
  120. <td></td>
  121. <td class="paramtype">int&#160;</td>
  122. <td class="paramname"><em>v</em> = <code>1</code>&#160;</td>
  123. </tr>
  124. <tr>
  125. <td></td>
  126. <td>)</td>
  127. <td></td><td></td>
  128. </tr>
  129. </table>
  130. </td>
  131. <td class="mlabels-right">
  132. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  133. </tr>
  134. </table>
  135. </div><div class="memdoc">
  136. <p>Constructor that creates <a class="el" href="structboost_1_1locale_1_1date__time__period.html" title="This class represents a pair of period_type and the integer values that describes its amount...">date_time_period</a> from period_type <em>f</em> and a value <em>v</em> &ndash; default 1. </p>
  137. </div>
  138. </div>
  139. <h2 class="groupheader">Member Function Documentation</h2>
  140. <a class="anchor" id="a219fa833071824e308a45dc44384fb99"></a>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="mlabels">
  144. <tr>
  145. <td class="mlabels-left">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname"><a class="el" href="structboost_1_1locale_1_1date__time__period.html">date_time_period</a> boost::locale::date_time_period::operator+ </td>
  149. <td>(</td>
  150. <td class="paramname"></td><td>)</td>
  151. <td> const</td>
  152. </tr>
  153. </table>
  154. </td>
  155. <td class="mlabels-right">
  156. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. <p>Operator + returns copy of itself </p>
  161. </div>
  162. </div>
  163. <a class="anchor" id="ab3937bd69fcfeac096dceeee0f13437e"></a>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="mlabels">
  167. <tr>
  168. <td class="mlabels-left">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname"><a class="el" href="structboost_1_1locale_1_1date__time__period.html">date_time_period</a> boost::locale::date_time_period::operator- </td>
  172. <td>(</td>
  173. <td class="paramname"></td><td>)</td>
  174. <td> const</td>
  175. </tr>
  176. </table>
  177. </td>
  178. <td class="mlabels-right">
  179. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>Operator -, switches the sign of period </p>
  184. </div>
  185. </div>
  186. <h2 class="groupheader">Member Data Documentation</h2>
  187. <a class="anchor" id="aec776b16ed46a22833308a4112886ca4"></a>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">int boost::locale::date_time_period::value</td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>The value the actual number of <em>periods</em> </p>
  197. </div>
  198. </div>
  199. <hr/>The documentation for this struct was generated from the following file:<ul>
  200. <li>boost/locale/<a class="el" href="date__time_8hpp_source.html">date_time.hpp</a></li>
  201. </ul>
  202. </div><!-- contents -->
  203. </div><!-- doc-content -->
  204. <li class="footer">
  205. &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.
  206. </li>
  207. </ul>
  208. </div>
  209. </body>
  210. </html>