summaryrefslogtreecommitdiff
path: root/doc/html/boost/gregorian/date.html
blob: f60a887cec6f438732c1ba37898c013e0fb8f20c (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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Class date</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#id836108" title="Header &lt;boost/date_time/gregorian/greg_date.hpp&gt;">
<link rel="prev" href="../../gregorian_calendar.html" title="Class gregorian_calendar">
<link rel="next" href="../../bad_day_of_month.html" title="Struct bad_day_of_month">
</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="../../gregorian_calendar.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#id836108"><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_day_of_month.html"><img src="../../images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="boost.gregorian.date"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class date</span></h2>
<p>boost::gregorian::date &#8212; A date type based on gregorian_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> date {
<span class="bold"><strong>public</strong></span>:
  <span class="emphasis"><em>// types</em></span>
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::year_type        year_type;       
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::month_type       month_type;      
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::day_type         day_type;        
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::day_of_year_type day_of_year_type;
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::ymd_type         ymd_type;        
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::date_rep_type    date_rep_type;   
  <span class="bold"><strong>typedef</strong></span> gregorian_calendar::date_int_type    date_int_type;   
  <span class="bold"><strong>typedef</strong></span> date_duration                        duration_type;   

  <span class="emphasis"><em>// <a href="date.html#boost.gregorian.dateconstruct-copy-destruct">construct/copy/destruct</a></em></span>
  <a href="date.html#id965039-bb">date</a>();
  <a href="date.html#id1108828-bb">date</a>(year_type, month_type, day_type);
  <a href="date.html#id837863-bb">date</a>(<span class="bold"><strong>const</strong></span> ymd_type &amp;);
  <a href="date.html#id936851-bb">date</a>(<span class="bold"><strong>const</strong></span> date_int_type &amp;);
  <a href="date.html#id835710-bb">date</a>(date_rep_type);
  <a href="date.html#id835729-bb">date</a>(special_values);

  <span class="emphasis"><em>// <a href="date.html#id1109300-bb">public member functions</a></em></span>
  <span class="type">date_int_type</span> <a href="date.html#id868803-bb">julian_day</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">day_of_year_type</span> <a href="date.html#id868820-bb">day_of_year</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>long</strong></span></span> <a href="date.html#id798683-bb">modjulian_day</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><span class="bold"><strong>int</strong></span></span> <a href="date.html#id1036065-bb">week_number</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type">date_int_type</span> <a href="date.html#id1031184-bb">day_number</a>() <span class="bold"><strong>const</strong></span>;
  <span class="type"><a href="date.html" title="Class date">date</a></span> <a href="date.html#id908610-bb">end_of_month</a>() <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" lang="en">
<a name="id1150185"></a><h2>Description</h2>
<p>This class is the primary interface for programming with greogorian dates. The is a lightweight type that can be freely passed by value. All comparison operators are supported. </p>
<div class="refsect2" lang="en">
<a name="id1150194"></a><h3>
<a name="boost.gregorian.dateconstruct-copy-destruct"></a><code class="computeroutput">date</code> construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><a name="id965039-bb"></a>date();</pre></li>
<li><pre class="literallayout"><a name="id1108828-bb"></a>date(year_type y, month_type m, day_type d);</pre></li>
<li><pre class="literallayout"><a name="id837863-bb"></a>date(<span class="bold"><strong>const</strong></span> ymd_type &amp; ymd);</pre></li>
<li><pre class="literallayout"><a name="id936851-bb"></a>date(<span class="bold"><strong>const</strong></span> date_int_type &amp; rhs);</pre></li>
<li><pre class="literallayout"><a name="id835710-bb"></a>date(date_rep_type rhs);</pre></li>
<li><pre class="literallayout"><a name="id835729-bb"></a>date(special_values sv);</pre></li>
</ol></div>
</div>
<div class="refsect2" lang="en">
<a name="id1150306"></a><h3>
<a name="id1109300-bb"></a><code class="computeroutput">date</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li><pre class="literallayout"><span class="type">date_int_type</span> <a name="id868803-bb"></a>julian_day() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">day_of_year_type</span> <a name="id868820-bb"></a>day_of_year() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>long</strong></span></span> <a name="id798683-bb"></a>modjulian_day() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><span class="bold"><strong>int</strong></span></span> <a name="id1036065-bb"></a>week_number() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type">date_int_type</span> <a name="id1031184-bb"></a>day_number() <span class="bold"><strong>const</strong></span>;</pre></li>
<li><pre class="literallayout"><span class="type"><a href="date.html" title="Class date">date</a></span> <a name="id908610-bb"></a>end_of_month() <span class="bold"><strong>const</strong></span>;</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="../../gregorian_calendar.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#id836108"><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_day_of_month.html"><img src="../../images/next.png" alt="Next"></a>
</div>
</body>
</html>