File: classmysqlpp_1_1Time.html

package info (click to toggle)
mysql%2B%2B 3.0.9-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 11,228 kB
  • ctags: 9,647
  • sloc: cpp: 33,154; sh: 3,098; perl: 778; makefile: 700
file content (236 lines) | stat: -rw-r--r-- 16,345 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
	<title>MySQL++ Reference Manual</title>
	<meta http-equiv="Content-type" content="text/html;charset=iso-8859-1">
	<link href="doxygen.css" rel="stylesheet" type="text/css">
	<link href="refman.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<div class="nav">
<b>mysqlpp</b>::<a class="el" href="classmysqlpp_1_1Time.html">Time</a></div>
<h1>mysqlpp::Time Class Reference</h1><!-- doxytag: class="mysqlpp::Time" --><!-- doxytag: inherits="Comparable" -->C++ form of SQL's TIME type.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="datetime_8h-source.html">datetime.h</a>&gt;</code>
<p>
Inheritance diagram for mysqlpp::Time:<p><center><img src="classmysqlpp_1_1Time__inherit__graph.png" border="0" usemap="#mysqlpp_1_1Time__inherit__map" alt="Inheritance graph"></center>
<map name="mysqlpp_1_1Time__inherit__map">
<area href="classComparable.html" shape="rect" coords="5,7,235,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for mysqlpp::Time:<p><center><img src="classmysqlpp_1_1Time__coll__graph.png" border="0" usemap="#mysqlpp_1_1Time__coll__map" alt="Collaboration graph"></center>
<map name="mysqlpp_1_1Time__coll__map">
<area href="classComparable.html" shape="rect" coords="5,7,235,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1Time-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b22256adcccacf69e092d0d057018c3e"></a><!-- doxytag: member="mysqlpp::Time::Time" ref="b22256adcccacf69e092d0d057018c3e" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#b22256adcccacf69e092d0d057018c3e">Time</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="86338fd97b61c82032d78626b5e71534"></a><!-- doxytag: member="mysqlpp::Time::Time" ref="86338fd97b61c82032d78626b5e71534" args="(unsigned char h, unsigned char m, unsigned char s)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#86338fd97b61c82032d78626b5e71534">Time</a> (unsigned char h, unsigned char m, unsigned char s)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4677463d04af62e7f5e273ef221fed65"></a><!-- doxytag: member="mysqlpp::Time::Time" ref="4677463d04af62e7f5e273ef221fed65" args="(const Time &amp;other)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#4677463d04af62e7f5e273ef221fed65">Time</a> (const <a class="el" href="classmysqlpp_1_1Time.html">Time</a> &amp;other)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize object as a copy of another <a class="el" href="classmysqlpp_1_1Time.html">Time</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf9cfcb0cd6f5d900658acf8394f5379"></a><!-- doxytag: member="mysqlpp::Time::Time" ref="cf9cfcb0cd6f5d900658acf8394f5379" args="(const DateTime &amp;other)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#cf9cfcb0cd6f5d900658acf8394f5379">Time</a> (const <a class="el" href="classmysqlpp_1_1DateTime.html">DateTime</a> &amp;other)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize object from time part of date/time object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#6b5f0dd2e877e95dd2520d4507d6a657">Time</a> (const char *str)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize object from a C string containing a SQL time string.  <a href="#6b5f0dd2e877e95dd2520d4507d6a657"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class Str&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#81cc9caefe16c4cb5f09671638944bbd">Time</a> (const Str &amp;str)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize object from a C++ string containing a SQL time string.  <a href="#81cc9caefe16c4cb5f09671638944bbd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#86cd1bb6ce70199907d6853e3e1fe53d">Time</a> (time_t t)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize object from a <code>time_t</code>.  <a href="#86cd1bb6ce70199907d6853e3e1fe53d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#55c735d6dd5563d0ff921e06991e9ba3">compare</a> (const <a class="el" href="classmysqlpp_1_1Time.html">Time</a> &amp;other) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare this time to another.  <a href="#55c735d6dd5563d0ff921e06991e9ba3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="799341cb9540bca202d6170ad5ffbb22"></a><!-- doxytag: member="mysqlpp::Time::convert" ref="799341cb9540bca202d6170ad5ffbb22" args="(const char *)" -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#799341cb9540bca202d6170ad5ffbb22">convert</a> (const char *)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse a SQL time string into this object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bdf6acfc800c3f035528236b97ad82dd"></a><!-- doxytag: member="mysqlpp::Time::hour" ref="bdf6acfc800c3f035528236b97ad82dd" args="() const " -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#bdf6acfc800c3f035528236b97ad82dd">hour</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the time's hour part, 0-23. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a84fbbeca4515a70beb227937fb0aa82"></a><!-- doxytag: member="mysqlpp::Time::hour" ref="a84fbbeca4515a70beb227937fb0aa82" args="(unsigned char h)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#a84fbbeca4515a70beb227937fb0aa82">hour</a> (unsigned char h)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Change the time's hour part, 0-23. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab9087115d43c65b4c7398cfef790565"></a><!-- doxytag: member="mysqlpp::Time::minute" ref="ab9087115d43c65b4c7398cfef790565" args="() const " -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#ab9087115d43c65b4c7398cfef790565">minute</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the time's minute part, 0-59. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d1f0ceffefa07814fe1ff7f413c6f474"></a><!-- doxytag: member="mysqlpp::Time::minute" ref="d1f0ceffefa07814fe1ff7f413c6f474" args="(unsigned char m)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#d1f0ceffefa07814fe1ff7f413c6f474">minute</a> (unsigned char m)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Change the time's minute part, 0-59. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a619f6c7ce99e0571ae3cc71b384c363"></a><!-- doxytag: member="mysqlpp::Time::operator std::string" ref="a619f6c7ce99e0571ae3cc71b384c363" args="() const " -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#a619f6c7ce99e0571ae3cc71b384c363">operator std::string</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert to std::string. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#4af89963a705b8b0801ec71c99f33cc8">operator time_t</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert to time_t.  <a href="#4af89963a705b8b0801ec71c99f33cc8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7539f7d0548190f5c2e8a1b6c8edc759"></a><!-- doxytag: member="mysqlpp::Time::second" ref="7539f7d0548190f5c2e8a1b6c8edc759" args="() const " -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#7539f7d0548190f5c2e8a1b6c8edc759">second</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the time's second part, 0-59. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f7cd937e307d2df96952b3bf5a606c66"></a><!-- doxytag: member="mysqlpp::Time::second" ref="f7cd937e307d2df96952b3bf5a606c66" args="(unsigned char s)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#f7cd937e307d2df96952b3bf5a606c66">second</a> (unsigned char s)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Change the time's second part, 0-59. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71e5284c322523d60c8cf5bb36d7b231"></a><!-- doxytag: member="mysqlpp::Time::str" ref="71e5284c322523d60c8cf5bb36d7b231" args="() const " -->
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Time.html#71e5284c322523d60c8cf5bb36d7b231">str</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return our value in std::string form. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
C++ form of SQL's TIME type. 
<p>
Objects of this class can be inserted into streams, and initialized from SQL TIME strings. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="6b5f0dd2e877e95dd2520d4507d6a657"></a><!-- doxytag: member="mysqlpp::Time::Time" ref="6b5f0dd2e877e95dd2520d4507d6a657" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mysqlpp::Time::Time           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>str</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize object from a C string containing a SQL time string. 
<p>
<a class="el" href="classmysqlpp_1_1String.html">String</a> must be in the HH:MM:SS format. It doesn't have to be zero-padded. 
</div>
</div><p>
<a class="anchor" name="81cc9caefe16c4cb5f09671638944bbd"></a><!-- doxytag: member="mysqlpp::Time::Time" ref="81cc9caefe16c4cb5f09671638944bbd" args="(const Str &amp;str)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Str&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">mysqlpp::Time::Time           </td>
          <td>(</td>
          <td class="paramtype">const Str &amp;&nbsp;</td>
          <td class="paramname"> <em>str</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize object from a C++ string containing a SQL time string. 
<p>
This works with any stringish class that declares a c_str() member function: std::string, <a class="el" href="classmysqlpp_1_1String.html">mysqlpp::String</a>...<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classmysqlpp_1_1Time.html#6b5f0dd2e877e95dd2520d4507d6a657">Time(const char*)</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="86cd1bb6ce70199907d6853e3e1fe53d"></a><!-- doxytag: member="mysqlpp::Time::Time" ref="86cd1bb6ce70199907d6853e3e1fe53d" args="(time_t t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mysqlpp::Time::Time           </td>
          <td>(</td>
          <td class="paramtype">time_t&nbsp;</td>
          <td class="paramname"> <em>t</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize object from a <code>time_t</code>. 
<p>
Naturally, we throw away the "date" part of the <code>time_t</code>. If you need to keep it, you want to use <a class="el" href="classmysqlpp_1_1DateTime.html">DateTime</a> instead. 
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="55c735d6dd5563d0ff921e06991e9ba3"></a><!-- doxytag: member="mysqlpp::Time::compare" ref="55c735d6dd5563d0ff921e06991e9ba3" args="(const Time &amp;other) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mysqlpp::Time::compare           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classmysqlpp_1_1Time.html">Time</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Compare this time to another. 
<p>
Returns &lt; 0 if this time is before the other, 0 of they are equal, and &gt; 0 if this time is after the other. 
</div>
</div><p>
<a class="anchor" name="4af89963a705b8b0801ec71c99f33cc8"></a><!-- doxytag: member="mysqlpp::Time::operator time_t" ref="4af89963a705b8b0801ec71c99f33cc8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mysqlpp::Time::operator time_t           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convert to time_t. 
<p>
The "date" part of the <code>time_t</code> is "today" 
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="datetime_8h-source.html">datetime.h</a><li>datetime.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Feb 4 14:43:02 2009 for MySQL++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>