townforge/locale
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
cc
locale/doc/html/group__date__time.html
Artyom Beilis c5ac5b1498 Regenerated documentation
2015-10-18 17:31:48 +03:00

300 lines
17 KiB
HTML
Raw Permalink Blame History

<!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"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Boost.Locale: Date, Time, Timezone and Calendar manipulations</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__date__time.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Date, Time, Timezone and Calendar manipulations</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceboost_1_1locale_1_1period"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1locale_1_1period.html">boost::locale::period</a></td></tr>
<tr class="memdesc:namespaceboost_1_1locale_1_1period"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespace that contains various types for manipulation with dates. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceboost_1_1locale_1_1time__zone"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1locale_1_1time__zone.html">boost::locale::time_zone</a></td></tr>
<tr class="memdesc:namespaceboost_1_1locale_1_1time__zone"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace that holds functions for operating with global time zone <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__error.html">boost::locale::date_time_error</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This error is thrown in case of invalid state that occurred. <a href="classboost_1_1locale_1_1date__time__error.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1date__time__period.html">boost::locale::date_time_period</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">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><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__period__set.html">boost::locale::date_time_period_set</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">this class that represents a set of periods, <a href="classboost_1_1locale_1_1date__time__period__set.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1calendar.html">boost::locale::calendar</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">this class provides an access to general calendar information. <a href="classboost_1_1locale_1_1calendar.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time.html">boost::locale::date_time</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">this class represents a date time and allows to perform various operation according to the locale settings. <a href="classboost_1_1locale_1_1date__time.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1date__time__duration.html">boost::locale::date_time_duration</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">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. <a href="classboost_1_1locale_1_1date__time__duration.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa7e728633f76cae8fa19e76cfb5e113b"><td class="memItemLeft" align="right" valign="top">date_time_period_set&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__date__time.html#gaa7e728633f76cae8fa19e76cfb5e113b">boost::locale::operator+</a> (date_time_period_set const &amp;a, date_time_period_set const &amp;b)</td></tr>
<tr class="separator:gaa7e728633f76cae8fa19e76cfb5e113b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga023333646e070abf361be3890c12560b"><td class="memItemLeft" align="right" valign="top">date_time_period_set&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__date__time.html#ga023333646e070abf361be3890c12560b">boost::locale::operator-</a> (date_time_period_set const &amp;a, date_time_period_set const &amp;b)</td></tr>
<tr class="separator:ga023333646e070abf361be3890c12560b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga759109f4470f00ec3d91f5797db82b9b"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
<tr class="memitem:ga759109f4470f00ec3d91f5797db82b9b"><td class="memTemplItemLeft" align="right" valign="top">std::basic_ostream&lt; CharType &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__date__time.html#ga759109f4470f00ec3d91f5797db82b9b">boost::locale::operator&lt;&lt;</a> (std::basic_ostream&lt; CharType &gt; &amp;out, date_time const &amp;t)</td></tr>
<tr class="separator:ga759109f4470f00ec3d91f5797db82b9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf6e30351fc67e887e37853723c228484"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
<tr class="memitem:gaf6e30351fc67e887e37853723c228484"><td class="memTemplItemLeft" align="right" valign="top">std::basic_istream&lt; CharType &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__date__time.html#gaf6e30351fc67e887e37853723c228484">boost::locale::operator&gt;&gt;</a> (std::basic_istream&lt; CharType &gt; &amp;in, date_time &amp;t)</td></tr>
<tr class="separator:gaf6e30351fc67e887e37853723c228484"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga13c05afeb4ea7904b944b42f6c685022"><td class="memItemLeft" align="right" valign="top">date_time_duration&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__date__time.html#ga13c05afeb4ea7904b944b42f6c685022">boost::locale::operator-</a> (date_time const &amp;later, date_time const &amp;earlier)</td></tr>
<tr class="separator:ga13c05afeb4ea7904b944b42f6c685022"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This module provides various calendar, timezone and date time services </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaa7e728633f76cae8fa19e76cfb5e113b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">date_time_period_set boost::locale::operator+ </td>
<td>(</td>
<td class="paramtype">date_time_period_set const &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">date_time_period_set const &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Append two periods sets. Note this operator is not commutative </p>
</div>
</div>
<a class="anchor" id="ga023333646e070abf361be3890c12560b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">date_time_period_set boost::locale::operator- </td>
<td>(</td>
<td class="paramtype">date_time_period_set const &amp;&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">date_time_period_set const &amp;&#160;</td>
<td class="paramname"><em>b</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Append two period sets when all periods of set <b>change</b> their sign </p>
</div>
</div>
<a class="anchor" id="ga13c05afeb4ea7904b944b42f6c685022"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">date_time_duration boost::locale::operator- </td>
<td>(</td>
<td class="paramtype">date_time const &amp;&#160;</td>
<td class="paramname"><em>later</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">date_time const &amp;&#160;</td>
<td class="paramname"><em>earlier</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the difference between two dates, the left operand is a later point on time line. Returns <a class="el" href="classboost_1_1locale_1_1date__time__duration.html" title="This class represents a period: a pair of two date_time objects. ">date_time_duration</a> object. </p>
</div>
</div>
<a class="anchor" id="ga759109f4470f00ec3d91f5797db82b9b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::basic_ostream&lt;CharType&gt;&amp; boost::locale::operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::basic_ostream&lt; CharType &gt; &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">date_time const &amp;&#160;</td>
<td class="paramname"><em>t</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes <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> <em>t</em> to output stream <em>out</em>.</p>
<p>This function uses locale, calendar and time zone of the target stream <em>in</em>.</p>
<p>For example: </p>
<div class="fragment"><div class="line">date_time now(<a class="code" href="group__manipulators.html#gae669b101cbeaed6f6d246ebdcaa8f39c">time</a>(0),hebrew_calendar)</div>
<div class="line">cout &lt;&lt; &quot;Year: &quot; &lt;&lt; period::year(now) &lt;&lt;&quot; Full Date:&quot;&lt;&lt; now;</div>
</div><!-- fragment --><p>The output may be Year:5770 Full Date:Jan 1, 2010 </p>
</div>
</div>
<a class="anchor" id="gaf6e30351fc67e887e37853723c228484"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::basic_istream&lt;CharType&gt;&amp; boost::locale::operator&gt;&gt; </td>
<td>(</td>
<td class="paramtype">std::basic_istream&lt; CharType &gt; &amp;&#160;</td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">date_time &amp;&#160;</td>
<td class="paramname"><em>t</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads <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> <em>t</em> from output stream <em>in</em> </p>
<p>This function uses locale, calendar and time zone of the source stream <em>in</em>. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<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>
Reference in New Issue View Git Blame Copy Permalink