Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/year_based_generator.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 17 years ago

added boost
File size: 5.2 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Class template year_based_generator</title>
5<link rel="stylesheet" href="boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7<link rel="start" href="index.html" title="The Boost C++ Libraries">
8<link rel="up" href="date_time/doxy.html#id2508942" title="Header &lt;boost/date_time/date_generators.hpp&gt;">
9<link rel="prev" href="date_generator_parser.html" title="Class template date_generator_parser">
10<link rel="next" href="partial_date.html" title="Class template partial_date">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
15<td align="center"><a href="../../index.htm">Home</a></td>
16<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../people/people.htm">People</a></td>
18<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="date_generator_parser.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2508942"><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="partial_date.html"><img src="images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="year_based_generator"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class template year_based_generator</span></h2>
29<p>boost::date_time::year_based_generator &#8212; Base class for all generators that take a year and produce a date. </p>
30</div>
31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> date_type&gt; 
33<span class="bold"><strong>class</strong></span> year_based_generator {
34<span class="bold"><strong>public</strong></span>:
35  <span class="emphasis"><em>// types</em></span>
36  <span class="bold"><strong>typedef</strong></span> date_type::calendar_type calendar_type;
37  <span class="bold"><strong>typedef</strong></span> calendar_type::year_type year_type;    
38
39  <span class="emphasis"><em>// <a href="year_based_generator.html#year_based_generatorconstruct-copy-destruct">construct/copy/destruct</a></em></span>
40  <a href="year_based_generator.html#id2457082-bb">year_based_generator</a>();
41  <a href="year_based_generator.html#id2457085-bb">~year_based_generator</a>();
42
43  <span class="emphasis"><em>// <a href="year_based_generator.html#id2387990-bb">public member functions</a></em></span>
44  <span class="type"><span class="bold"><strong>virtual</strong></span> date_type</span> <a href="year_based_generator.html#id2387995-bb">get_date</a>(year_type) <span class="bold"><strong>const</strong></span>;
45  <span class="type"><span class="bold"><strong>virtual</strong></span> std::string</span> <a href="year_based_generator.html#id2417872-bb">to_string</a>() <span class="bold"><strong>const</strong></span>;
46};</pre></div>
47<div class="refsect1" lang="en">
48<a name="id2624158"></a><h2>Description</h2>
49<p>This class is a base class for polymorphic function objects that take a year and produce a concrete date.
50</p>
51<div class="refsect2" lang="en">
52<a name="id2624165"></a><h3>
53<a name="year_based_generatorconstruct-copy-destruct"></a><code class="computeroutput">year_based_generator</code> construct/copy/destruct</h3>
54<div class="orderedlist"><ol type="1">
55<li><pre class="literallayout"><a name="id2457082-bb"></a>year_based_generator();</pre></li>
56<li><pre class="literallayout"><a name="id2457085-bb"></a>~year_based_generator();</pre></li>
57</ol></div>
58</div>
59<div class="refsect2" lang="en">
60<a name="id2624214"></a><h3>
61<a name="id2387990-bb"></a><code class="computeroutput">year_based_generator</code> public member functions</h3>
62<div class="orderedlist"><ol type="1">
63<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> date_type</span> <a name="id2387995-bb"></a>get_date(year_type y) <span class="bold"><strong>const</strong></span>;</pre></li>
64<li><pre class="literallayout"><span class="type"><span class="bold"><strong>virtual</strong></span> std::string</span> <a name="id2417872-bb"></a>to_string() <span class="bold"><strong>const</strong></span>;</pre></li>
65</ol></div>
66</div>
67</div>
68</div>
69<table width="100%"><tr>
70<td align="left"></td>
71<td align="right"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
72</tr></table>
73<hr>
74<div class="spirit-nav">
75<a accesskey="p" href="date_generator_parser.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2508942"><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="partial_date.html"><img src="images/next.png" alt="Next"></a>
76</div>
77</body>
78</html>
Note: See TracBrowser for help on using the repository browser.