doc/html/boost/date_time/iso_format_base.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 iso_format_base</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.iso_format_hpp" title="Header &lt;boost/date_time/iso_format.hpp&gt;">
  10 <link rel="prev" href="operator_idp496433744.html" title="Function template operator&lt;&lt;">
  11 <link rel="next" href="iso_format_ba_idp496473088.html" title="Class iso_format_base&lt;wchar_t&gt;">
  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="operator_idp496433744.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.iso_format_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="iso_format_ba_idp496473088.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.date_time.iso_format_base"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template iso_format_base</span></h2>
  30 <p>boost::date_time::iso_format_base &#8212; Class to provide common iso formatting spec. </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.iso_format_hpp" title="Header &lt;boost/date_time/iso_format.hpp&gt;">boost/date_time/iso_format.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> charT<span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="iso_format_base.html" title="Class template iso_format_base">iso_format_base</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38
  39   <span class="comment">// <a class="link" href="iso_format_base.html#idp496442960-bb">public static functions</a></span>
  40   <span class="keyword">static</span> <span class="identifier">month_format_spec</span> <a class="link" href="iso_format_base.html#idp496443520-bb"><span class="identifier">month_format</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  41   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a class="link" href="iso_format_base.html#idp496444976-bb"><span class="identifier">not_a_date</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  42   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a class="link" href="iso_format_base.html#idp496446416-bb"><span class="identifier">pos_infinity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  43   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a class="link" href="iso_format_base.html#idp496447856-bb"><span class="identifier">neg_infinity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  44   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496449296-bb"><span class="identifier">year_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  45   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496450736-bb"><span class="identifier">month_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  46   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496452144-bb"><span class="identifier">day_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496453552-bb"><span class="identifier">hour_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  48   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496454960-bb"><span class="identifier">minute_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  49   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496456368-bb"><span class="identifier">second_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  50   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496457776-bb"><span class="identifier">period_start_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  51   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496459184-bb"><span class="identifier">time_start_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  52   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496460624-bb"><span class="identifier">week_start_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  53   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496462080-bb"><span class="identifier">period_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  54   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496463504-bb"><span class="identifier">time_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  55   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496464928-bb"><span class="identifier">fractional_time_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  56   <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="iso_format_base.html#idp496466384-bb"><span class="identifier">is_component_sep</span></a><span class="special">(</span><span class="identifier">charT</span><span class="special">)</span><span class="special">;</span>
  57   <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="iso_format_base.html#idp496468192-bb"><span class="identifier">is_fractional_time_sep</span></a><span class="special">(</span><span class="identifier">charT</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="iso_format_base.html#idp496470000-bb"><span class="identifier">is_timezone_sep</span></a><span class="special">(</span><span class="identifier">charT</span><span class="special">)</span><span class="special">;</span>
  59   <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#idp496471808-bb"><span class="identifier">element_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  60 <span class="special">}</span><span class="special">;</span></pre></div>
  61 <div class="refsect1">
  62 <a name="idp224694480"></a><h2>Description</h2>
  63 <div class="refsect2">
  64 <a name="idp224694896"></a><h3>
  65 <a name="idp496442960-bb"></a><code class="computeroutput">iso_format_base</code> public static functions</h3>
  66 <div class="orderedlist"><ol class="orderedlist" type="1">
  67 <li class="listitem">
  68 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">month_format_spec</span> <a name="idp496443520-bb"></a><span class="identifier">month_format</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Describe month format &#8211; its an integer in iso format. </li>
  69 <li class="listitem">
  70 <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="idp496444976-bb"></a><span class="identifier">not_a_date</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>String used printed is date is invalid. </li>
  71 <li class="listitem">
  72 <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="idp496446416-bb"></a><span class="identifier">pos_infinity</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>String used to for positive infinity value. </li>
  73 <li class="listitem">
  74 <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="idp496447856-bb"></a><span class="identifier">neg_infinity</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>String used to for positive infinity value. </li>
  75 <li class="listitem">
  76 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496449296-bb"></a><span class="identifier">year_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>ISO char for a year &#8211; used in durations. </li>
  77 <li class="listitem">
  78 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496450736-bb"></a><span class="identifier">month_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>ISO char for a month. </li>
  79 <li class="listitem">
  80 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496452144-bb"></a><span class="identifier">day_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>ISO char for a day. </li>
  81 <li class="listitem">
  82 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496453552-bb"></a><span class="identifier">hour_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>char for minute </li>
  83 <li class="listitem">
  84 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496454960-bb"></a><span class="identifier">minute_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>char for minute </li>
  85 <li class="listitem">
  86 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496456368-bb"></a><span class="identifier">second_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>char for second </li>
  87 <li class="listitem">
  88 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496457776-bb"></a><span class="identifier">period_start_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>ISO char for a period. </li>
  89 <li class="listitem">
  90 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496459184-bb"></a><span class="identifier">time_start_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Used in time in mixed strings to set start of time. </li>
  91 <li class="listitem">
  92 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496460624-bb"></a><span class="identifier">week_start_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Used in mixed strings to identify start of a week number. </li>
  93 <li class="listitem">
  94 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496462080-bb"></a><span class="identifier">period_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Separators for periods. </li>
  95 <li class="listitem">
  96 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496463504-bb"></a><span class="identifier">time_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Separator for hh:mm:ss. </li>
  97 <li class="listitem">
  98 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496464928-bb"></a><span class="identifier">fractional_time_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Preferred Separator for hh:mm:ss,decimal_fraction. </li>
  99 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp496466384-bb"></a><span class="identifier">is_component_sep</span><span class="special">(</span><span class="identifier">charT</span> sep<span class="special">)</span><span class="special">;</span></pre></li>
 100 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp496468192-bb"></a><span class="identifier">is_fractional_time_sep</span><span class="special">(</span><span class="identifier">charT</span> sep<span class="special">)</span><span class="special">;</span></pre></li>
 101 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp496470000-bb"></a><span class="identifier">is_timezone_sep</span><span class="special">(</span><span class="identifier">charT</span> sep<span class="special">)</span><span class="special">;</span></pre></li>
 102 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="idp496471808-bb"></a><span class="identifier">element_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 103 </ol></div>
 104 </div>
 105 <div class="refsect2">
 106 <a name="idp224806448"></a><h3>Specializations</h3>
 107 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a class="link" href="iso_format_ba_idp496473088.html" title="Class iso_format_base&lt;wchar_t&gt;">Class iso_format_base&lt;wchar_t&gt;</a></p></li></ul></div>
 108 </div>
 109 </div>
 110 </div>
 111 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 112 <td align="left"></td>
 113 <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
 114     <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>
 115 </div></td>
 116 </tr></table>
 117 <hr>
 118 <div class="spirit-nav">
 119 <a accesskey="p" href="operator_idp496433744.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.iso_format_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="iso_format_ba_idp496473088.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 120 </div>
 121 </body>
 122 </html>