classboost_1_1locale_1_1period_1_1period__type.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  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::period::period_type 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_1period_1_1period__type.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_1period_1_1period__type-members.html">List of all members</a> </div>
  74. <div class="headertitle">
  75. <div class="title">boost::locale::period::period_type Class Reference</div> </div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p>This class holds a type that represents certain period of time like year, hour, second and so on.
  79. <a href="classboost_1_1locale_1_1period_1_1period__type.html#details">More...</a></p>
  80. <p><code>#include &lt;<a class="el" href="date__time__facet_8hpp_source.html">boost/locale/date_time_facet.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:a8abba35d5073884677ce69ec3ba3eba7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html#a8abba35d5073884677ce69ec3ba3eba7">period_type</a> (<a class="el" href="namespaceboost_1_1locale_1_1period_1_1marks.html#a1536eaff4b2a880782128fc127f40d3a">marks::period_mark</a> m=<a class="el" href="namespaceboost_1_1locale_1_1period_1_1marks.html#a1536eaff4b2a880782128fc127f40d3aab24556edbe246e0bc3b4b0d3f2e627eb">marks::invalid</a>)</td></tr>
  85. <tr class="separator:a8abba35d5073884677ce69ec3ba3eba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ad81b414edc6ea88accc5dad5d17a351b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceboost_1_1locale_1_1period_1_1marks.html#a1536eaff4b2a880782128fc127f40d3a">marks::period_mark</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html#ad81b414edc6ea88accc5dad5d17a351b">mark</a> () const </td></tr>
  87. <tr class="separator:ad81b414edc6ea88accc5dad5d17a351b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a53ac6fdbaa7ae1b6d90e67bb5aadcce0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html#a53ac6fdbaa7ae1b6d90e67bb5aadcce0">operator==</a> (<a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period_type</a> const &amp;other) const </td></tr>
  89. <tr class="separator:a53ac6fdbaa7ae1b6d90e67bb5aadcce0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a0156ce442f97fd86fa7c702e4d24031a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html#a0156ce442f97fd86fa7c702e4d24031a">operator!=</a> (<a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period_type</a> const &amp;other) const </td></tr>
  91. <tr class="separator:a0156ce442f97fd86fa7c702e4d24031a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table>
  93. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  94. <div class="textblock"><p>This class holds a type that represents certain period of time like year, hour, second and so on. </p>
  95. <p>It can be created from either <a class="el" href="namespaceboost_1_1locale_1_1period_1_1marks.html#a1536eaff4b2a880782128fc127f40d3a" title="the type that defines a flag that holds a period identifier ">marks::period_mark</a> type or by using shortcuts in period namespace - calling functions like <a class="el" href="namespaceboost_1_1locale_1_1period.html#a9ea8d1453bed512ee16bea3199fd92af">period::year()</a>, <a class="el" href="namespaceboost_1_1locale_1_1period.html#a35f2ca900e3cda757c4598b686ca5969">period::hour()</a> and so on.</p>
  96. <p>Basically it represents the same object as enum <a class="el" href="namespaceboost_1_1locale_1_1period_1_1marks.html#a1536eaff4b2a880782128fc127f40d3a" title="the type that defines a flag that holds a period identifier ">marks::period_mark</a> but allows to provide save operator overloading that would not collide with casing of enum to numeric values. </p>
  97. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  98. <a class="anchor" id="a8abba35d5073884677ce69ec3ba3eba7"></a>
  99. <div class="memitem">
  100. <div class="memproto">
  101. <table class="mlabels">
  102. <tr>
  103. <td class="mlabels-left">
  104. <table class="memname">
  105. <tr>
  106. <td class="memname">boost::locale::period::period_type::period_type </td>
  107. <td>(</td>
  108. <td class="paramtype"><a class="el" href="namespaceboost_1_1locale_1_1period_1_1marks.html#a1536eaff4b2a880782128fc127f40d3a">marks::period_mark</a>&#160;</td>
  109. <td class="paramname"><em>m</em> = <code><a class="el" href="namespaceboost_1_1locale_1_1period_1_1marks.html#a1536eaff4b2a880782128fc127f40d3aab24556edbe246e0bc3b4b0d3f2e627eb">marks::invalid</a></code></td><td>)</td>
  110. <td></td>
  111. </tr>
  112. </table>
  113. </td>
  114. <td class="mlabels-right">
  115. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  116. </tr>
  117. </table>
  118. </div><div class="memdoc">
  119. <p>Create a period of specific type, default is invalid. </p>
  120. </div>
  121. </div>
  122. <h2 class="groupheader">Member Function Documentation</h2>
  123. <a class="anchor" id="ad81b414edc6ea88accc5dad5d17a351b"></a>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="mlabels">
  127. <tr>
  128. <td class="mlabels-left">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname"><a class="el" href="namespaceboost_1_1locale_1_1period_1_1marks.html#a1536eaff4b2a880782128fc127f40d3a">marks::period_mark</a> boost::locale::period::period_type::mark </td>
  132. <td>(</td>
  133. <td class="paramname"></td><td>)</td>
  134. <td> const</td>
  135. </tr>
  136. </table>
  137. </td>
  138. <td class="mlabels-right">
  139. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p>Get the value of <a class="el" href="namespaceboost_1_1locale_1_1period_1_1marks.html#a1536eaff4b2a880782128fc127f40d3a" title="the type that defines a flag that holds a period identifier ">marks::period_mark</a> it was created with. </p>
  144. </div>
  145. </div>
  146. <a class="anchor" id="a0156ce442f97fd86fa7c702e4d24031a"></a>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="mlabels">
  150. <tr>
  151. <td class="mlabels-left">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">bool boost::locale::period::period_type::operator!= </td>
  155. <td>(</td>
  156. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period_type</a> const &amp;&#160;</td>
  157. <td class="paramname"><em>other</em></td><td>)</td>
  158. <td> const</td>
  159. </tr>
  160. </table>
  161. </td>
  162. <td class="mlabels-right">
  163. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Check if two periods are different </p>
  168. </div>
  169. </div>
  170. <a class="anchor" id="a53ac6fdbaa7ae1b6d90e67bb5aadcce0"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="mlabels">
  174. <tr>
  175. <td class="mlabels-left">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">bool boost::locale::period::period_type::operator== </td>
  179. <td>(</td>
  180. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period_type</a> const &amp;&#160;</td>
  181. <td class="paramname"><em>other</em></td><td>)</td>
  182. <td> const</td>
  183. </tr>
  184. </table>
  185. </td>
  186. <td class="mlabels-right">
  187. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>Check if two periods are the same </p>
  192. </div>
  193. </div>
  194. <hr/>The documentation for this class was generated from the following file:<ul>
  195. <li>boost/locale/<a class="el" href="date__time__facet_8hpp_source.html">date_time_facet.hpp</a></li>
  196. </ul>
  197. </div><!-- contents -->
  198. </div><!-- doc-content -->
  199. <li class="footer">
  200. &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.
  201. </li>
  202. </ul>
  203. </div>
  204. </body>
  205. </html>