doc/html/boost/date_time/partial_date.html


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
115
116

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template partial_date</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<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.date_generators_hpp" title="Header &lt;boost/date_time/date_generators.hpp&gt;">
<link rel="prev" href="year_based_generator.html" title="Class template year_based_generator">
<link rel="next" href="nth_kday_of_month.html" title="Class template nth_kday_of_month">
</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="year_based_generator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_generators_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="nth_kday_of_month.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.date_time.partial_date"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template partial_date</span></h2>
<p>boost::date_time::partial_date &#8212; Generates a date by applying the year to the given month and day. </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.date_generators_hpp" title="Header &lt;boost/date_time/date_generators.hpp&gt;">boost/date_time/date_generators.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> date_type<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="partial_date.html" title="Class template partial_date">partial_date</a> <span class="special">:</span>
  <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">year_based_generator</span><span class="special">&lt;</span> <span class="identifier">date_type</span> <span class="special">&gt;</span>
<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_type</span><span class="special">::</span><span class="identifier">calendar_type</span>    <a name="boost.date_time.partial_date.calendar_type"></a><span class="identifier">calendar_type</span><span class="special">;</span>
  <span class="keyword">typedef</span> <span class="identifier">calendar_type</span><span class="special">::</span><span class="identifier">day_type</span>     <a name="boost.date_time.partial_date.day_type"></a><span class="identifier">day_type</span><span class="special">;</span>     
  <span class="keyword">typedef</span> <span class="identifier">calendar_type</span><span class="special">::</span><span class="identifier">month_type</span>   <a name="boost.date_time.partial_date.month_type"></a><span class="identifier">month_type</span><span class="special">;</span>   
  <span class="keyword">typedef</span> <span class="identifier">calendar_type</span><span class="special">::</span><span class="identifier">year_type</span>    <a name="boost.date_time.partial_date.year_type"></a><span class="identifier">year_type</span><span class="special">;</span>    
  <span class="keyword">typedef</span> <span class="identifier">date_type</span><span class="special">::</span><span class="identifier">duration_type</span>    <a name="boost.date_time.partial_date.duration_type"></a><span class="identifier">duration_type</span><span class="special">;</span>
  <span class="keyword">typedef</span> <span class="identifier">duration_type</span><span class="special">::</span><span class="identifier">duration_rep</span> <a name="boost.date_time.partial_date.duration_rep"></a><span class="identifier">duration_rep</span><span class="special">;</span> 

  <span class="comment">// <a class="link" href="partial_date.html#boost.date_time.partial_dateconstruct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="partial_date.html#idp100041360-bb"><span class="identifier">partial_date</span></a><span class="special">(</span><span class="identifier">day_type</span><span class="special">,</span> <span class="identifier">month_type</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="partial_date.html#idp70026288-bb"><span class="identifier">partial_date</span></a><span class="special">(</span><span class="identifier">duration_rep</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="partial_date.html#idp38535616-bb">public member functions</a></span>
  <span class="keyword">virtual</span> <span class="identifier">date_type</span> <a class="link" href="partial_date.html#idp49430736-bb"><span class="identifier">get_date</span></a><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">date_type</span> <a class="link" href="partial_date.html#idp98252256-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="partial_date.html#idp108313824-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="partial_date.html" title="Class template partial_date">partial_date</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="partial_date.html#idp54980512-bb"><span class="keyword">operator</span><span class="special">&lt;</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="partial_date.html" title="Class template partial_date">partial_date</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">month_type</span> <a class="link" href="partial_date.html#idp104116384-bb"><span class="identifier">month</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">day_type</span> <a class="link" href="partial_date.html#idp98755968-bb"><span class="identifier">day</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="partial_date.html#idp94464240-bb"><span class="identifier">to_string</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp187202640"></a><h2>Description</h2>
