doc/html/boost/date_time/special_values_parser.html

   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=US-ASCII">
   5 <title>Class template special_values_parser</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_parser_hpp" title="Header &lt;boost/date_time/special_values_parser.hpp&gt;">
  10 <link rel="prev" href="special_values_formatter.html" title="Class template special_values_formatter">
  11 <link rel="next" href="convert_string_type.html" title="Function template convert_string_type">
  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="special_values_formatter.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_parser_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="convert_string_type.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_parser"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template special_values_parser</span></h2>
  30 <p>boost::date_time::special_values_parser &#8212; Class for special_value parsing. </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: &lt;<a class="link" href="../../date_time/doxy.html#header.boost.date_time.special_values_parser_hpp" title="Header &lt;boost/date_time/special_values_parser.hpp&gt;">boost/date_time/special_values_parser.hpp</a>&gt;
  34
  35 </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">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="special_values_parser.html" title="Class template special_values_parser">special_values_parser</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.special_values_parser.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">istreambuf_iterator</span><span class="special">&lt;</span> <span class="identifier">charT</span> <span class="special">&gt;</span>         <a name="boost.date_time.special_values_parser.stream_itr_type"></a><span class="identifier">stream_itr_type</span><span class="special">;</span>
  41   <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.special_values_parser.duration_type"></a><span class="identifier">duration_type</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <a class="link" href="string_parse_tree.html" title="Struct template string_parse_tree">string_parse_tree</a><span class="special">&lt;</span> <span class="identifier">charT</span> <span class="special">&gt;</span>                <a name="boost.date_time.special_values_parser.parse_tree_type"></a><span class="identifier">parse_tree_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> parse_tree_type::parse_match_result_type  <a name="boost.date_time.special_values_parser.match_results"></a><span class="identifier">match_results</span><span class="special">;</span>
  44   <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.special_values_parser.collection_type"></a><span class="identifier">collection_type</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="identifier">charT</span>                                     <a name="boost.date_time.special_values_parser.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>
  46
  47   <span class="comment">// <a class="link" href="special_values_parser.html#boost.date_time.special_values_parserconstruct-copy-destruct">construct/copy/destruct</a></span>
  48   <a class="link" href="special_values_parser.html#idp496878672-bb"><span class="identifier">special_values_parser</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  49   <a class="link" href="special_values_parser.html#idp496880000-bb"><span class="identifier">special_values_parser</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>
  50                         <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>
  51                         <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  52   <a class="link" href="special_values_parser.html#idp496884784-bb"><span class="identifier">special_values_parser</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>
  53                         <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>
  54   <a class="link" href="special_values_parser.html#idp496886480-bb"><span class="identifier">special_values_parser</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="special_values_parser.html" title="Class template special_values_parser">special_values_parser</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> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  55
  56   <span class="comment">// <a class="link" href="special_values_parser.html#idp496869536-bb">public member functions</a></span>
  57   <span class="keyword">void</span> <a class="link" href="special_values_parser.html#idp496870096-bb"><span class="identifier">sv_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>
  58                   <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>
  59                   <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  60   <span class="keyword">bool</span> <a class="link" href="special_values_parser.html#idp496874688-bb"><span class="identifier">match</span></a><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="special_values_parser.html#boost.date_time.special_values_parser.match_results">match_results</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  61
  62   <span class="comment">// public data members</span>
  63   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">nadt_string</span><span class="special">;</span>
  64   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">neg_inf_string</span><span class="special">;</span>
  65   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">pos_inf_string</span><span class="special">;</span>
  66   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">min_date_time_string</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">max_date_time_string</span><span class="special">;</span>
  68 <span class="special">}</span><span class="special">;</span></pre></div>
  69 <div class="refsect1">
  70 <a name="idp227331568"></a><h2>Description</h2>
  71 <p>TODO: add doc-comments for which elements can be changed Parses input stream for strings representing special_values. Special values parsed are:</p>
  72 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  73 <li class="listitem"><p>not_a_date_time</p></li>
  74 <li class="listitem"><p>neg_infin</p></li>
  75 <li class="listitem"><p>pod_infin</p></li>
  76 <li class="listitem"><p>min_date_time</p></li>
  77 <li class="listitem"><p>max_date_time </p></li>
  78 </ul></div>
  79 <p>
  80 </p>
  81 <div class="refsect2">
  82 <a name="idp227334864"></a><h3>
  83 <a name="boost.date_time.special_values_parserconstruct-copy-destruct"></a><code class="computeroutput">special_values_parser</code>
  84         public
  85        construct/copy/destruct</h3>
  86 <div class="orderedlist"><ol class="orderedlist" type="1">
  87 <li class="listitem">
  88 <pre class="literallayout"><a name="idp496878672-bb"></a><span class="identifier">special_values_parser</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Creates a <code class="computeroutput"><a class="link" href="special_values_parser.html" title="Class template special_values_parser">special_values_parser</a></code> with the default set of "sv_strings". </li>
  89 <li class="listitem">
  90 <pre class="literallayout"><a name="idp496880000-bb"></a><span class="identifier">special_values_parser</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> nadt_str<span class="special">,</span>
  91                       <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> neg_inf_str<span class="special">,</span>
  92                       <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> pos_inf_str<span class="special">,</span>
  93                       <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> min_dt_str<span class="special">,</span>
  94                       <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> max_dt_str<span class="special">)</span><span class="special">;</span></pre>Creates a <code class="computeroutput"><a class="link" href="special_values_parser.html" title="Class template special_values_parser">special_values_parser</a></code> using a user defined set of element strings. </li>
  95 <li class="listitem"><pre class="literallayout"><a name="idp496884784-bb"></a><span class="identifier">special_values_parser</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>
  96                       <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>
  97 <li class="listitem"><pre class="literallayout"><a name="idp496886480-bb"></a><span class="identifier">special_values_parser</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="special_values_parser.html" title="Class template special_values_parser">special_values_parser</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> <span class="special">&amp;</span> svp<span class="special">)</span><span class="special">;</span></pre></li>
  98 </ol></div>
  99 </div>
 100 <div class="refsect2">
 101 <a name="idp227378832"></a><h3>
 102 <a name="idp496869536-bb"></a><code class="computeroutput">special_values_parser</code> public member functions</h3>
 103 <div class="orderedlist"><ol class="orderedlist" type="1">
 104 <li class="listitem">
 105 <pre class="literallayout"><span class="keyword">void</span> <a name="idp496870096-bb"></a><span class="identifier">sv_strings</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> nadt_str<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> neg_inf_str<span class="special">,</span>
 106                 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> pos_inf_str<span class="special">,</span>
 107                 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> min_dt_str<span class="special">,</span>
 108                 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&amp;</span> max_dt_str<span class="special">)</span><span class="special">;</span></pre>Replace special value strings. </li>
 109 <li class="listitem">
 110 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp496874688-bb"></a><span class="identifier">match</span><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&amp;</span> sitr<span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&amp;</span> str_end<span class="special">,</span>
 111            <a class="link" href="special_values_parser.html#boost.date_time.special_values_parser.match_results">match_results</a> <span class="special">&amp;</span> mr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Sets match_results.current_match to the corresponding special_value or -1. </li>
 112 </ol></div>
 113 </div>
 114 </div>
 115 </div>
 116 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 117 <td align="left"></td>
 118 <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
 119     <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>
 120 </div></td>
 121 </tr></table>
 122 <hr>
 123 <div class="spirit-nav">
 124 <a accesskey="p" href="special_values_formatter.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_parser_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="convert_string_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 125 </div>
 126 </body>
 127 </html>