1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class greg_month</title>
<link rel="stylesheet" href="../../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 <boost/date_time/gregorian/greg_month.hpp>">
<link rel="prev" href="bad_month.html" title="Struct bad_month">
<link rel="next" href="../../BOOST_SERIALIZATION_SPL_id410620.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/html/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/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../BOOST_SERIALIZATION_SPL_id410620.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class greg_month">
<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 — 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="emphasis"><em>// In header: <<a class="link" href="../../date_time/doxy.html#header.boost.date_time.gregorian.greg_month_hpp" title="Header <boost/date_time/gregorian/greg_month.hpp>">boost/date_time/gregorian/greg_month.hpp</a>>
</em></span>
<span class="bold"><strong>class</strong></span> <a class="link" href="greg_month.html" title="Class greg_month">greg_month</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// types</em></span>
<span class="bold"><strong>typedef</strong></span> date_time::months_of_year <a name="boost.gregorian.greg_month.month_enum"></a>month_enum;
<span class="bold"><strong>typedef</strong></span> std::map< std::string, <span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span> > <a name="boost.gregorian.greg_month.month_map_type"></a>month_map_type;
<span class="bold"><strong>typedef</strong></span> boost::shared_ptr< month_map_type > <a name="boost.gregorian.greg_month.month_map_ptr_type"></a>month_map_ptr_type;
<span class="emphasis"><em>// <a class="link" href="greg_month.html#boost.gregorian.greg_monthconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="greg_month.html#id326024-bb">greg_month</a>(month_enum);
<a class="link" href="greg_month.html#id339108-bb">greg_month</a>(<span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span>);
<span class="emphasis"><em>// <a class="link" href="greg_month.html#id341132-bb">public member functions</a></em></span>
<a class="link" href="greg_month.html#id398645-bb"><span class="bold"><strong>operator</strong></span> <span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span></a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span></span> <a class="link" href="greg_month.html#id398656-bb">as_number</a>() <span class="bold"><strong>const</strong></span>;
<span class="type">month_enum</span> <a class="link" href="greg_month.html#id398666-bb">as_enum</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a class="link" href="greg_month.html#id398674-bb">as_short_string</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a class="link" href="greg_month.html#id596155-bb">as_long_string</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a class="link" href="greg_month.html#id596163-bb">as_short_wstring</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a class="link" href="greg_month.html#id604402-bb">as_long_wstring</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a class="link" href="greg_month.html#id604410-bb">as_short_string</a>(<span class="bold"><strong>char</strong></span>) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a class="link" href="greg_month.html#id317293-bb">as_long_string</a>(<span class="bold"><strong>char</strong></span>) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a class="link" href="greg_month.html#id317306-bb">as_short_string</a>(<span class="bold"><strong>wchar_t</strong></span>) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a class="link" href="greg_month.html#id326010-bb">as_long_string</a>(<span class="bold"><strong>wchar_t</strong></span>) <span class="bold"><strong>const</strong></span>;
<span class="emphasis"><em>// <a class="link" href="greg_month.html#id339117-bb">public static functions</a></em></span>
<span class="type"><span class="bold"><strong>static</strong></span> month_map_ptr_type</span> <a class="link" href="greg_month.html#id339120-bb">get_month_map_ptr</a>() ;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id841875"></a><h2>Description</h2>
<div class="refsect2" title="greg_month public construct/copy/destruct">
<a name="id841879"></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="id326024-bb"></a>greg_month(month_enum theMonth);</pre>Construct a month from the months_of_year enumeration. </li>
<li class="listitem">
<pre class="literallayout"><a name="id339108-bb"></a>greg_month(<span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span> theMonth);</pre>Construct from a short value. </li>
</ol></div>
</div>
<div class="refsect2" title="greg_month public member functions">
<a name="id841941"></a><h3>
<a name="id341132-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="id398645-bb"></a><span class="bold"><strong>operator</strong></span> <span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span>() <span class="bold"><strong>const</strong></span>;</pre>Convert the value back to a short. </li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span></span> <a name="id398656-bb"></a>as_number() <span class="bold"><strong>const</strong></span>;</pre>Returns month as number from 1 to 12. </li>
<li class="listitem"><pre class="literallayout"><span class="type">month_enum</span> <a name="id398666-bb"></a>as_enum() <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id398674-bb"></a>as_short_string() <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id596155-bb"></a>as_long_string() <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a name="id596163-bb"></a>as_short_wstring() <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a name="id604402-bb"></a>as_long_wstring() <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id604410-bb"></a>as_short_string(<span class="bold"><strong>char</strong></span>) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id317293-bb"></a>as_long_string(<span class="bold"><strong>char</strong></span>) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a name="id317306-bb"></a>as_short_string(<span class="bold"><strong>wchar_t</strong></span>) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a name="id326010-bb"></a>as_long_string(<span class="bold"><strong>wchar_t</strong></span>) <span class="bold"><strong>const</strong></span>;</pre></li>
</ol></div>
</div>
<div class="refsect2" title="greg_month public static functions">
<a name="id842331"></a><h3>
<a name="id339117-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="type"><span class="bold"><strong>static</strong></span> month_map_ptr_type</span> <a name="id339120-bb"></a>get_month_map_ptr() ;</pre>Shared pointer to a map of Month strings (Names & Abbrev) & 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 © 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/html/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/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../BOOST_SERIALIZATION_SPL_id410620.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|