File: classmysqlpp_1_1Comparable.html

package info (click to toggle)
mysql%2B%2B 3.2.5-2.3
  • links: PTS
  • area: main
  • in suites: forky, sid, trixie
  • size: 18,356 kB
  • sloc: cpp: 35,788; sh: 3,693; perl: 789; makefile: 728
file content (219 lines) | stat: -rwxr-xr-x 15,298 bytes parent folder | download | duplicates (3)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>MySQL++ Reference Manual</title>
  <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  <meta name="generator" content="Doxygen 1.8.15"/>
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <title>MySQL++: mysqlpp::Comparable&lt; T &gt; Class Template Reference</title>
  <link href="tabs.css" rel="stylesheet" type="text/css"/>
  <link href="doxygen.css" rel="stylesheet" type="text/css">
  <script type="text/javascript" src="jquery.js"></script>
  <script type="text/javascript" src="dynsections.js"></script>
  <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
  <link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
  <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    <div id="titlearea">
    <table cellspacing="0" cellpadding="0">
     <tbody>
     <tr style="height: 56px;">
      <td id="projectalign" style="padding-left: 0.5em;">
       <div id="projectname">MySQL++
       &#160;<span id="projectnumber">3.2.5</span>
       </div>
      </td>
     </tr>
     </tbody>
    </table>
    </div>
    <!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>mysqlpp</b></li><li class="navelem"><a class="el" href="classmysqlpp_1_1Comparable.html">Comparable</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classmysqlpp_1_1Comparable-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">mysqlpp::Comparable&lt; T &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Mix-in that gives its subclass a full set of comparison operators.  
 <a href="classmysqlpp_1_1Comparable.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="comparable_8h_source.html">comparable.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mysqlpp::Comparable&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classmysqlpp_1_1Comparable__inherit__graph.png" border="0" usemap="#mysqlpp_1_1Comparable_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="mysqlpp_1_1Comparable_3_01T_01_4_inherit__map" id="mysqlpp_1_1Comparable_3_01T_01_4_inherit__map">
<area shape="rect"  title="Mix&#45;in that gives its subclass a full set of comparison operators." alt="" coords="5,75,187,100"/>
<area shape="rect"  href="classmysqlpp_1_1Comparable.html" title=" " alt="" coords="319,5,470,44"/>
<area shape="rect"  href="classmysqlpp_1_1Comparable.html" title=" " alt="" coords="319,68,470,107"/>
<area shape="rect"  href="classmysqlpp_1_1Comparable.html" title=" " alt="" coords="319,131,470,169"/>
<area shape="rect"  href="classmysqlpp_1_1DateTime.html" title="C++ form of SQL&#39;s DATETIME type." alt="" coords="519,12,655,37"/>
<area shape="rect"  href="classmysqlpp_1_1Time.html" title="C++ form of SQL&#39;s TIME type." alt="" coords="533,75,641,100"/>
<area shape="rect"  href="classmysqlpp_1_1Date.html" title="C++ form of SQL&#39;s DATE type." alt="" coords="534,137,640,163"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1027c7512c91124faf9bc5458a7d8aba"><td class="memItemLeft" align="right" valign="top"><a id="a1027c7512c91124faf9bc5458a7d8aba"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Comparable.html#a1027c7512c91124faf9bc5458a7d8aba">operator==</a> (const T &amp;other) const</td></tr>
<tr class="memdesc:a1027c7512c91124faf9bc5458a7d8aba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if "other" is equal to this object. <br /></td></tr>
<tr class="separator:a1027c7512c91124faf9bc5458a7d8aba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae714f58e3d57fc462dc7b3f098e60a60"><td class="memItemLeft" align="right" valign="top"><a id="ae714f58e3d57fc462dc7b3f098e60a60"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Comparable.html#ae714f58e3d57fc462dc7b3f098e60a60">operator !=</a> (const T &amp;other) const</td></tr>
<tr class="memdesc:ae714f58e3d57fc462dc7b3f098e60a60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if "other" is not equal to this object. <br /></td></tr>
<tr class="separator:ae714f58e3d57fc462dc7b3f098e60a60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeedff722c69d1f025e2f93241ce24dfa"><td class="memItemLeft" align="right" valign="top"><a id="aeedff722c69d1f025e2f93241ce24dfa"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Comparable.html#aeedff722c69d1f025e2f93241ce24dfa">operator&lt;</a> (const T &amp;other) const</td></tr>
<tr class="memdesc:aeedff722c69d1f025e2f93241ce24dfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if "other" is less than this object. <br /></td></tr>
<tr class="separator:aeedff722c69d1f025e2f93241ce24dfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87d2453b99391154e1a5ece20ec6c046"><td class="memItemLeft" align="right" valign="top"><a id="a87d2453b99391154e1a5ece20ec6c046"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Comparable.html#a87d2453b99391154e1a5ece20ec6c046">operator&lt;=</a> (const T &amp;other) const</td></tr>
<tr class="memdesc:a87d2453b99391154e1a5ece20ec6c046"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if "other" is less than or equal to this object. <br /></td></tr>
<tr class="separator:a87d2453b99391154e1a5ece20ec6c046"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab8a8beaa3b4823a0ce07d31c9f2e083"><td class="memItemLeft" align="right" valign="top"><a id="aab8a8beaa3b4823a0ce07d31c9f2e083"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Comparable.html#aab8a8beaa3b4823a0ce07d31c9f2e083">operator &gt;</a> (const T &amp;other) const</td></tr>
<tr class="memdesc:aab8a8beaa3b4823a0ce07d31c9f2e083"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if "other" is greater than this object. <br /></td></tr>
<tr class="separator:aab8a8beaa3b4823a0ce07d31c9f2e083"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab62eaf4fc4096371177b35738ec76efe"><td class="memItemLeft" align="right" valign="top"><a id="ab62eaf4fc4096371177b35738ec76efe"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Comparable.html#ab62eaf4fc4096371177b35738ec76efe">operator &gt;=</a> (const T &amp;other) const</td></tr>
<tr class="memdesc:ab62eaf4fc4096371177b35738ec76efe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if "other" is greater than or equal to this object. <br /></td></tr>
<tr class="separator:ab62eaf4fc4096371177b35738ec76efe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a04f46aa0ee2ba5e0dcb6e3bd77a22f0f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Comparable.html#a04f46aa0ee2ba5e0dcb6e3bd77a22f0f">~Comparable</a> ()</td></tr>
<tr class="memdesc:a04f46aa0ee2ba5e0dcb6e3bd77a22f0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy object.  <a href="#a04f46aa0ee2ba5e0dcb6e3bd77a22f0f">More...</a><br /></td></tr>
<tr class="separator:a04f46aa0ee2ba5e0dcb6e3bd77a22f0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a189507426ed585f7da84f63dc426c651"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Comparable.html#a189507426ed585f7da84f63dc426c651">compare</a> (const T &amp;other) const =0</td></tr>
<tr class="memdesc:a189507426ed585f7da84f63dc426c651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare this object to another of the same type.  <a href="#a189507426ed585f7da84f63dc426c651">More...</a><br /></td></tr>
<tr class="separator:a189507426ed585f7da84f63dc426c651"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T&gt;<br />
class mysqlpp::Comparable&lt; T &gt;</h3>

