Google Git
Sign in
nest-open-source / nest-learning-thermostat / 5.0 / boost / 317601cb979f96545d0e892ce7cfdf59f676ee0a / . / boost_1_45_0 / doc / html / boost / gregorian / greg_month.html
blob: 8c14c78434f088729a00ceace704e5cbf4e9cf31 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class greg_month</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../date_time/doxy.html#header.boost.date_time.gregorian.greg_month_hpp" title="Header &lt;boost/date_time/gregorian/greg_month.hpp&gt;">
<link rel="prev" href="bad_month.html" title="Struct bad_month">
<link rel="next" href="../../BOOST_SERIALIZATION_SPL_id369474.html" title="Function BOOST_SERIALIZATION_SPLIT_FREE">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bad_month.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.gregorian.greg_month_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../BOOST_SERIALIZATION_SPL_id369474.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.gregorian.greg_month"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class greg_month</span></h2>
<p>boost::gregorian::greg_month &#8212; Wrapper class to represent months in gregorian based calendar. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../date_time/doxy.html#header.boost.date_time.gregorian.greg_month_hpp" title="Header &lt;boost/date_time/gregorian/greg_month.hpp&gt;">boost/date_time/gregorian/greg_month.hpp</a>&gt;
</span>
<span class="keyword">class</span> <a class="link" href="greg_month.html" title="Class greg_month">greg_month</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">months_of_year</span> <a name="boost.gregorian.greg_month.month_enum"></a><span class="identifier">month_enum</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">short</span> <span class="special">&gt;</span> <a name="boost.gregorian.greg_month.month_map_type"></a><span class="identifier">month_map_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span> <span class="identifier">month_map_type</span> <span class="special">&gt;</span> <a name="boost.gregorian.greg_month.month_map_ptr_type"></a><span class="identifier">month_map_ptr_type</span><span class="special">;</span>
<span class="comment">// <a class="link" href="greg_month.html#boost.gregorian.greg_monthconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="greg_month.html#id336177-bb"><span class="identifier">greg_month</span></a><span class="special">(</span><span class="identifier">month_enum</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="greg_month.html#id336187-bb"><span class="identifier">greg_month</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">short</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="greg_month.html#id579427-bb">public member functions</a></span>
<a class="link" href="greg_month.html#id579430-bb"><span class="keyword">operator</span> <span class="keyword">unsigned</span> <span class="keyword">short</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">unsigned</span> <span class="keyword">short</span> <a class="link" href="greg_month.html#id592023-bb"><span class="identifier">as_number</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">month_enum</span> <a class="link" href="greg_month.html#id379412-bb"><span class="identifier">as_enum</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="greg_month.html#id379420-bb"><span class="identifier">as_short_string</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="greg_month.html#id379428-bb"><span class="identifier">as_long_string</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="keyword">wchar_t</span> <span class="special">*</span> <a class="link" href="greg_month.html#id413255-bb"><span class="identifier">as_short_wstring</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="keyword">wchar_t</span> <span class="special">*</span> <a class="link" href="greg_month.html#id413263-bb"><span class="identifier">as_long_wstring</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="greg_month.html#id585747-bb"><span class="identifier">as_short_string</span></a><span class="special">(</span><span class="keyword">char</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="greg_month.html#id443764-bb"><span class="identifier">as_long_string</span></a><span class="special">(</span><span class="keyword">char</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="keyword">wchar_t</span> <span class="special">*</span> <a class="link" href="greg_month.html#id443777-bb"><span class="identifier">as_short_string</span></a><span class="special">(</span><span class="keyword">wchar_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <span class="keyword">wchar_t</span> <span class="special">*</span> <a class="link" href="greg_month.html#id336164-bb"><span class="identifier">as_long_string</span></a><span class="special">(</span><span class="keyword">wchar_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="comment">// <a class="link" href="greg_month.html#id338002-bb">public static functions</a></span>
<span class="keyword">static</span> <span class="identifier">month_map_ptr_type</span> <a class="link" href="greg_month.html#id338005-bb"><span class="identifier">get_month_map_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id1217957"></a><h2>Description</h2>
<div class="refsect2">
<a name="id1217961"></a><h3>
<a name="boost.gregorian.greg_monthconstruct-copy-destruct"></a><code class="computeroutput">greg_month</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id336177-bb"></a><span class="identifier">greg_month</span><span class="special">(</span><span class="identifier">month_enum</span> theMonth<span class="special">)</span><span class="special">;</span></pre>Construct a month from the months_of_year enumeration. </li>
<li class="listitem">
<pre class="literallayout"><a name="id336187-bb"></a><span class="identifier">greg_month</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">short</span> theMonth<span class="special">)</span><span class="special">;</span></pre>Construct from a short value. </li>
</ol></div>
</div>
<div class="refsect2">
<a name="id1218060"></a><h3>
<a name="id579427-bb"></a><code class="computeroutput">greg_month</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id579430-bb"></a><span class="keyword">operator</span> <span class="keyword">unsigned</span> <span class="keyword">short</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Convert the value back to a short. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">unsigned</span> <span class="keyword">short</span> <a name="id592023-bb"></a><span class="identifier">as_number</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns month as number from 1 to 12. </li>
<li class="listitem"><pre class="literallayout"><span class="identifier">month_enum</span> <a name="id379412-bb"></a><span class="identifier">as_enum</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="id379420-bb"></a><span class="identifier">as_short_string</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="id379428-bb"></a><span class="identifier">as_long_string</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">wchar_t</span> <span class="special">*</span> <a name="id413255-bb"></a><span class="identifier">as_short_wstring</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">wchar_t</span> <span class="special">*</span> <a name="id413263-bb"></a><span class="identifier">as_long_wstring</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="id585747-bb"></a><span class="identifier">as_short_string</span><span class="special">(</span><span class="keyword">char</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="id443764-bb"></a><span class="identifier">as_long_string</span><span class="special">(</span><span class="keyword">char</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">wchar_t</span> <span class="special">*</span> <a name="id443777-bb"></a><span class="identifier">as_short_string</span><span class="special">(</span><span class="keyword">wchar_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="keyword">wchar_t</span> <span class="special">*</span> <a name="id336164-bb"></a><span class="identifier">as_long_string</span><span class="special">(</span><span class="keyword">wchar_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="id1218643"></a><h3>
<a name="id338002-bb"></a><code class="computeroutput">greg_month</code> public static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">month_map_ptr_type</span> <a name="id338005-bb"></a><span class="identifier">get_month_map_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Shared pointer to a map of Month strings (Names &amp; Abbrev) &amp; numbers. </li></ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2005 CrystalClear Software, Inc<p>Subject to the Boost Software License, Version 1.0. (See accompanying file
<code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bad_month.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.gregorian.greg_month_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../BOOST_SERIALIZATION_SPL_id369474.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>