1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class template special_values_formatter</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../date_time/doxy.html#header.boost.date_time.special_values_formatter_hpp" title="Header <boost/date_time/special_values_formatter.hpp>"> 10<link rel="prev" href="period_parser.html" title="Class template period_parser"> 11<link rel="next" href="special_values_parser.html" title="Class template special_values_parser"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="period_parser.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.special_values_formatter_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="special_values_parser.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.date_time.special_values_formatter"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template special_values_formatter</span></h2> 30<p>boost::date_time::special_values_formatter — Class that provides generic formmatting ostream formatting for special values. </p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../date_time/doxy.html#header.boost.date_time.special_values_formatter_hpp" title="Header <boost/date_time/special_values_formatter.hpp>">boost/date_time/special_values_formatter.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> 36 <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"><</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"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> <span class="special">></span> 37<span class="keyword">class</span> <a class="link" href="special_values_formatter.html" title="Class template special_values_formatter">special_values_formatter</a> <span class="special">{</span> 38<span class="keyword">public</span><span class="special">:</span> 39 <span class="comment">// types</span> 40 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">></span> <a name="boost.date_time.special_values_formatter.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <span class="identifier">CharT</span> <a name="boost.date_time.special_values_formatter.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> 42 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">string_type</span> <span class="special">></span> <a name="boost.date_time.special_values_formatter.collection_type"></a><span class="identifier">collection_type</span><span class="special">;</span> 43 44 <span class="comment">// <a class="link" href="special_values_formatter.html#boost.date_time.special_values_formatterconstruct-copy-destruct">construct/copy/destruct</a></span> 45 <a class="link" href="special_values_formatter.html#id-1_3_14_15_3_40_1_1_1_9-bb"><span class="identifier">special_values_formatter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 46 <a class="link" href="special_values_formatter.html#id-1_3_14_15_3_40_1_1_1_10-bb"><span class="identifier">special_values_formatter</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">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="special">;</span> 47 <a class="link" href="special_values_formatter.html#id-1_3_14_15_3_40_1_1_1_11-bb"><span class="identifier">special_values_formatter</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">collection_type</span><span class="special">::</span><span class="identifier">iterator</span><span class="special">,</span> 48 <span class="keyword">typename</span> <span class="identifier">collection_type</span><span class="special">::</span><span class="identifier">iterator</span><span class="special">)</span><span class="special">;</span> 49 50 <span class="comment">// <a class="link" href="special_values_formatter.html#id-1_3_14_15_3_40_1_1_1_8-bb">public member functions</a></span> 51 <span class="identifier">OutItrT</span> <a class="link" href="special_values_formatter.html#id-1_3_14_15_3_40_1_1_1_8_1-bb"><span class="identifier">put_special</span></a><span class="special">(</span><span class="identifier">OutItrT</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="special">)</span> <span class="keyword">const</span><span class="special">;</span> 52 53 <span class="comment">// public data members</span> 54 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">default_special_value_names</span><span class="special">;</span> <span class="comment">// Storage for the strings used to indicate special values. </span> 55<span class="special">}</span><span class="special">;</span></pre></div> 56<div class="refsect1"> 57<a name="id-1.3.14.15.3.39.3.4"></a><h2>Description</h2> 58<p>This class provides for the formmating of special values to an output stream. In particular, it produces strings for the values of negative and positive infinity as well as not_a_date_time.</p> 59<p>While not a facet, this class is used by the date and time facets for formatting special value types. </p> 60<div class="refsect2"> 61<a name="id-1.3.14.15.3.39.3.4.4"></a><h3> 62<a name="boost.date_time.special_values_formatterconstruct-copy-destruct"></a><code class="computeroutput">special_values_formatter</code> 63 public 64 construct/copy/destruct</h3> 65<div class="orderedlist"><ol class="orderedlist" type="1"> 66<li class="listitem"> 67<pre class="literallayout"><a name="id-1_3_14_15_3_40_1_1_1_9-bb"></a><span class="identifier">special_values_formatter</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Construct special values formatter using default strings. <p>Default strings are not-a-date-time -infinity +infinity </p> 68</li> 69<li class="listitem"> 70<pre class="literallayout"><a name="id-1_3_14_15_3_40_1_1_1_10-bb"></a><span class="identifier">special_values_formatter</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> <span class="special">*</span> begin<span class="special">,</span> 71 <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">*</span> end<span class="special">)</span><span class="special">;</span></pre>Construct special values formatter from array of strings. <p>This constructor will take pair of iterators from an array of strings that represent the special values and copy them for use in formatting special values. </p> 72<pre class="programlisting"><span class="keyword">const</span> <span class="keyword">char</span><span class="special">*</span> <span class="keyword">const</span> <span class="identifier">special_value_names</span><span class="special">[</span><span class="special">]</span><span class="special">=</span><span class="special">{</span><span class="string">"nadt"</span><span class="special">,</span><span class="string">"-inf"</span><span class="special">,</span><span class="string">"+inf"</span> <span class="special">}</span><span class="special">;</span> 73 74<span class="identifier">special_value_formatter</span> <span class="identifier">svf</span><span class="special">(</span><span class="special">&</span><span class="identifier">special_value_names</span><span class="special">[</span><span class="number">0</span><span class="special">]</span><span class="special">,</span> <span class="special">&</span><span class="identifier">special_value_names</span><span class="special">[</span><span class="number">3</span><span class="special">]</span><span class="special">)</span><span class="special">;</span> 75</pre> 76<p> </p> 77</li> 78<li class="listitem"><pre class="literallayout"><a name="id-1_3_14_15_3_40_1_1_1_11-bb"></a><span class="identifier">special_values_formatter</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">collection_type</span><span class="special">::</span><span class="identifier">iterator</span> beg<span class="special">,</span> 79 <span class="keyword">typename</span> <span class="identifier">collection_type</span><span class="special">::</span><span class="identifier">iterator</span> end<span class="special">)</span><span class="special">;</span></pre></li> 80</ol></div> 81</div> 82<div class="refsect2"> 83<a name="id-1.3.14.15.3.39.3.4.5"></a><h3> 84<a name="id-1_3_14_15_3_40_1_1_1_8-bb"></a><code class="computeroutput">special_values_formatter</code> public member functions</h3> 85<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id-1_3_14_15_3_40_1_1_1_8_1-bb"></a><span class="identifier">put_special</span><span class="special">(</span><span class="identifier">OutItrT</span> next<span class="special">,</span> 86 <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> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> 87</div> 88</div> 89</div> 90<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 91<td align="left"></td> 92<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 93 <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> 94</div></td> 95</tr></table> 96<hr> 97<div class="spirit-nav"> 98<a accesskey="p" href="period_parser.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.special_values_formatter_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="special_values_parser.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 99</div> 100</body> 101</html> 102
