~ubuntu-branches/debian/sid/boost1.49/sid

« back to all changes in this revision

Viewing changes to doc/html/boost/date_time/iso_format_base.html

  • Committer: Package Import Robot
  • Author(s): Steve M. Robbins
  • Date: 2012-02-26 00:31:44 UTC
  • Revision ID: package-import@ubuntu.com-20120226003144-eaytp12cbf6ubpms
Tags: upstream-1.49.0
ImportĀ upstreamĀ versionĀ 1.49.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>Class template iso_format_base</title>
 
5
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
 
8
<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;">
 
9
<link rel="prev" href="operator_id386869.html" title="Function template operator&lt;&lt;">
 
10
<link rel="next" href="iso_format_base_wchar_t_id703444.html" title="Class iso_format_base&lt;wchar_t&gt;">
 
11
</head>
 
12
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
13
<table cellpadding="2" width="100%"><tr>
 
14
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
 
15
<td align="center"><a href="../../../../index.html">Home</a></td>
 
16
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
 
17
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
 
18
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
 
19
<td align="center"><a href="../../../../more/index.htm">More</a></td>
 
20
</tr></table>
 
21
<hr>
 
22
<div class="spirit-nav">
 
23
<a accesskey="p" href="operator_id386869.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_id703444.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 
24
</div>
 
25
<div class="refentry">
 
26
<a name="boost.date_time.iso_format_base"></a><div class="titlepage"></div>
 
27
<div class="refnamediv">
 
28
<h2><span class="refentrytitle">Class template iso_format_base</span></h2>
 
29
<p>boost::date_time::iso_format_base &#8212; Class to provide common iso formatting spec. </p>
 
30
</div>
 
31
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
 
32
<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;
 
33
 
 
34
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> charT<span class="special">&gt;</span> 
 
35
<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>
 
36
<span class="keyword">public</span><span class="special">:</span>
 
37
 
 
38
  <span class="comment">// <a class="link" href="iso_format_base.html#id746393-bb">public static functions</a></span>
 
39
  <span class="keyword">static</span> <span class="identifier">month_format_spec</span> <a class="link" href="iso_format_base.html#id746396-bb"><span class="identifier">month_format</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</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="iso_format_base.html#id468207-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="iso_format_base.html#id468218-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="iso_format_base.html#id698561-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">charT</span> <a class="link" href="iso_format_base.html#id671221-bb"><span class="identifier">year_sep_char</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#id671231-bb"><span class="identifier">month_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#id671241-bb"><span class="identifier">day_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#id689274-bb"><span class="identifier">hour_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#id689285-bb"><span class="identifier">minute_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#id689295-bb"><span class="identifier">second_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#id362918-bb"><span class="identifier">period_start_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#id362928-bb"><span class="identifier">time_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#id378391-bb"><span class="identifier">week_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#id356431-bb"><span class="identifier">period_sep_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#id356441-bb"><span class="identifier">time_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#id703384-bb"><span class="identifier">fractional_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="keyword">bool</span> <a class="link" href="iso_format_base.html#id703395-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>
 
56
  <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="iso_format_base.html#id703409-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>
 
57
  <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="iso_format_base.html#id703422-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>
 
58
  <span class="keyword">static</span> <span class="identifier">charT</span> <a class="link" href="iso_format_base.html#id703436-bb"><span class="identifier">element_sep_char</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
59
<span class="special">}</span><span class="special">;</span></pre></div>
 
60
<div class="refsect1">
 
61
<a name="id1404085"></a><h2>Description</h2>
 
62
<div class="refsect2">
 
63
<a name="id1404088"></a><h3>
 
64
<a name="id746393-bb"></a><code class="computeroutput">iso_format_base</code> public static functions</h3>
 
65
<div class="orderedlist"><ol class="orderedlist" type="1">
 
66
<li class="listitem">
 
67
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">month_format_spec</span> <a name="id746396-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>
 
68
<li class="listitem">
 
69
<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="id468207-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>
 
70
<li class="listitem">
 
71
<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="id468218-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>
 
72
<li class="listitem">
 
73
<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span> <a name="id698561-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>
 
74
<li class="listitem">
 
75
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id671221-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>
 
76
<li class="listitem">
 
77
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id671231-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>
 
78
<li class="listitem">
 
79
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id671241-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>
 
80
<li class="listitem">
 
81
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id689274-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>
 
82
<li class="listitem">
 
83
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id689285-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>
 
84
<li class="listitem">
 
85
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id689295-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>
 
86
<li class="listitem">
 
87
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id362918-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>
 
88
<li class="listitem">
 
89
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id362928-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>
 
90
<li class="listitem">
 
91
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id378391-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>
 
92
<li class="listitem">
 
93
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id356431-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>
 
94
<li class="listitem">
 
95
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id356441-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>
 
96
<li class="listitem">
 
97
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id703384-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>
 
98
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="id703395-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>
 
99
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="id703409-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>
 
100
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="id703422-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>
 
101
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">charT</span> <a name="id703436-bb"></a><span class="identifier">element_sep_char</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 
102
</ol></div>
 
103
</div>
 
104
<div class="refsect2">
 
105
<a name="id1404996"></a><h3>Specializations</h3>
 
106
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a class="link" href="iso_format_base_wchar_t_id703444.html" title="Class iso_format_base&lt;wchar_t&gt;">Class iso_format_base&lt;wchar_t&gt;</a></p></li></ul></div>
 
107
</div>
 
108
</div>
 
109
</div>
 
110
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 
111
<td align="left"></td>
 
112
<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
 
113
    <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>
 
114
</div></td>
 
115
</tr></table>
 
116
<hr>
 
117
<div class="spirit-nav">
 
118
<a accesskey="p" href="operator_id386869.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_id703444.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 
119
</div>
 
120
</body>
 
121
</html>