diff options
author | Chanho Park <chanho61.park@samsung.com> | 2014-12-11 18:55:56 +0900 |
---|---|---|
committer | Chanho Park <chanho61.park@samsung.com> | 2014-12-11 18:55:56 +0900 |
commit | 08c1e93fa36a49f49325a07fe91ff92c964c2b6c (patch) | |
tree | 7a7053ceb8874b28ec4b868d4c49b500008a102e /doc/html/boost/date_time/period_parser.html | |
parent | bb4dd8289b351fae6b55e303f189127a394a1edd (diff) | |
download | boost-08c1e93fa36a49f49325a07fe91ff92c964c2b6c.tar.gz boost-08c1e93fa36a49f49325a07fe91ff92c964c2b6c.tar.bz2 boost-08c1e93fa36a49f49325a07fe91ff92c964c2b6c.zip |
Imported Upstream version 1.57.0upstream/1.57.0
Diffstat (limited to 'doc/html/boost/date_time/period_parser.html')
-rw-r--r-- | doc/html/boost/date_time/period_parser.html | 75 |
1 files changed, 36 insertions, 39 deletions
diff --git a/doc/html/boost/date_time/period_parser.html b/doc/html/boost/date_time/period_parser.html index 57be344796..3e7ecdcb20 100644 --- a/doc/html/boost/date_time/period_parser.html +++ b/doc/html/boost/date_time/period_parser.html @@ -3,7 +3,7 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template period_parser</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <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.period_parser_hpp" title="Header <boost/date_time/period_parser.hpp>"> <link rel="prev" href="period_formatter.html" title="Class template period_formatter"> @@ -45,26 +45,26 @@ <span class="keyword">enum</span> <a name="boost.date_time.period_parser.period_range_option"></a>period_range_option <span class="special">{</span> AS_OPEN_RANGE, AS_CLOSED_RANGE <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="period_parser.html#boost.date_time.period_parserconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="period_parser.html#id737085-bb"><span class="identifier">period_parser</span></a><span class="special">(</span><span class="identifier">period_range_option</span> <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</span><span class="special">,</span> + <a class="link" href="period_parser.html#idp44932304-bb"><span class="identifier">period_parser</span></a><span class="special">(</span><span class="identifier">period_range_option</span> <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</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="identifier">default_period_separator</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="identifier">default_period_start_delimeter</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="identifier">default_period_open_range_end_delimeter</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="identifier">default_period_closed_range_end_delimeter</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="period_parser.html#id692965-bb"><span class="identifier">period_parser</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="period_parser.html" title="Class template period_parser">period_parser</a><span class="special"><</span> <span class="identifier">date_type</span><span class="special">,</span> <span class="identifier">CharT</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="period_parser.html#idp47739056-bb"><span class="identifier">period_parser</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="period_parser.html" title="Class template period_parser">period_parser</a><span class="special"><</span> <span class="identifier">date_type</span><span class="special">,</span> <span class="identifier">CharT</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="period_parser.html#id688437-bb">public member functions</a></span> - <span class="identifier">period_range_option</span> <a class="link" href="period_parser.html#id688441-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> - <span class="keyword">void</span> <a class="link" href="period_parser.html#id688449-bb"><span class="identifier">range_option</span></a><span class="special">(</span><span class="identifier">period_range_option</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">collection_type</span> <a class="link" href="period_parser.html#id688462-bb"><span class="identifier">delimiter_strings</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="period_parser.html#id450276-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">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> + <span class="comment">// <a class="link" href="period_parser.html#idp97166864-bb">public member functions</a></span> + <span class="identifier">period_range_option</span> <a class="link" href="period_parser.html#idp97167424-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> + <span class="keyword">void</span> <a class="link" href="period_parser.html#idp46598832-bb"><span class="identifier">range_option</span></a><span class="special">(</span><span class="identifier">period_range_option</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">collection_type</span> <a class="link" href="period_parser.html#idp46600368-bb"><span class="identifier">delimiter_strings</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="period_parser.html#idp48260608-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">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> period_type<span class="special">,</span> <span class="keyword">typename</span> duration_type<span class="special">,</span> <span class="keyword">typename</span> facet_type<span class="special">></span> - <span class="identifier">period_type</span> <a class="link" href="period_parser.html#id376247-bb"><span class="identifier">get_period</span></a><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&</span><span class="special">,</span> + <span class="identifier">period_type</span> <a class="link" href="period_parser.html#idp100188416-bb"><span class="identifier">get_period</span></a><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">period_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">duration_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">facet_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="period_parser.html#id692975-bb">private member functions</a></span> - <span class="keyword">void</span> <a class="link" href="period_parser.html#id692979-bb"><span class="identifier">consume_delim</span></a><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&</span><span class="special">,</span> + <span class="comment">// <a class="link" href="period_parser.html#idp47740368-bb">private member functions</a></span> + <span class="keyword">void</span> <a class="link" href="period_parser.html#idp47740944-bb"><span class="identifier">consume_delim</span></a><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="comment">// public data members</span> @@ -74,56 +74,55 @@ <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> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id1438146"></a><h2>Description</h2> +<a name="idp194012912"></a><h2>Description</h2> <p>Provides settings for the following:</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> -<li class="listitem"><p>period_separator -- default '/'</p></li> -<li class="listitem"><p>period_open_start_delimeter -- default '['</p></li> -<li class="listitem"><p>period_open_range_end_delimeter -- default ')'</p></li> -<li class="listitem"><p>period_closed_range_end_delimeter -- default ']'</p></li> -<li class="listitem"><p>display_as_open_range, display_as_closed_range -- default closed_range</p></li> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p>period_separator <span style="color: red"><ndash></ndash></span> default '/'</p></li> +<li class="listitem"><p>period_open_start_delimeter <span style="color: red"><ndash></ndash></span> default '['</p></li> +<li class="listitem"><p>period_open_range_end_delimeter <span style="color: red"><ndash></ndash></span> default ')'</p></li> +<li class="listitem"><p>period_closed_range_end_delimeter <span style="color: red"><ndash></ndash></span> default ']'</p></li> +<li class="listitem"><p>display_as_open_range, display_as_closed_range <span style="color: red"><ndash></ndash></span> default closed_range</p></li> </ul></div> <p> </p> <p>For a typical date_period, the contents of the input stream would be </p> -<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> - <span class="special">*</span> +<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> </pre> <p> where the date format is controlled by the date facet </p> <div class="refsect2"> -<a name="id1438249"></a><h3> +<a name="idp194025600"></a><h3> <a name="boost.date_time.period_parserconstruct-copy-destruct"></a><code class="computeroutput">period_parser</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="id737085-bb"></a><span class="identifier">period_parser</span><span class="special">(</span><span class="identifier">period_range_option</span> range_opt <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</span><span class="special">,</span> +<pre class="literallayout"><a name="idp44932304-bb"></a><span class="identifier">period_parser</span><span class="special">(</span><span class="identifier">period_range_option</span> range_opt <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</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> period_separator <span class="special">=</span> <span class="identifier">default_period_separator</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> period_start_delimeter <span class="special">=</span> <span class="identifier">default_period_start_delimeter</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> period_open_range_end_delimeter <span class="special">=</span> <span class="identifier">default_period_open_range_end_delimeter</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> 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 parser options. </li> -<li class="listitem"><pre class="literallayout"><a name="id692965-bb"></a><span class="identifier">period_parser</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="period_parser.html" title="Class template period_parser">period_parser</a><span class="special"><</span> <span class="identifier">date_type</span><span class="special">,</span> <span class="identifier">CharT</span> <span class="special">></span> <span class="special">&</span> p_parser<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp47739056-bb"></a><span class="identifier">period_parser</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="period_parser.html" title="Class template period_parser">period_parser</a><span class="special"><</span> <span class="identifier">date_type</span><span class="special">,</span> <span class="identifier">CharT</span> <span class="special">></span> <span class="special">&</span> p_parser<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="id1438539"></a><h3> -<a name="id688437-bb"></a><code class="computeroutput">period_parser</code> public member functions</h3> +<a name="idp194060848"></a><h3> +<a name="idp97166864-bb"></a><code class="computeroutput">period_parser</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><span class="identifier">period_range_option</span> <a name="id688441-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> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id688449-bb"></a><span class="identifier">range_option</span><span class="special">(</span><span class="identifier">period_range_option</span> option<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="identifier">collection_type</span> <a name="id688462-bb"></a><span class="identifier">delimiter_strings</span><span class="special">(</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="id450276-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">&</span> separator<span class="special">,</span> +<li class="listitem"><pre class="literallayout"><span class="identifier">period_range_option</span> <a name="idp97167424-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> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp46598832-bb"></a><span class="identifier">range_option</span><span class="special">(</span><span class="identifier">period_range_option</span> option<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">collection_type</span> <a name="idp46600368-bb"></a><span class="identifier">delimiter_strings</span><span class="special">(</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="idp48260608-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">&</span> separator<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> start_delim<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> open_end_delim<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> closed_end_delim<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> period_type<span class="special">,</span> <span class="keyword">typename</span> duration_type<span class="special">,</span> <span class="keyword">typename</span> facet_type<span class="special">></span> - <span class="identifier">period_type</span> <a name="id376247-bb"></a><span class="identifier">get_period</span><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&</span> sitr<span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&</span> stream_end<span class="special">,</span> + <span class="identifier">period_type</span> <a name="idp100188416-bb"></a><span class="identifier">get_period</span><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&</span> sitr<span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&</span> stream_end<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&</span> a_ios<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">period_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">duration_type</span> <span class="special">&</span> dur_unit<span class="special">,</span> - <span class="keyword">const</span> <span class="identifier">facet_type</span> <span class="special">&</span> facet<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Generic code to parse a period -- no matter the period type. <p>This generic code will parse any period using a facet to to get the 'elements'. For example, in the case of a date_period the elements will be instances of a date which will be parsed according the to setup in the passed facet parameter.</p> + <span class="keyword">const</span> <span class="identifier">facet_type</span> <span class="special">&</span> facet<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Generic code to parse a period <span style="color: red"><ndash></ndash></span> no matter the period type. <p>This generic code will parse any period using a facet to to get the 'elements'. For example, in the case of a date_period the elements will be instances of a date which will be parsed according the to setup in the passed facet parameter.</p> <p>The steps for parsing a period are always the same:</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><p>consume the start delimiter</p></li> <li class="listitem"><p>get start element</p></li> <li class="listitem"><p>consume the separator</p></li> @@ -133,20 +132,18 @@ <p> </p> <p>Thus for a typical date period the contents of the input stream might look like this: </p> -<pre class="programlisting"> [March 01, 2004/June 07, 2004] <-- closed range - [March 01, 2004/June 08, 2004) <-- open range - - * +<pre class="programlisting"><span class="special">[</span><span class="identifier">March</span> <span class="number">01</span><span class="special">,</span> <span class="number">2004</span><span class="special">/</span><span class="identifier">June</span> <span class="number">07</span><span class="special">,</span> <span class="number">2004</span><span class="special">]</span> <span class="special"><</span><span class="special">--</span> <span class="identifier">closed</span> <span class="identifier">range</span> +<span class="special">[</span><span class="identifier">March</span> <span class="number">01</span><span class="special">,</span> <span class="number">2004</span><span class="special">/</span><span class="identifier">June</span> <span class="number">08</span><span class="special">,</span> <span class="number">2004</span><span class="special">)</span> <span class="special"><</span><span class="special">--</span> <span class="identifier">open</span> <span class="identifier">range</span> </pre> <p> </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="id1439051"></a><h3> -<a name="id692975-bb"></a><code class="computeroutput">period_parser</code> private member functions</h3> +<a name="idp194140816"></a><h3> +<a name="idp47740368-bb"></a><code class="computeroutput">period_parser</code> private member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id692979-bb"></a><span class="identifier">consume_delim</span><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&</span> sitr<span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&</span> stream_end<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp47740944-bb"></a><span class="identifier">consume_delim</span><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&</span> sitr<span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&</span> stream_end<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> delim<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>throws ios_base::failure if delimiter and parsed data do not match </li></ol></div> </div> </div> |