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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
<!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 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 List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<b>mysqlpp</b>::<a class="el" href="classmysqlpp_1_1Date.html">Date</a></div>
<h1>mysqlpp::Date Class Reference</h1><!-- doxytag: class="mysqlpp::Date" --><!-- doxytag: inherits="Comparable" -->C++ form of SQL's DATE type.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="datetime_8h-source.html">datetime.h</a>></code>
<p>
Inheritance diagram for mysqlpp::Date:<p><center><img src="classmysqlpp_1_1Date__inherit__graph.png" border="0" usemap="#mysqlpp_1_1Date__inherit__map" alt="Inheritance graph"></center>
<map name="mysqlpp_1_1Date__inherit__map">
<area href="classComparable.html" shape="rect" coords="5,7,232,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for mysqlpp::Date:<p><center><img src="classmysqlpp_1_1Date__coll__graph.png" border="0" usemap="#mysqlpp_1_1Date__coll__map" alt="Collaboration graph"></center>
<map name="mysqlpp_1_1Date__coll__map">
<area href="classComparable.html" shape="rect" coords="5,7,232,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1Date-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="f7734235d07959eed18b09027ed4930d"></a><!-- doxytag: member="mysqlpp::Date::Date" ref="f7734235d07959eed18b09027ed4930d" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#f7734235d07959eed18b09027ed4930d">Date</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7ef3095d32280a8e91cd85e693ec40db"></a><!-- doxytag: member="mysqlpp::Date::Date" ref="7ef3095d32280a8e91cd85e693ec40db" args="(unsigned short y, unsigned char m, unsigned char d)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#7ef3095d32280a8e91cd85e693ec40db">Date</a> (unsigned short y, unsigned char m, unsigned char d)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="30e97344bc6f97f12bbf2e9674faca4d"></a><!-- doxytag: member="mysqlpp::Date::Date" ref="30e97344bc6f97f12bbf2e9674faca4d" args="(const Date &other)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#30e97344bc6f97f12bbf2e9674faca4d">Date</a> (const <a class="el" href="classmysqlpp_1_1Date.html">Date</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize object as a copy of another <a class="el" href="classmysqlpp_1_1Date.html">Date</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d242744ac60cee035ab0640208bd416f"></a><!-- doxytag: member="mysqlpp::Date::Date" ref="d242744ac60cee035ab0640208bd416f" args="(const DateTime &other)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#d242744ac60cee035ab0640208bd416f">Date</a> (const <a class="el" href="classmysqlpp_1_1DateTime.html">DateTime</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize object from date part of date/time object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#06385a2d560ddd11412239221ea2d8b1">Date</a> (const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize object from a C string containing a date. <a href="#06385a2d560ddd11412239221ea2d8b1"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<class Str> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#2169cf8f3222aebf568e57aaf87ecfae">Date</a> (const Str &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize object from a C++ string containing a date. <a href="#2169cf8f3222aebf568e57aaf87ecfae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#1f2f8c4e11dabe035bdf997921ab08f2">Date</a> (time_t t)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize object from a <code>time_t</code>. <a href="#1f2f8c4e11dabe035bdf997921ab08f2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#bfc9a7c6d530b3f2c0acf163265fff32">compare</a> (const <a class="el" href="classmysqlpp_1_1Date.html">Date</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare this date to another. <a href="#bfc9a7c6d530b3f2c0acf163265fff32"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5a073e35be0c0fd95ef63b930df8ade"></a><!-- doxytag: member="mysqlpp::Date::convert" ref="c5a073e35be0c0fd95ef63b930df8ade" args="(const char *)" -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#c5a073e35be0c0fd95ef63b930df8ade">convert</a> (const char *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse a SQL date string into this object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f1ea7fb29d7e514b09ffc4b5890a323"></a><!-- doxytag: member="mysqlpp::Date::day" ref="5f1ea7fb29d7e514b09ffc4b5890a323" args="() const " -->
unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#5f1ea7fb29d7e514b09ffc4b5890a323">day</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the date's day part, 1-31. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2377b5e34f24864d6e727bb949b1735b"></a><!-- doxytag: member="mysqlpp::Date::day" ref="2377b5e34f24864d6e727bb949b1735b" args="(unsigned char d)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#2377b5e34f24864d6e727bb949b1735b">day</a> (unsigned char d)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the date's day part, 1-31. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="281697b4f51fea6c15401a546ab4be3a"></a><!-- doxytag: member="mysqlpp::Date::month" ref="281697b4f51fea6c15401a546ab4be3a" args="() const " -->
unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#281697b4f51fea6c15401a546ab4be3a">month</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the date's month part, 1-12. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="faaa0eea8c9011bd1fed64d47b36e237"></a><!-- doxytag: member="mysqlpp::Date::month" ref="faaa0eea8c9011bd1fed64d47b36e237" args="(unsigned char m)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#faaa0eea8c9011bd1fed64d47b36e237">month</a> (unsigned char m)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the date's month part, 1-12. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e49179b82e1c9c679af8989fb9ded9a2"></a><!-- doxytag: member="mysqlpp::Date::operator std::string" ref="e49179b82e1c9c679af8989fb9ded9a2" args="() const " -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#e49179b82e1c9c679af8989fb9ded9a2">operator std::string</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert to std::string. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#c4459512f44e69ad351265fa5a5a7ee7">operator time_t</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert to time_t. <a href="#c4459512f44e69ad351265fa5a5a7ee7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2571006701ddef9a912c40ad505c35d"></a><!-- doxytag: member="mysqlpp::Date::str" ref="f2571006701ddef9a912c40ad505c35d" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#f2571006701ddef9a912c40ad505c35d">str</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return our value in std::string form. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#07aa052c28f582cc166c2ce826a02e3d">year</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the date's year part. <a href="#07aa052c28f582cc166c2ce826a02e3d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Date.html#6c88fea71a585cfbc8de5d7226ad33b9">year</a> (unsigned short y)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the date's year part. <a href="#6c88fea71a585cfbc8de5d7226ad33b9"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
C++ form of SQL's DATE type.
<p>
Objects of this class can be inserted into streams, and initialized from SQL DATE strings.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="06385a2d560ddd11412239221ea2d8b1"></a><!-- doxytag: member="mysqlpp::Date::Date" ref="06385a2d560ddd11412239221ea2d8b1" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::Date::Date </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize object from a C string containing a date.
<p>
<a class="el" href="classmysqlpp_1_1String.html">String</a> must be in the YYYY-MM-DD format. It doesn't have to be zero-padded.
</div>
</div><p>
<a class="anchor" name="2169cf8f3222aebf568e57aaf87ecfae"></a><!-- doxytag: member="mysqlpp::Date::Date" ref="2169cf8f3222aebf568e57aaf87ecfae" args="(const Str &str)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Str> </div>
<table class="memname">
<tr>
<td class="memname">mysqlpp::Date::Date </td>
<td>(</td>
<td class="paramtype">const Str & </td>
<td class="paramname"> <em>str</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize object from a C++ string containing a date.
<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_1Date.html#06385a2d560ddd11412239221ea2d8b1">Date(const char*)</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="1f2f8c4e11dabe035bdf997921ab08f2"></a><!-- doxytag: member="mysqlpp::Date::Date" ref="1f2f8c4e11dabe035bdf997921ab08f2" args="(time_t t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::Date::Date </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </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 "time" 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="bfc9a7c6d530b3f2c0acf163265fff32"></a><!-- doxytag: member="mysqlpp::Date::compare" ref="bfc9a7c6d530b3f2c0acf163265fff32" args="(const Date &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mysqlpp::Date::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmysqlpp_1_1Date.html">Date</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compare this date to another.
<p>
Returns < 0 if this date is before the other, 0 of they are equal, and > 0 if this date is after the other.
</div>
</div><p>
<a class="anchor" name="c4459512f44e69ad351265fa5a5a7ee7"></a><!-- doxytag: member="mysqlpp::Date::operator time_t" ref="c4459512f44e69ad351265fa5a5a7ee7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::Date::operator time_t </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convert to time_t.
<p>
The "time" part of the <code>time_t</code> is "now"
</div>
</div><p>
<a class="anchor" name="6c88fea71a585cfbc8de5d7226ad33b9"></a><!-- doxytag: member="mysqlpp::Date::year" ref="6c88fea71a585cfbc8de5d7226ad33b9" args="(unsigned short y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mysqlpp::Date::year </td>
<td>(</td>
<td class="paramtype">unsigned short </td>
<td class="paramname"> <em>y</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the date's year part.
<p>
Pass the year value normally; we don't optimize the value by subtracting 1900 like some other date implementations.
</div>
</div><p>
<a class="anchor" name="07aa052c28f582cc166c2ce826a02e3d"></a><!-- doxytag: member="mysqlpp::Date::year" ref="07aa052c28f582cc166c2ce826a02e3d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short mysqlpp::Date::year </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the date's year part.
<p>
There's no trickery here like in some date implementations where you have to add 1900 or something like that.
</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 Fri Feb 29 16:26:21 2008 for MySQL++ by
<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>
|
