Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/special_values_formatter.html @ 25

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

added boost
File size: 7.0 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Class template special_values_formatter</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#id2502812" title="Header &lt;boost/date_time/special_values_formatter.hpp&gt;">
9<link rel="prev" href="period_parser.html" title="Class template period_parser">
10<link rel="next" href="special_values_parser.html" title="Class template special_values_parser">
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="period_parser.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2502812"><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="special_values_parser.html"><img src="images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="special_values_formatter"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class template special_values_formatter</span></h2>
29<p>boost::date_time::special_values_formatter &#8212; Class that provides generic formmatting ostream formatting for special values. </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> CharT,
33         <span class="bold"><strong>typename</strong></span> OutItrT = std::ostreambuf_iterator&lt;CharT, std::char_traits&lt;CharT&gt; &gt; &gt; 
34<span class="bold"><strong>class</strong></span> special_values_formatter {
35<span class="bold"><strong>public</strong></span>:
36  <span class="emphasis"><em>// types</em></span>
37  <span class="bold"><strong>typedef</strong></span> std::basic_string&lt; CharT &gt; string_type;    
38  <span class="bold"><strong>typedef</strong></span> CharT                      char_type;      
39  <span class="bold"><strong>typedef</strong></span> std::vector&lt; string_type &gt; collection_type;
40
41  <span class="emphasis"><em>// <a href="special_values_formatter.html#special_values_formatterconstruct-copy-destruct">construct/copy/destruct</a></em></span>
42  <a href="special_values_formatter.html#id2461525-bb">special_values_formatter</a>();
43  <a href="special_values_formatter.html#id2461542-bb">special_values_formatter</a>(<span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span> *, <span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span> *);
44  <a href="special_values_formatter.html#id2421129-bb">special_values_formatter</a>(<span class="bold"><strong>typename</strong></span> collection_type::iterator,
45                           <span class="bold"><strong>typename</strong></span> collection_type::iterator);
46
47  <span class="emphasis"><em>// <a href="special_values_formatter.html#id2399261-bb">public member functions</a></em></span>
48  <span class="type">OutItrT</span> <a href="special_values_formatter.html#id2399265-bb">put_special</a>(OutItrT, <span class="bold"><strong>const</strong></span> boost::date_time::special_values &amp;) <span class="bold"><strong>const</strong></span>;
49
50  <span class="bold"><strong>static</strong></span> const char_type default_special_value_names;
51};</pre></div>
52<div class="refsect1" lang="en">
53<a name="id2649205"></a><h2>Description</h2>
54<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>
55<p>While not a facet, this class is used by the date and time facets for formatting special value types. </p>
56<div class="refsect2" lang="en">
57<a name="id2649218"></a><h3>
58<a name="special_values_formatterconstruct-copy-destruct"></a><code class="computeroutput">special_values_formatter</code> construct/copy/destruct</h3>
59<div class="orderedlist"><ol type="1">
60<li>
61<pre class="literallayout"><a name="id2461525-bb"></a>special_values_formatter();</pre>
62<p>Default strings are not-a-date-time -infinity +infinity </p>
63</li>
64<li>
65<pre class="literallayout"><a name="id2461542-bb"></a>special_values_formatter(<span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span> * begin,
66                         <span class="bold"><strong>const</strong></span> char_type *<span class="bold"><strong>const</strong></span> * end);</pre>
67<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>
68<pre class="programlisting">  const char* const special_value_names[]={"nadt","-inf","+inf" };
69
70  special_value_formatter svf(&amp;special_value_names[0], &amp;special_value_names[3]);
71     *
72</pre>
73</li>
74<li><pre class="literallayout"><a name="id2421129-bb"></a>special_values_formatter(<span class="bold"><strong>typename</strong></span> collection_type::iterator beg,
75                         <span class="bold"><strong>typename</strong></span> collection_type::iterator end);</pre></li>
76</ol></div>
77</div>
78<div class="refsect2" lang="en">
79<a name="id2649337"></a><h3>
80<a name="id2399261-bb"></a><code class="computeroutput">special_values_formatter</code> public member functions</h3>
81<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><span class="type">OutItrT</span> <a name="id2399265-bb"></a>put_special(OutItrT next,
82                    <span class="bold"><strong>const</strong></span> boost::date_time::special_values &amp; value) <span class="bold"><strong>const</strong></span>;</pre></li></ol></div>
83</div>
84</div>
85</div>
86<table width="100%"><tr>
87<td align="left"></td>
88<td align="right"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
89</tr></table>
90<hr>
91<div class="spirit-nav">
92<a accesskey="p" href="period_parser.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2502812"><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="special_values_parser.html"><img src="images/next.png" alt="Next"></a>
93</div>
94</body>
95</html>
Note: See TracBrowser for help on using the repository browser.