blob: 43bda3c3656633f8e3be85550722f9ba93dffede [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template iso_format_base</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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.iso_format_hpp" title="Header &lt;boost/date_time/iso_format.hpp&gt;">
<link rel="prev" href="operator_id410013.html" title="Function template operator&lt;&lt;">
<link rel="next" href="iso_format_base_wchar_t_id467931.html" title="Class iso_format_base&lt;wchar_t&gt;">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="operator_id410013.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_base_wchar_t_id467931.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.date_time.iso_format_base"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template iso_format_base</span></h2>
<p>boost::date_time::iso_format_base &#8212; Class to provide common iso formatting spec. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<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;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> charT<span class="special">&gt;</span>
<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>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="iso_format_base.html#id354272-bb">public static functions</a></span>
<span class="keyword">static</span> <span class="identifier">month_format_spec</span> <a class="link" href="iso_format_base.html#id354276-bb"><span class="identifier">month_format</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<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#id354287-bb"><span class="identifier">not_a_date</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<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#id354298-bb"><span class="identifier">pos_infinity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<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#id391774-bb"><span class="identifier">neg_infinity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id391785-bb"><span class="identifier">year_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id358899-bb"><span class="identifier">month_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id358909-bb"><span class="identifier">day_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id403390-bb"><span class="identifier">hour_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id403400-bb"><span class="identifier">minute_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id403410-bb"><span class="identifier">second_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id580538-bb"><span class="identifier">period_start_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id366541-bb"><span class="identifier">time_start_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id366552-bb"><span class="identifier">week_start_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id331728-bb"><span class="identifier">period_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id331738-bb"><span class="identifier">time_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id587172-bb"><span class="identifier">fractional_time_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="iso_format_base.html#id587184-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>
<span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="iso_format_base.html#id411311-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>
<span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="iso_format_base.html#id411324-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>
<span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id411338-bb"><span class="identifier">element_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id1140212"></a><h2>Description</h2>
<div class="refsect2">
<a name="id1140216"></a><h3>
<a name="id354272-bb"></a><code class="computeroutput">iso_format_base</code> public static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">month_format_spec</span> <a name="id354276-bb"></a><span class="identifier">month_format</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Describe month format -- its an integer in iso format. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="id354287-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="id354298-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="id391774-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id391785-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 -- used in durations. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id358899-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id358909-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id403390-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id403400-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id403410-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id580538-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id366541-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id366552-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id331728-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id331738-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id587172-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>
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="id587184-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>
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="id411311-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>
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="id411324-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>
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id411338-bb"></a><span class="identifier">element_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="id1141123"></a><h3>Specializations</h3>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a class="link" href="iso_format_base_wchar_t_id467931.html" title="Class iso_format_base&lt;wchar_t&gt;">Class iso_format_base&lt;wchar_t&gt;</a></p></li></ul></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<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
<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>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="operator_id410013.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_base_wchar_t_id467931.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>