• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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=UTF-8">
5<title>Class template simple_format</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.date_format_simple_hpp" title="Header &lt;boost/date_time/date_format_simple.hpp&gt;">
10<link rel="prev" href="date_input_facet.html" title="Class template date_input_facet">
11<link rel="next" href="simpl_1_3_14_15_3_13_1_1_2.html" title="Class simple_format&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="date_input_facet.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_format_simple_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="simpl_1_3_14_15_3_13_1_1_2.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.date_time.simple_format"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Class template simple_format</span></h2>
30<p>boost::date_time::simple_format — Class to provide simple basic formatting rules. </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.date_format_simple_hpp" title="Header &lt;boost/date_time/date_format_simple.hpp&gt;">boost/date_time/date_format_simple.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="simple_format.html" title="Class template simple_format">simple_format</a> <span class="special">{</span>
37<span class="keyword">public</span><span class="special">:</span>
38
39  <span class="comment">// <a class="link" href="simple_format.html#id-1_3_14_15_3_13_1_1_1_3-bb">public static functions</a></span>
40  <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a class="link" href="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_1-bb"><span class="identifier">not_a_date</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="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_2-bb"><span class="identifier">pos_infinity</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="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_3-bb"><span class="identifier">neg_infinity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
43  <span class="keyword">static</span> <span class="identifier">month_format_spec</span> <a class="link" href="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_4-bb"><span class="identifier">month_format</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
44  <span class="keyword">static</span> <span class="identifier">ymd_order_spec</span> <a class="link" href="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_5-bb"><span class="identifier">date_order</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
45  <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_6-bb"><span class="identifier">has_date_sep_chars</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="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_7-bb"><span class="identifier">year_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="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_8-bb"><span class="identifier">month_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="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_9-bb"><span class="identifier">day_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="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_10-bb"><span class="identifier">hour_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="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_11-bb"><span class="identifier">minute_sep_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="simple_format.html#id-1_3_14_15_3_13_1_1_1_3_12-bb"><span class="identifier">second_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
52<span class="special">}</span><span class="special">;</span></pre></div>
53<div class="refsect1">
54<a name="id-1.3.14.15.3.13.3.4"></a><h2>Description</h2>
55<div class="refsect2">
56<a name="id-1.3.14.15.3.13.3.4.2"></a><h3>
57<a name="id-1_3_14_15_3_13_1_1_1_3-bb"></a><code class="computeroutput">simple_format</code> public static functions</h3>
58<div class="orderedlist"><ol class="orderedlist" type="1">
59<li class="listitem">
60<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="id-1_3_14_15_3_13_1_1_1_3_1-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>
61<li class="listitem">
62<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="id-1_3_14_15_3_13_1_1_1_3_2-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>
63<li class="listitem">
64<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="id-1_3_14_15_3_13_1_1_1_3_3-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>
65<li class="listitem">
66<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">month_format_spec</span> <a name="id-1_3_14_15_3_13_1_1_1_3_4-bb"></a><span class="identifier">month_format</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Describe month format. </li>
67<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">ymd_order_spec</span> <a name="id-1_3_14_15_3_13_1_1_1_3_5-bb"></a><span class="identifier">date_order</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
68<li class="listitem">
69<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="id-1_3_14_15_3_13_1_1_1_3_6-bb"></a><span class="identifier">has_date_sep_chars</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>This format uses '-' to separate date elements. </li>
70<li class="listitem">
71<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id-1_3_14_15_3_13_1_1_1_3_7-bb"></a><span class="identifier">year_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Char to sep? </li>
72<li class="listitem">
73<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id-1_3_14_15_3_13_1_1_1_3_8-bb"></a><span class="identifier">month_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>char between year-month </li>
74<li class="listitem">
75<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id-1_3_14_15_3_13_1_1_1_3_9-bb"></a><span class="identifier">day_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Char to separate month-day. </li>
76<li class="listitem">
77<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id-1_3_14_15_3_13_1_1_1_3_10-bb"></a><span class="identifier">hour_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>char between date-hours </li>
78<li class="listitem">
79<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id-1_3_14_15_3_13_1_1_1_3_11-bb"></a><span class="identifier">minute_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>char between hour and minute </li>
80<li class="listitem">
81<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id-1_3_14_15_3_13_1_1_1_3_12-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>
82</ol></div>
83</div>
84<div class="refsect2">
85<a name="id-1.3.14.15.3.13.3.4.3"></a><h3>Specializations</h3>
86<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a class="link" href="simpl_1_3_14_15_3_13_1_1_2.html" title="Class simple_format&lt;wchar_t&gt;">Class simple_format&lt;wchar_t&gt;</a></p></li></ul></div>
87</div>
88</div>
89</div>
90<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
91<td align="left"></td>
92<td align="right"><div class="copyright-footer">Copyright © 2001-2005 CrystalClear Software, Inc<p>Subject to the Boost Software License, Version 1.0. (See accompanying file
93    <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>
94</div></td>
95</tr></table>
96<hr>
97<div class="spirit-nav">
98<a accesskey="p" href="date_input_facet.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_format_simple_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="simpl_1_3_14_15_3_13_1_1_2.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
99</div>
100</body>
101</html>
102