<p>Example usage: </p>
<pre class="programlisting"><span class="identifier">partial_date</span> <span class="identifier">pd</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="identifier">Jan</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">partial_date</span> <span class="identifier">pd2</span><span class="special">(</span><span class="number">70</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">date</span> <span class="identifier">d</span> <span class="special">=</span> <span class="identifier">pd</span><span class="special">.</span><span class="identifier">get_date</span><span class="special">(</span><span class="number">2002</span><span class="special">)</span><span class="special">;</span> <span class="comment">//2002-Jan-01</span>
<span class="identifier">date</span> <span class="identifier">d2</span> <span class="special">=</span> <span class="identifier">pd2</span><span class="special">.</span><span class="identifier">get_date</span><span class="special">(</span><span class="number">2002</span><span class="special">)</span><span class="special">;</span> <span class="comment">//2002-Mar-10</span>
</pre>
<p> </p>
<div class="refsect2">
<a name="idp187225312"></a><h3>
<a name="boost.date_time.partial_dateconstruct-copy-destruct"></a><code class="computeroutput">partial_date</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><a name="idp100041360-bb"></a><span class="identifier">partial_date</span><span class="special">(</span><span class="identifier">day_type</span> d<span class="special">,</span> <span class="identifier">month_type</span> m<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout"><a name="idp70026288-bb"></a><span class="identifier">partial_date</span><span class="special">(</span><span class="identifier">duration_rep</span> days<span class="special">)</span><span class="special">;</span></pre>Partial date created from number of days into year. Range 1-366. <p>Allowable values range from 1 to 366. 1=Jan1, 366=Dec31. If argument exceeds range, <code class="computeroutput"><a class="link" href="partial_date.html" title="Class template partial_date">partial_date</a></code> will be created with closest in-range value. 60 will always be Feb29, if get_date() is called with a non-leap year an exception will be thrown </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp187239632"></a><h3>
<a name="idp38535616-bb"></a><code class="computeroutput">partial_date</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">date_type</span> <a name="idp49430736-bb"></a><span class="identifier">get_date</span><span class="special">(</span><span class="identifier">year_type</span> y<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Return a concrete date when provided with a year specific year. <p>Will throw an 'invalid_argument' exception if a <code class="computeroutput"><a class="link" href="partial_date.html" title="Class template partial_date">partial_date</a></code> object, instantiated with Feb-29, has get_date called with a non-leap year. Example: </p>
<pre class="programlisting"><span class="identifier">partial_date</span> <span class="identifier">pd</span><span class="special">(</span><span class="number">29</span><span class="special">,</span> <span class="identifier">Feb</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">pd</span><span class="special">.</span><span class="identifier">get_date</span><span class="special">(</span><span class="number">2003</span><span class="special">)</span><span class="special">;</span> <span class="comment">// throws invalid_argument exception</span>
<span class="identifier">pg</span><span class="special">.</span><span class="identifier">get_date</span><span class="special">(</span><span class="number">2000</span><span class="special">)</span><span class="special">;</span> <span class="comment">// returns 2000-2-29</span>
</pre>
<p> </p>
</li>
<li class="listitem"><pre class="literallayout"><span class="identifier">date_type</span> <a name="idp98252256-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">year_type</span> y<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp108313824-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="partial_date.html" title="Class template partial_date">partial_date</a> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp54980512-bb"></a><span class="keyword">operator</span><span class="special">&lt;</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="partial_date.html" title="Class template partial_date">partial_date</a> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">month_type</span> <a name="idp104116384-bb"></a><span class="identifier">month</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="identifier">day_type</span> <a name="idp98755968-bb"></a><span class="identifier">day</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">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp94464240-bb"></a><span class="identifier">to_string</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns string suitable for use in POSIX time zone string. <p>Returns string formatted with up to 3 digits: Jan-01 == "0" Feb-29 == "58" Dec-31 == "365" </p>
</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="year_based_generator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_generators_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="nth_kday_of_month.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>