Google Git
Sign in
nest-open-source / nest-cam / 4320010 / boost / 62d1066a6d52d5ac4e10c106f0eab14c820be0ce / . / boost / libs / locale / doc / html / structboost_1_1locale_1_1date__time__period.html
blob: 0bc251361b6b928d4a2da0b5cf4c4d7607ab2174 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Boost.Locale: boost::locale::date_time_period Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Boost.Locale
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('structboost_1_1locale_1_1date__time__period.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<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>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="boost::locale::date_time_period" -->
<p>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></p>
<p><code>#include &lt;<a class="el" href="date__time_8hpp_source.html">boost/locale/date_time.hpp</a>&gt;</code></p>
<p><a href="structboost_1_1locale_1_1date__time__period-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><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>
<tr><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>
<tr><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>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6511600eb5264c8597f700668e9c628"></a><!-- doxytag: member="boost::locale::date_time_period::type" ref="aa6511600eb5264c8597f700668e9c628" args="" -->
<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>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of period, i.e. era, year, day etc. <br/></td></tr>
<tr><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>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<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>
<p>Usually obtained as product of period_type and integer or my calling a representative functions For example day()*3 == <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>(day(),3) == day(3) </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a61b11b2243098412dddd804ca7e104af"></a><!-- doxytag: member="boost::locale::date_time_period::date_time_period" ref="a61b11b2243098412dddd804ca7e104af" args="(period::period_type f=period::period_type(), int v=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structboost_1_1locale_1_1date__time__period.html#a61b11b2243098412dddd804ca7e104af">boost::locale::date_time_period::date_time_period</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1locale_1_1period_1_1period__type.html">period::period_type</a>&#160;</td>
<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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>v</em> = <code>1</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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> -- default 1. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a219fa833071824e308a45dc44384fb99"></a><!-- doxytag: member="boost::locale::date_time_period::operator+" ref="a219fa833071824e308a45dc44384fb99" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Operator + returns copy of itself </p>
</div>
</div>
<a class="anchor" id="ab3937bd69fcfeac096dceeee0f13437e"></a><!-- doxytag: member="boost::locale::date_time_period::operator&#45;" ref="ab3937bd69fcfeac096dceeee0f13437e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Operator -, switches the sign of period </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aec776b16ed46a22833308a4112886ca4"></a><!-- doxytag: member="boost::locale::date_time_period::value" ref="aec776b16ed46a22833308a4112886ca4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structboost_1_1locale_1_1date__time__period.html#aec776b16ed46a22833308a4112886ca4">boost::locale::date_time_period::value</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The value the actual number of <em>periods</em> </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>boost/locale/<a class="el" href="date__time_8hpp_source.html">date_time.hpp</a></li>
</ul>
</div><!-- contents -->
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>boost</b> </li>
<li class="navelem"><a class="el" href="namespaceboost_1_1locale.html">locale</a> </li>
<li class="navelem"><a class="el" href="structboost_1_1locale_1_1date__time__period.html">date_time_period</a> </li>
<li class="footer">
&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.
</li>
</ul>
</div>
</body>
</html>