doc/html/boost/date_time/period_formatter.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template period_formatter</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../date_time/doxy.html#header.boost.date_time.period_formatter_hpp" title="Header &lt;boost/date_time/period_formatter.hpp&gt;">
   9 <link rel="prev" href="period.html" title="Class template period">
  10 <link rel="next" href="period_parser.html" title="Class template period_parser">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="period.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.period_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="period_parser.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.date_time.period_formatter"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template period_formatter</span></h2>
  29 <p>boost::date_time::period_formatter &#8212; Not a facet, but a class used to specify and control period formats. </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="comment">// In header: &lt;<a class="link" href="../../date_time/doxy.html#header.boost.date_time.period_formatter_hpp" title="Header &lt;boost/date_time/period_formatter.hpp&gt;">boost/date_time/period_formatter.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span>
  35          <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>
  36 <span class="keyword">class</span> <a class="link" href="period_formatter.html" title="Class template period_formatter">period_formatter</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// types</span>
  39   <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.period_formatter.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">CharT</span>                                          <a name="boost.date_time.period_formatter.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>
  41   <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">char_type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">const_iterator</span> <a name="boost.date_time.period_formatter.const_itr_type"></a><span class="identifier">const_itr_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">&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.period_formatter.collection_type"></a><span class="identifier">collection_type</span><span class="special">;</span>
  43
  44   <span class="keyword">enum</span> <a name="boost.date_time.period_formatter.range_display_options"></a>range_display_options <span class="special">{</span> AS_OPEN_RANGE, AS_CLOSED_RANGE <span class="special">}</span><span class="special">;</span>
  45
  46   <span class="comment">// <a class="link" href="period_formatter.html#boost.date_time.period_formatterconstruct-copy-destruct">construct/copy/destruct</a></span>
  47   <a class="link" href="period_formatter.html#id680424-bb"><span class="identifier">period_formatter</span></a><span class="special">(</span><span class="identifier">range_display_options</span> <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</span><span class="special">,</span>
  48                    <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="identifier">default_period_separator</span><span class="special">,</span>
  49                    <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="identifier">default_period_start_delimeter</span><span class="special">,</span>
  50                    <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="identifier">default_period_open_range_end_delimeter</span><span class="special">,</span>
  51                    <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="identifier">default_period_closed_range_end_delimeter</span><span class="special">)</span><span class="special">;</span>
  52
  53   <span class="comment">// <a class="link" href="period_formatter.html#id362823-bb">public member functions</a></span>
  54   <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#id362826-bb"><span class="identifier">put_period_separator</span></a><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55   <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#id703065-bb"><span class="identifier">put_period_start_delimeter</span></a><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  56   <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#id377910-bb"><span class="identifier">put_period_end_delimeter</span></a><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  57   <span class="identifier">range_display_options</span> <a class="link" href="period_formatter.html#id368819-bb"><span class="identifier">range_option</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  58   <span class="keyword">void</span> <a class="link" href="period_formatter.html#id368826-bb"><span class="identifier">range_option</span></a><span class="special">(</span><span class="identifier">range_display_options</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59   <span class="keyword">void</span> <a class="link" href="period_formatter.html#id711013-bb"><span class="identifier">delimiter_strings</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span><span class="special">,</span>
  60                          <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  61   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> period_type<span class="special">,</span> <span class="keyword">typename</span> facet_type<span class="special">&gt;</span>
  62     <span class="identifier">OutItrT</span> <a class="link" href="period_formatter.html#id366154-bb"><span class="identifier">put_period</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>
  63                        <span class="keyword">const</span> <span class="identifier">period_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">facet_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  64
  65   <span class="comment">// public data members</span>
  66   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">default_period_separator</span><span class="special">;</span>
  67   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">default_period_start_delimeter</span><span class="special">;</span>
  68   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">default_period_open_range_end_delimeter</span><span class="special">;</span>
  69   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">default_period_closed_range_end_delimeter</span><span class="special">;</span>
  70 <span class="special">}</span><span class="special">;</span></pre></div>
  71 <div class="refsect1">
  72 <a name="id1435740"></a><h2>Description</h2>
  73 <p>Provides settings for the following:</p>
  74 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
  75 <li class="listitem"><p>period_separator -- default '/'</p></li>
  76 <li class="listitem"><p>period_open_start_delimeter -- default '['</p></li>
  77 <li class="listitem"><p>period_open_range_end_delimeter -- default ')'</p></li>
  78 <li class="listitem"><p>period_closed_range_end_delimeter -- default ']'</p></li>
  79 <li class="listitem"><p>display_as_open_range, display_as_closed_range -- default closed_range</p></li>
  80 </ul></div>
  81 <p>
  82 </p>
  83 <p>Thus the default formatting for a period is as follows: </p>
  84 <pre class="programlisting">  <span class="special">[</span><span class="identifier">period</span><span class="special">.</span><span class="identifier">start</span><span class="special">(</span><span class="special">)</span><span class="special">/</span><span class="identifier">period</span><span class="special">.</span><span class="identifier">last</span><span class="special">(</span><span class="special">)</span><span class="special">]</span>
  85    <span class="special">*</span>
  86 </pre>
  87 <p> So for a typical date_period this would be </p>
  88 <pre class="programlisting">  <span class="special">[</span><span class="number">2004</span><span class="special">-</span><span class="identifier">Jan</span><span class="special">-</span><span class="number">04</span><span class="special">/</span><span class="number">2004</span><span class="special">-</span><span class="identifier">Feb</span><span class="special">-</span><span class="number">01</span><span class="special">]</span>
  89    <span class="special">*</span>
  90 </pre>
  91 <p> where the date formatting is controlled by the date facet </p>
  92 <div class="refsect2">
  93 <a name="id1435912"></a><h3>
  94 <a name="boost.date_time.period_formatterconstruct-copy-destruct"></a><code class="computeroutput">period_formatter</code>
  95         public
  96        construct/copy/destruct</h3>
  97 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  98 <pre class="literallayout"><a name="id680424-bb"></a><span class="identifier">period_formatter</span><span class="special">(</span><span class="identifier">range_display_options</span> range_option_in <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</span><span class="special">,</span>
  99                  <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_separator <span class="special">=</span> <span class="identifier">default_period_separator</span><span class="special">,</span>
 100                  <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_start_delimeter <span class="special">=</span> <span class="identifier">default_period_start_delimeter</span><span class="special">,</span>
 101                  <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_open_range_end_delimeter <span class="special">=</span> <span class="identifier">default_period_open_range_end_delimeter</span><span class="special">,</span>
 102                  <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_closed_range_end_delimeter <span class="special">=</span> <span class="identifier">default_period_closed_range_end_delimeter</span><span class="special">)</span><span class="special">;</span></pre>Constructor that sets up period formatter options -- default should suffice most cases. </li></ol></div>
 103 </div>
 104 <div class="refsect2">
 105 <a name="id1436130"></a><h3>
 106 <a name="id362823-bb"></a><code class="computeroutput">period_formatter</code> public member functions</h3>
 107 <div class="orderedlist"><ol class="orderedlist" type="1">
 108 <li class="listitem">
 109 <pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id362826-bb"></a><span class="identifier">put_period_separator</span><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&amp;</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Puts the characters between period elements into stream -- default is /. </li>
 110 <li class="listitem">
 111 <pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id703065-bb"></a><span class="identifier">put_period_start_delimeter</span><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&amp;</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Puts the period start characters into stream -- default is [. </li>
 112 <li class="listitem">
 113 <pre class="literallayout"><span class="identifier">OutItrT</span> <a name="id377910-bb"></a><span class="identifier">put_period_end_delimeter</span><span class="special">(</span><span class="identifier">OutItrT</span> <span class="special">&amp;</span> oitr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Puts the period end characters into stream as controled by open/closed range setting. </li>
 114 <li class="listitem"><pre class="literallayout"><span class="identifier">range_display_options</span> <a name="id368819-bb"></a><span class="identifier">range_option</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 115 <li class="listitem">
 116 <pre class="literallayout"><span class="keyword">void</span> <a name="id368826-bb"></a><span class="identifier">range_option</span><span class="special">(</span><span class="identifier">range_display_options</span> option<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Reset the range_option control. </li>
 117 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id711013-bb"></a><span class="identifier">delimiter_strings</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> separator<span class="special">,</span>
 118                        <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> start_delim<span class="special">,</span>
 119                        <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> open_end_delim<span class="special">,</span>
 120                        <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> closed_end_delim<span class="special">)</span><span class="special">;</span></pre></li>
 121 <li class="listitem">
 122 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> period_type<span class="special">,</span> <span class="keyword">typename</span> facet_type<span class="special">&gt;</span>
 123   <span class="identifier">OutItrT</span> <a name="id366154-bb"></a><span class="identifier">put_period</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> a_fill<span class="special">,</span>
 124                      <span class="keyword">const</span> <span class="identifier">period_type</span> <span class="special">&amp;</span> p<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">facet_type</span> <span class="special">&amp;</span> facet<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Generic code to output a period -- no matter the period type. <p>This generic code will output any period using a facet to to output the 'elements'. For example, in the case of a date_period the elements will be instances of a date which will be formatted according the to setup in the passed facet parameter.</p>
 125 <p>The steps for formatting a period are always the same:</p>
 126 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 127 <li class="listitem"><p>put the start delimiter</p></li>
 128 <li class="listitem"><p>put start element</p></li>
 129 <li class="listitem"><p>put the separator</p></li>
 130 <li class="listitem"><p>put either last or end element depending on range settings</p></li>
 131 <li class="listitem"><p>put end delimeter depending on range settings</p></li>
 132 </ul></div>
 133 <p>
 134 </p>
 135 <p>Thus for a typical date period the result might look like this: </p>
 136 <pre class="programlisting">    [March 01, 2004/June 07, 2004]   &lt;-- closed range
 137     [March 01, 2004/June 08, 2004)   &lt;-- open range
 138
 139      *
 140 </pre>
 141 <p> </p>
 142 </li>
 143 </ol></div>
 144 </div>
 145 </div>
 146 </div>
 147 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 148 <td align="left"></td>
 149 <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
 150     <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>
 151 </div></td>
 152 </tr></table>
 153 <hr>
 154 <div class="spirit-nav">
 155 <a accesskey="p" href="period.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.period_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="period_parser.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 156 </div>
 157 </body>
 158 </html>