Google Git
Sign in
nest-open-source / nest-learning-thermostat / 5.0 / boost / 317601cb979f96545d0e892ce7cfdf59f676ee0a / . / boost_1_45_0 / doc / html / boost / date_time / date_facet.html
blob: fa5ad183428bf093cf0e3e39020039180792fe07 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template date_facet</title>
<link rel="stylesheet" href="../../../../doc/src/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_facet_hpp" title="Header &lt;boost/date_time/date_facet.hpp&gt;">
<link rel="prev" href="years_duration.html" title="Class template years_duration">
<link rel="next" href="date_input_facet.html" title="Class template date_input_facet">
</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="years_duration.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_facet_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="date_input_facet.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.date_time.date_facet"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template date_facet</span></h2>
<p>boost::date_time::date_facet</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_facet_hpp" title="Header &lt;boost/date_time/date_facet.hpp&gt;">boost/date_time/date_facet.hpp</a>&gt;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> date_type<span class="special">,</span> <span class="keyword">typename</span> CharT<span class="special">,</span>
<span class="keyword">typename</span> OutItrT <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostreambuf_iterator</span><span class="special">&lt;</span><span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special">&lt;</span><span class="identifier">CharT</span><span class="special">&gt;</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
<span class="keyword">class</span> <a class="link" href="date_facet.html" title="Class template date_facet">date_facet</a> <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">duration_type</span> <a name="boost.date_time.date_facet.duration_type"></a><span class="identifier">duration_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">date_type</span><span class="special">::</span><span class="identifier">day_of_week_type</span> <a name="boost.date_time.date_facet.day_of_week_type"></a><span class="identifier">day_of_week_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">date_type</span><span class="special">::</span><span class="identifier">day_type</span> <a name="boost.date_time.date_facet.day_type"></a><span class="identifier">day_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">date_type</span><span class="special">::</span><span class="identifier">month_type</span> <a name="boost.date_time.date_facet.month_type"></a><span class="identifier">month_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="period.html" title="Class template period">boost::date_time::period</a><span class="special">&lt;</span> <span class="identifier">date_type</span><span class="special">,</span> <span class="identifier">duration_type</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.period_type"></a><span class="identifier">period_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">CharT</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">CharT</span> <a name="boost.date_time.date_facet.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="period_formatter.html" title="Class template period_formatter">boost::date_time::period_formatter</a><span class="special">&lt;</span> <span class="identifier">CharT</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.period_formatter_type"></a><span class="identifier">period_formatter_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="special_values_formatter.html" title="Class template special_values_formatter">boost::date_time::special_values_formatter</a><span class="special">&lt;</span> <span class="identifier">CharT</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.special_values_formatte_id409864"></a><span class="identifier">special_values_formatter_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">CharT</span> <span class="special">&gt;</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.input_collection_type"></a><span class="identifier">input_collection_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="date_generator_formatter.html" title="Class template date_generator_formatter">date_generator_formatter</a><span class="special">&lt;</span> <span class="identifier">date_type</span><span class="special">,</span> <span class="identifier">CharT</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.date_gen_formatter_type"></a><span class="identifier">date_gen_formatter_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="partial_date.html" title="Class template partial_date">partial_date</a><span class="special">&lt;</span> <span class="identifier">date_type</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.partial_date_type"></a><span class="identifier">partial_date_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="nth_kday_of_month.html" title="Class template nth_kday_of_month">nth_kday_of_month</a><span class="special">&lt;</span> <span class="identifier">date_type</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.nth_kday_type"></a><span class="identifier">nth_kday_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="first_kday_of_month.html" title="Class template first_kday_of_month">first_kday_of_month</a><span class="special">&lt;</span> <span class="identifier">date_type</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.first_kday_type"></a><span class="identifier">first_kday_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="last_kday_of_month.html" title="Class template last_kday_of_month">last_kday_of_month</a><span class="special">&lt;</span> <span class="identifier">date_type</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.last_kday_type"></a><span class="identifier">last_kday_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="first_kday_after.html" title="Class template first_kday_after">first_kday_after</a><span class="special">&lt;</span> <span class="identifier">date_type</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.kday_after_type"></a><span class="identifier">kday_after_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <a class="link" href="first_kday_before.html" title="Class template first_kday_before">first_kday_before</a><span class="special">&lt;</span> <span class="identifier">date_type</span> <span class="special">&gt;</span> <a name="boost.date_time.date_facet.kday_before_type"></a><span class="identifier">kday_before_type</span><span class="special">;</span>
<span class="comment">// <a class="link" href="date_facet.html#boost.date_time.date_facetconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="date_facet.html#id380392-bb"><span class="identifier">date_facet</span></a><span class="special">(</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="date_facet.html#id326050-bb"><span class="identifier">date_facet</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="special">::</span><span class="identifier">size_t</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="date_facet.html#id414109-bb"><span class="identifier">date_facet</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="special">,</span>
<a class="link" href="date_facet.html#boost.date_time.date_facet.period_formatter_type">period_formatter_type</a> <span class="special">=</span> <span class="identifier">period_formatter_type</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
<a class="link" href="date_facet.html#boost.date_time.date_facet.special_values_formatte_id409864">special_values_formatter_type</a> <span class="special">=</span> <span class="identifier">special_values_formatter_type</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
<a class="link" href="date_facet.html#boost.date_time.date_facet.date_gen_formatter_type">date_gen_formatter_type</a> <span class="special">=</span> <span class="identifier">date_gen_formatter_type</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
<span class="special">::</span><span class="identifier">size_t</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="date_facet.html#id584167-bb">public member functions</a></span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">::</span><span class="identifier">id</span> <span class="special">&amp;</span> <a class="link" href="date_facet.html#id584170-bb"><span class="identifier">__get_id</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id584184-bb"><span class="identifier">format</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id584197-bb"><span class="identifier">set_iso_format</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id584205-bb"><span class="identifier">set_iso_extended_format</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id584213-bb"><span class="identifier">month_format</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id584227-bb"><span class="identifier">weekday_format</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id395895-bb"><span class="identifier">period_formatter</span></a><span class="special">(</span><a class="link" href="date_facet.html#boost.date_time.date_facet.period_formatter_type">period_formatter_type</a><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id385197-bb"><span class="identifier">special_values_formatter</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.special_values_formatte_id409864">special_values_formatter_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id462054-bb"><span class="identifier">short_weekday_names</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id462068-bb"><span class="identifier">long_weekday_names</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id588166-bb"><span class="identifier">short_month_names</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id588180-bb"><span class="identifier">long_month_names</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="date_facet.html#id340041-bb"><span class="identifier">date_gen_phrase_strings</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span><span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">date_gen_formatter_type</span><span class="special">::</span><span class="identifier">phrase_elements</span> <span class="special">=</span> <span class="identifier">date_gen_formatter_type</span><span class="special">::</span><span class="identifier">first</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id340064-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id471323-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">duration_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id384165-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">month_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id329132-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">day_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id391540-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">day_of_week_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id391382-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.period_type">period_type</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id371821-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.partial_date_type">partial_date_type</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id386962-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.nth_kday_type">nth_kday_type</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id585368-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.first_kday_type">first_kday_type</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id342342-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.last_kday_type">last_kday_type</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id331016-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.kday_before_type">kday_before_type</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id356857-bb"><span class="identifier">put</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.kday_after_type">kday_after_type</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="comment">// <a class="link" href="date_facet.html#id588069-bb">protected member functions</a></span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id358499-bb"><span class="identifier">do_put_special</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">special_values</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">OutItrT</span> <a class="link" href="date_facet.html#id383625-bb"><span class="identifier">do_put_tm</span></a><span class="special">(</span><span class="identifier">OutItrT</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">tm</span> <span class="special">&amp;</span><span class="special">,</span>
<span class="identifier">string_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> long_weekday_format<span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> short_weekday_format<span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> long_month_format<span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> short_month_format<span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> default_period_separator<span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> standard_format_specifier<span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> iso_format_specifier<span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> iso_format_extended_specifier<span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> default_date_format<span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">::</span><span class="identifier">id</span> id<span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id1076530"></a><h2>Description</h2>
<p>Class that provides format based I/O facet for date types.</p>
<p>This class allows the formatting of dates by using format string. Format strings are:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>A =&gt; long_weekday_format - Full name Ex: Tuesday</p></li>
<li class="listitem"><p>a =&gt; short_weekday_format - Three letter abbreviation Ex: Tue</p></li>
<li class="listitem"><p>B =&gt; long_month_format - Full name Ex: October</p></li>
<li class="listitem"><p>b =&gt; short_month_format - Three letter abbreviation Ex: Oct</p></li>
<li class="listitem"><p>x =&gt; standard_format_specifier - defined by the locale</p></li>
<li class="listitem"><p>Y-b-d =&gt; default_date_format - YYYY-Mon-dd</p></li>
</ul></div>
<p>
</p>
<p>Default month format == b Default weekday format == a </p>
<div class="refsect2">
<a name="id1076580"></a><h3>
<a name="boost.date_time.date_facetconstruct-copy-destruct"></a><code class="computeroutput">date_facet</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><a name="id380392-bb"></a><span class="identifier">date_facet</span><span class="special">(</span><span class="special">::</span><span class="identifier">size_t</span> a_ref <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a name="id326050-bb"></a><span class="identifier">date_facet</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> format_str<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span> short_names<span class="special">,</span> <span class="special">::</span><span class="identifier">size_t</span> ref_count <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a name="id414109-bb"></a><span class="identifier">date_facet</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> format_str<span class="special">,</span>
<a class="link" href="date_facet.html#boost.date_time.date_facet.period_formatter_type">period_formatter_type</a> per_formatter <span class="special">=</span> <span class="identifier">period_formatter_type</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
<a class="link" href="date_facet.html#boost.date_time.date_facet.special_values_formatte_id409864">special_values_formatter_type</a> sv_formatter <span class="special">=</span> <span class="identifier">special_values_formatter_type</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
<a class="link" href="date_facet.html#boost.date_time.date_facet.date_gen_formatter_type">date_gen_formatter_type</a> dg_formatter <span class="special">=</span> <span class="identifier">date_gen_formatter_type</span><span class="special">(</span><span class="special">)</span><span class="special">,</span>
<span class="special">::</span><span class="identifier">size_t</span> ref_count <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="id1076910"></a><h3>
<a name="id584167-bb"></a><code class="computeroutput">date_facet</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span><span class="special">::</span><span class="identifier">id</span> <span class="special">&amp;</span> <a name="id584170-bb"></a><span class="identifier">__get_id</span><span class="special">(</span><span class="keyword">void</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">void</span> <a name="id584184-bb"></a><span class="identifier">format</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> format_str<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id584197-bb"></a><span class="identifier">set_iso_format</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id584205-bb"></a><span class="identifier">set_iso_extended_format</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id584213-bb"></a><span class="identifier">month_format</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> format_str<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id584227-bb"></a><span class="identifier">weekday_format</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> format_str<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id395895-bb"></a><span class="identifier">period_formatter</span><span class="special">(</span><a class="link" href="date_facet.html#boost.date_time.date_facet.period_formatter_type">period_formatter_type</a> per_formatter<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id385197-bb"></a><span class="identifier">special_values_formatter</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.special_values_formatte_id409864">special_values_formatter_type</a> <span class="special">&amp;</span> svf<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id462054-bb"></a><span class="identifier">short_weekday_names</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span> short_names<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id462068-bb"></a><span class="identifier">long_weekday_names</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span> long_names<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id588166-bb"></a><span class="identifier">short_month_names</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span> short_names<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id588180-bb"></a><span class="identifier">long_month_names</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span> long_names<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id340041-bb"></a><span class="identifier">date_gen_phrase_strings</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">input_collection_type</span> <span class="special">&amp;</span> new_strings<span class="special">,</span>
<span class="keyword">typename</span> <span class="identifier">date_gen_formatter_type</span><span class="special">::</span><span class="identifier">phrase_elements</span> beg_pos <span class="special">=</span> <span class="identifier">date_gen_formatter_type</span><span class="special">::</span><span class="identifier">first</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id340064-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> d<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id471323-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">duration_type</span> <span class="special">&amp;</span> dd<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id384165-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">month_type</span> <span class="special">&amp;</span> m<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id329132-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">day_type</span> <span class="special">&amp;</span> day<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>puts the day of month </li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id391540-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">day_of_week_type</span> <span class="special">&amp;</span> dow<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id391382-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.period_type">period_type</a> <span class="special">&amp;</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id371821-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.partial_date_type">partial_date_type</a> <span class="special">&amp;</span> pd<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id386962-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.nth_kday_type">nth_kday_type</a> <span class="special">&amp;</span> nkd<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id585368-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.first_kday_type">first_kday_type</a> <span class="special">&amp;</span> fkd<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id342342-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.last_kday_type">last_kday_type</a> <span class="special">&amp;</span> lkd<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id331016-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.kday_before_type">kday_before_type</a> <span class="special">&amp;</span> fkb<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id356857-bb"></a><span class="identifier">put</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <a class="link" href="date_facet.html#boost.date_time.date_facet.kday_after_type">kday_after_type</a> <span class="special">&amp;</span> fka<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="id1078913"></a><h3>
<a name="id588069-bb"></a><code class="computeroutput">date_facet</code> protected member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id358499-bb"></a><span class="identifier">do_put_special</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">special_values</span> sv<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id383625-bb"></a><span class="identifier">do_put_tm</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&amp;</span> a_ios<span class="special">,</span> <span class="identifier">char_type</span> fill_char<span class="special">,</span>
<span class="keyword">const</span> <span class="identifier">tm</span> <span class="special">&amp;</span> tm_value<span class="special">,</span> <span class="identifier">string_type</span> a_format<span class="special">)</span> <span class="keyword">const</span><span class="special">;</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 &#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="years_duration.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_facet_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="date_input_facet.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>