File: structmysqlpp_1_1equal__list__ba.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 (138 lines) | stat: -rw-r--r-- 9,351 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
<!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="structmysqlpp_1_1equal__list__ba.html">equal_list_ba</a></div>
<h1>mysqlpp::equal_list_ba&lt; Seq1, Seq2, Manip &gt; Struct Template Reference</h1><!-- doxytag: class="mysqlpp::equal_list_ba" -->Holds two lists of items, typically used to construct a SQL "equals clause".  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="vallist_8h-source.html">vallist.h</a>&gt;</code>
<p>
Collaboration diagram for mysqlpp::equal_list_ba&lt; Seq1, Seq2, Manip &gt;:<p><center><img src="structmysqlpp_1_1equal__list__ba__coll__graph.png" border="0" usemap="#mysqlpp_1_1equal__list__ba_3_01Seq1_00_01Seq2_00_01Manip_01_4__coll__map" alt="Collaboration graph"></center>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="structmysqlpp_1_1equal__list__ba-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1equal__list__ba.html#2055acbb60e6d09362b8fb5194afca9a">equal_list_ba</a> (const Seq1 &amp;s1, const Seq2 &amp;s2, const char *d, const char *e, Manip m)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create object.  <a href="#2055acbb60e6d09362b8fb5194afca9a"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0307d8b613d4ea52c0d9eb19b462e12"></a><!-- doxytag: member="mysqlpp::equal_list_ba::list1" ref="f0307d8b613d4ea52c0d9eb19b462e12" args="" -->
const Seq1 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1equal__list__ba.html#f0307d8b613d4ea52c0d9eb19b462e12">list1</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the list of objects on the left-hand side of the equals sign <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="50b12dedeeba529383fd2ac61a566599"></a><!-- doxytag: member="mysqlpp::equal_list_ba::list2" ref="50b12dedeeba529383fd2ac61a566599" args="" -->
const Seq2 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1equal__list__ba.html#50b12dedeeba529383fd2ac61a566599">list2</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the list of objects on the right-hand side of the equals sign <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11cce071cfe6c26585602970e0eab481"></a><!-- doxytag: member="mysqlpp::equal_list_ba::delim" ref="11cce071cfe6c26585602970e0eab481" args="" -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1equal__list__ba.html#11cce071cfe6c26585602970e0eab481">delim</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">delimiter to use between each pair of elements <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f8c1b857897e584bd78c1a9f58439a7"></a><!-- doxytag: member="mysqlpp::equal_list_ba::equl" ref="5f8c1b857897e584bd78c1a9f58439a7" args="" -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1equal__list__ba.html#5f8c1b857897e584bd78c1a9f58439a7">equl</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">"equal" sign to use between each item in each equal pair; doesn't have to actually be " = " <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e80eca8a48261205c78b7f73f1aa8f17"></a><!-- doxytag: member="mysqlpp::equal_list_ba::manip" ref="e80eca8a48261205c78b7f73f1aa8f17" args="" -->
Manip&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1equal__list__ba.html#e80eca8a48261205c78b7f73f1aa8f17">manip</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">manipulator to use when inserting the equal_list into a C++ stream <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class Seq1, class Seq2, class Manip&gt;<br>
 struct mysqlpp::equal_list_ba&lt; Seq1, Seq2, Manip &gt;</h3>

Holds two lists of items, typically used to construct a SQL "equals clause". 
<p>
The WHERE clause in a SQL SELECT statment is an example of an equals clause.<p>
Imagine an object of this type contains the lists (a, b) (c, d), and that the object's delimiter and equals symbols are set to ", " and " = " respectively. When you insert that object into a C++ stream, you would get "a = c, b = d".<p>
This class is never instantiated by hand. The equal_list() functions build instances of this structure template to do their work. MySQL++'s SSQLS mechanism calls those functions when building SQL queries; you can call them yourself to do similar work. The "Harnessing SSQLS Internals" section of the user manual has some examples of this.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="structmysqlpp_1_1equal__list__b.html">equal_list_b</a> </dd></dl>

<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="2055acbb60e6d09362b8fb5194afca9a"></a><!-- doxytag: member="mysqlpp::equal_list_ba::equal_list_ba" ref="2055acbb60e6d09362b8fb5194afca9a" args="(const Seq1 &amp;s1, const Seq2 &amp;s2, const char *d, const char *e, Manip m)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Seq1, class Seq2, class Manip&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structmysqlpp_1_1equal__list__ba.html">mysqlpp::equal_list_ba</a>&lt; Seq1, Seq2, Manip &gt;::<a class="el" href="structmysqlpp_1_1equal__list__ba.html">equal_list_ba</a>           </td>
          <td>(</td>
          <td class="paramtype">const Seq1 &amp;&nbsp;</td>
          <td class="paramname"> <em>s1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Seq2 &amp;&nbsp;</td>
          <td class="paramname"> <em>s2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>d</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>e</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Manip&nbsp;</td>
          <td class="paramname"> <em>m</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create object. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>s1</em>&nbsp;</td><td>list of objects on left-hand side of equal sign </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>s2</em>&nbsp;</td><td>list of objects on right-hand side of equal sign </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>d</em>&nbsp;</td><td>what delimiter to use between each group in the list when inserting the list into a C++ stream </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>e</em>&nbsp;</td><td>the "equals" sign between each pair of items in the equal list; doesn't actually have to be " = "! </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>manipulator to use when inserting the list into a C++ stream </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="vallist_8h-source.html">vallist.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Feb 4 14:43:36 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>