summaryrefslogtreecommitdiff
path: root/doc/html/greg_month.html
blob: d422ce9dda2f56485b9f0c3a9ed276e340498cb4 (plain)
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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class greg_month</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="The Boost C++ Libraries">
<link rel="up" href="date_time/doxy.html#id871347" 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="bad_weekday.html" title="Struct bad_weekday">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
<td align="center"><a href="../../index.htm">Home</a></td>
<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../people/people.htm">People</a></td>
<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bad_month.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id871347"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="bad_weekday.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="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="bold"><strong>class</strong></span> greg_month {
<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               month_enum;        
  <span class="bold"><strong>typedef</strong></span> std::map&lt; std::string, <span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span> &gt; month_map_type;    
  <span class="bold"><strong>typedef</strong></span> boost::shared_ptr&lt; month_map_type &gt;     month_map_ptr_type;

  <span class="emphasis"><em>// <a href="greg_month.html#greg_monthconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="greg_month.html#id792405-bb">greg_month</a>(month_enum);
  <a href="greg_month.html#id977020-bb">greg_month</a>(<span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span>);

  <span class="emphasis"><em>// <a href="greg_month.html#id802836-bb">public member functions</a></em></span>
  <a href="greg_month.html#id802841-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 href="greg_month.html#id792211-bb">as_number</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">month_enum</span> <a href="greg_month.html#id792228-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 href="greg_month.html#id1034304-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 href="greg_month.html#id894041-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 href="greg_month.html#id939620-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 href="greg_month.html#id939633-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 href="greg_month.html#id939646-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 href="greg_month.html#id939670-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 href="greg_month.html#id894508-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 href="greg_month.html#id894531-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 href="greg_month.html#id833093-bb">public static functions</a></em></span>
  <span class="type">month_map_ptr_type</span> <a href="greg_month.html#id977054-bb">get_month_map_ptr</a>() ;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1153354"></a><h2>Description</h2>
<div class="refsect2" lang="en">
<a name="id1153358"></a><h3>
<a name="greg_monthconstruct-copy-destruct"></a><code class="computeroutput">greg_month</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><a name="id792405-bb"></a>greg_month(month_enum theMonth);</pre></li>
<li><pre class="literallayout"><a name="id977020-bb"></a>greg_month(<span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span> theMonth);</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1153417"></a><h3>
<a name="id802836-bb"></a><code class="computeroutput">greg_month</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><a name="id802841-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></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>unsigned</strong></span> <span class="bold"><strong>short</strong></span></span> <a name="id792211-bb"></a>as_number() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">month_enum</span> <a name="id792228-bb"></a>as_enum() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id1034304-bb"></a>as_short_string() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id894041-bb"></a>as_long_string() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a name="id939620-bb"></a>as_short_wstring() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a name="id939633-bb"></a>as_long_wstring() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id939646-bb"></a>as_short_string(<span class="bold"><strong>char</strong></span> ) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>char</strong></span> *</span> <a name="id939670-bb"></a>as_long_string(<span class="bold"><strong>char</strong></span> ) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a name="id894508-bb"></a>as_short_string(<span class="bold"><strong>wchar_t</strong></span> ) <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>const</strong></span> <span class="bold"><strong>wchar_t</strong></span> *</span> <a name="id894531-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" lang="en">
<a name="id1171281"></a><h3>
<a name="id833093-bb"></a><code class="computeroutput">greg_month</code> public static functions</h3>
<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><span class="type">month_map_ptr_type</span> <a name="id977054-bb"></a>get_month_map_ptr() ;</pre></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="bad_month.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id871347"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="bad_weekday.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>