<p>Mix-in that gives its subclass a full set of comparison operators. </p>
<p>Simply by inheriting publically from this and implementing <a class="el" href="classmysqlpp_1_1Comparable.html#a189507426ed585f7da84f63dc426c651" title="Compare this object to another of the same type.">compare()</a>, the subclass gains a full set of comparison operators, because all of the operators are implemented in terms of <a class="el" href="classmysqlpp_1_1Comparable.html#a189507426ed585f7da84f63dc426c651" title="Compare this object to another of the same type.">compare()</a>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a04f46aa0ee2ba5e0dcb6e3bd77a22f0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04f46aa0ee2ba5e0dcb6e3bd77a22f0f">&#9670;&nbsp;</a></span>~Comparable()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classmysqlpp_1_1Comparable.html">mysqlpp::Comparable</a>&lt; T &gt;::~<a class="el" href="classmysqlpp_1_1Comparable.html">Comparable</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destroy object. </p>
<p>This class has nothing to destroy, but declaring the dtor virtual placates some compilers set to high warning levels. Protecting it ensures you can't delete subclasses through base class pointers, which makes no sense because this class isn't made for polymorphism. It's just a mixin. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a189507426ed585f7da84f63dc426c651"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a189507426ed585f7da84f63dc426c651">&#9670;&nbsp;</a></span>compare()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual int <a class="el" href="classmysqlpp_1_1Comparable.html">mysqlpp::Comparable</a>&lt; T &gt;::compare </td>
          <td>(</td>
          <td class="paramtype">const T &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Compare this object to another of the same type. </p>
<p>Returns &lt; 0 if this object is "before" the other, 0 of they are equal, and &gt; 0 if this object is "after" the other. </p>

<p>Implemented in <a class="el" href="classmysqlpp_1_1Time.html#aded59e5685516ae30a7fbb16a1b670b2">mysqlpp::Time</a>, <a class="el" href="classmysqlpp_1_1Date.html#aa710b0fec0151ed558906edfa1ce6e63">mysqlpp::Date</a>, and <a class="el" href="classmysqlpp_1_1DateTime.html#aeb193c449b06d0c39085434576004085">mysqlpp::DateTime</a>.</p>

<p class="reference">Referenced by <a class="el" href="classmysqlpp_1_1Comparable.html#ae714f58e3d57fc462dc7b3f098e60a60">mysqlpp::Comparable&lt; Date &gt;::operator !=()</a>, <a class="el" href="classmysqlpp_1_1Comparable.html#aab8a8beaa3b4823a0ce07d31c9f2e083">mysqlpp::Comparable&lt; Date &gt;::operator &gt;()</a>, <a class="el" href="classmysqlpp_1_1Comparable.html#ab62eaf4fc4096371177b35738ec76efe">mysqlpp::Comparable&lt; Date &gt;::operator &gt;=()</a>, <a class="el" href="classmysqlpp_1_1Comparable.html#aeedff722c69d1f025e2f93241ce24dfa">mysqlpp::Comparable&lt; Date &gt;::operator&lt;()</a>, <a class="el" href="classmysqlpp_1_1Comparable.html#a87d2453b99391154e1a5ece20ec6c046">mysqlpp::Comparable&lt; Date &gt;::operator&lt;=()</a>, and <a class="el" href="classmysqlpp_1_1Comparable.html#a1027c7512c91124faf9bc5458a7d8aba">mysqlpp::Comparable&lt; Date &gt;::operator==()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="comparable_8h_source.html">comparable.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jul 21 2019 05:32:21 for MySQL++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>