<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template date_names_put</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.date_names_put_hpp" title="Header <boost/date_time/date_names_put.hpp>">
<link rel="prev" href="date_itr.html" title="Class template date_itr">
<link rel="next" href="all_date_names_put.html" title="Class template all_date_names_put">
</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="date_itr.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_names_put_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="all_date_names_put.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class template date_names_put">
<a name="boost.date_time.date_names_put"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template date_names_put</span></h2>
<p>boost::date_time::date_names_put — Output facet base class for gregorian dates. </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.date_names_put_hpp" title="Header <boost/date_time/date_names_put.hpp>">boost/date_time/date_names_put.hpp</a>>
</em></span><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> Config, <span class="bold"><strong>typename</strong></span> charT = <span class="bold"><strong>char</strong></span>,
<span class="bold"><strong>typename</strong></span> <a class="link" href="../../OutputIterator.html" title="Concept OutputIterator">OutputIterator</a> = std::ostreambuf_iterator<charT> >
<span class="bold"><strong>class</strong></span> <a class="link" href="date_names_put.html" title="Class template date_names_put">date_names_put</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// types</em></span>
<span class="bold"><strong>typedef</strong></span> OutputIterator <a name="boost.date_time.date_names_put.iter_type"></a>iter_type;
<span class="bold"><strong>typedef</strong></span> Config::month_type <a name="boost.date_time.date_names_put.month_type"></a>month_type;
<span class="bold"><strong>typedef</strong></span> Config::month_enum <a name="boost.date_time.date_names_put.month_enum"></a>month_enum;
<span class="bold"><strong>typedef</strong></span> Config::weekday_enum <a name="boost.date_time.date_names_put.weekday_enum"></a>weekday_enum;
<span class="bold"><strong>typedef</strong></span> Config::special_value_enum <a name="boost.date_time.date_names_put.special_value_enum"></a>special_value_enum;
<span class="bold"><strong>typedef</strong></span> std::basic_string< charT > <a name="boost.date_time.date_names_put.string_type"></a>string_type;
<span class="bold"><strong>typedef</strong></span> charT <a name="boost.date_time.date_names_put.char_type"></a>char_type;
<span class="emphasis"><em>// <a class="link" href="date_names_put.html#boost.date_time.date_names_putconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="date_names_put.html#id351774-bb">date_names_put</a>();
<span class="emphasis"><em>// <a class="link" href="date_names_put.html#id391870-bb">public member functions</a></em></span>
<span class="type">std::locale::id &</span> <a class="link" href="date_names_put.html#id391874-bb">__get_id</a>(<span class="bold"><strong>void</strong></span>) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id391887-bb">put_special_value</a>(iter_type &, special_value_enum) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id392096-bb">put_month_short</a>(iter_type &, month_enum) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id316199-bb">put_month_long</a>(iter_type &, month_enum) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id316218-bb">put_weekday_short</a>(iter_type &, weekday_enum) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id407728-bb">put_weekday_long</a>(iter_type &, weekday_enum) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="date_names_put.html#id407747-bb">has_date_sep_chars</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id407755-bb">year_sep_char</a>(iter_type &) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id422921-bb">month_sep_char</a>(iter_type &) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id422937-bb">day_sep_char</a>(iter_type &) <span class="bold"><strong>const</strong></span>;
<span class="type">ymd_order_spec</span> <a class="link" href="date_names_put.html#id603995-bb">date_order</a>() <span class="bold"><strong>const</strong></span>;
<span class="type">month_format_spec</span> <a class="link" href="date_names_put.html#id604005-bb">month_format</a>() <span class="bold"><strong>const</strong></span>;
<span class="emphasis"><em>// <a class="link" href="date_names_put.html#id351775-bb">protected member functions</a></em></span>
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id351778-bb">do_put_month_short</a>(iter_type &, month_enum) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id324572-bb">do_put_month_long</a>(iter_type &, month_enum) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id378294-bb">do_put_special_value</a>(iter_type &, special_value_enum) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id398832-bb">do_put_weekday_short</a>(iter_type &, weekday_enum) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id370583-bb">do_put_weekday_long</a>(iter_type &, weekday_enum) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="date_names_put.html#id351516-bb">do_has_date_sep_chars</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id351524-bb">do_year_sep_char</a>(iter_type &) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id365265-bb">do_month_sep_char</a>(iter_type &) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id397237-bb">do_day_sep_char</a>(iter_type &) <span class="bold"><strong>const</strong></span>;
<span class="type">ymd_order_spec</span> <a class="link" href="date_names_put.html#id336512-bb">do_date_order</a>() <span class="bold"><strong>const</strong></span>;
<span class="type">month_format_spec</span> <a class="link" href="date_names_put.html#id336523-bb">do_month_format</a>() <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id336533-bb">put_string</a>(iter_type &, <span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> ) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_names_put.html#id324569-bb">put_string</a>(iter_type &, <span class="bold"><strong>const</strong></span> string_type &) <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> default_special_value_names;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> separator;
<span class="bold"><strong>static</strong></span> <span class="type">std::locale::id</span> id; <span class="emphasis"><em>// Generate storage location for a std::locale::id. </em></span>
};</pre></div>
<div class="refsect1" title="Description">
<a name="id791086"></a><h2>Description</h2>
<p>This class is a base class for date facets used to localize the names of months and the names of days in the week.</p>
<p>Requirements of Config</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>define an enumeration month_enum that enumerates the months. The enumeration should be '1' based eg: Jan==1</p></li>
<li class="listitem"><p>define as_short_string and as_long_string</p></li>
</ul></div>
<p>
</p>
<p>(see langer & kreft p334). </p>
<div class="refsect2" title="date_names_put public construct/copy/destruct">
<a name="id791112"></a><h3>
<a name="boost.date_time.date_names_putconstruct-copy-destruct"></a><code class="computeroutput">date_names_put</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id351774-bb"></a>date_names_put();</pre></li></ol></div>
</div>
<div class="refsect2" title="date_names_put public member functions">
<a name="id791145"></a><h3>
<a name="id391870-bb"></a><code class="computeroutput">date_names_put</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="type">std::locale::id &</span> <a name="id391874-bb"></a>__get_id(<span class="bold"><strong>void</strong></span>) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id391887-bb"></a>put_special_value(iter_type & oitr, special_value_enum sv) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id392096-bb"></a>put_month_short(iter_type & oitr, month_enum moy) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id316199-bb"></a>put_month_long(iter_type & oitr, month_enum moy) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id316218-bb"></a>put_weekday_short(iter_type & oitr, weekday_enum wd) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id407728-bb"></a>put_weekday_long(iter_type & oitr, weekday_enum wd) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id407747-bb"></a>has_date_sep_chars() <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id407755-bb"></a>year_sep_char(iter_type & oitr) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id422921-bb"></a>month_sep_char(iter_type & oitr) <span class="bold"><strong>const</strong></span>;</pre>char between year-month </li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id422937-bb"></a>day_sep_char(iter_type & oitr) <span class="bold"><strong>const</strong></span>;</pre>Char to separate month-day. </li>
<li class="listitem">
<pre class="literallayout"><span class="type">ymd_order_spec</span> <a name="id603995-bb"></a>date_order() <span class="bold"><strong>const</strong></span>;</pre>Determines the order to put the date elements. </li>
<li class="listitem">
<pre class="literallayout"><span class="type">month_format_spec</span> <a name="id604005-bb"></a>month_format() <span class="bold"><strong>const</strong></span>;</pre>Determines if month is displayed as integer, short or long string. </li>
</ol></div>
</div>
<div class="refsect2" title="date_names_put protected member functions">
<a name="id791479"></a><h3>
<a name="id351775-bb"></a><code class="computeroutput">date_names_put</code> protected member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id351778-bb"></a>do_put_month_short(iter_type & oitr, month_enum moy) <span class="bold"><strong>const</strong></span>;</pre>Default facet implementation uses month_type defaults. </li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id324572-bb"></a>do_put_month_long(iter_type & oitr, month_enum moy) <span class="bold"><strong>const</strong></span>;</pre>Default facet implementation uses month_type defaults. </li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id378294-bb"></a>do_put_special_value(iter_type & oitr, special_value_enum sv) <span class="bold"><strong>const</strong></span>;</pre>Default facet implementation for special value types. </li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id398832-bb"></a>do_put_weekday_short(iter_type &, weekday_enum) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id370583-bb"></a>do_put_weekday_long(iter_type &, weekday_enum) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id351516-bb"></a>do_has_date_sep_chars() <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id351524-bb"></a>do_year_sep_char(iter_type & oitr) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id365265-bb"></a>do_month_sep_char(iter_type & oitr) <span class="bold"><strong>const</strong></span>;</pre>char between year-month </li>
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id397237-bb"></a>do_day_sep_char(iter_type & oitr) <span class="bold"><strong>const</strong></span>;</pre>Char to separate month-day. </li>
<li class="listitem">
<pre class="literallayout"><span class="type">ymd_order_spec</span> <a name="id336512-bb"></a>do_date_order() <span class="bold"><strong>const</strong></span>;</pre>Default for date order. </li>
<li class="listitem">
<pre class="literallayout"><span class="type">month_format_spec</span> <a name="id336523-bb"></a>do_month_format() <span class="bold"><strong>const</strong></span>;</pre>Default month format. </li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id336533-bb"></a>put_string(iter_type & oi, <span class="bold"><strong>const</strong></span> charT *<span class="bold"><strong>const</strong></span> s) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id324569-bb"></a>put_string(iter_type & oi, <span class="bold"><strong>const</strong></span> string_type & s1) <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"><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="date_itr.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_names_put_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="all_date_names_put.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
