ceph/src/boost/libs/locale/doc/html/structboost_1_1locale_1_1date__time__period.html

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