A C++ DAL / ORM code generation framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

672 lines
38 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>WORM: WSql::WSqlRecord Class Reference</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="search/search.js"></script>
  9. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10. </head>
  11. <body onload='searchBox.OnSelectItem(0);'>
  12. <!-- Generated by Doxygen 1.7.3 -->
  13. <script type="text/javascript"><!--
  14. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  15. --></script>
  16. <script type="text/javascript">
  17. function hasClass(ele,cls) {
  18. return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
  19. }
  20. function addClass(ele,cls) {
  21. if (!this.hasClass(ele,cls)) ele.className += " "+cls;
  22. }
  23. function removeClass(ele,cls) {
  24. if (hasClass(ele,cls)) {
  25. var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
  26. ele.className=ele.className.replace(reg,' ');
  27. }
  28. }
  29. function toggleVisibility(linkObj) {
  30. var base = linkObj.getAttribute('id');
  31. var summary = document.getElementById(base + '-summary');
  32. var content = document.getElementById(base + '-content');
  33. var trigger = document.getElementById(base + '-trigger');
  34. if ( hasClass(linkObj,'closed') ) {
  35. summary.style.display = 'none';
  36. content.style.display = 'block';
  37. trigger.src = 'open.png';
  38. removeClass(linkObj,'closed');
  39. addClass(linkObj,'opened');
  40. } else if ( hasClass(linkObj,'opened') ) {
  41. summary.style.display = 'block';
  42. content.style.display = 'none';
  43. trigger.src = 'closed.png';
  44. removeClass(linkObj,'opened');
  45. addClass(linkObj,'closed');
  46. }
  47. return false;
  48. }
  49. </script>
  50. <div id="top">
  51. <div id="titlearea">
  52. <table cellspacing="0" cellpadding="0">
  53. <tbody>
  54. <tr style="height: 56px;">
  55. <td id="projectlogo"><img alt="Logo" src="worm_sm.png"></td>
  56. <td style="padding-left: 0.5em;">
  57. <div id="projectname">WORM&#160;<span id="projectnumber">0.2</span></div>
  58. <div id="projectbrief">A C++ DAL/ORM code generation framework</div>
  59. </td>
  60. </tr>
  61. </tbody>
  62. </table>
  63. </div>
  64. <div id="navrow1" class="tabs">
  65. <ul class="tablist">
  66. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  67. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  68. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  69. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  70. <li><a href="files.html"><span>Files</span></a></li>
  71. <li id="searchli">
  72. <div id="MSearchBox" class="MSearchBoxInactive">
  73. <span class="left">
  74. <img id="MSearchSelect" src="search/mag_sel.png"
  75. onmouseover="return searchBox.OnSearchSelectShow()"
  76. onmouseout="return searchBox.OnSearchSelectHide()"
  77. alt=""/>
  78. <input type="text" id="MSearchField" value="Search" accesskey="S"
  79. onfocus="searchBox.OnSearchFieldFocus(true)"
  80. onblur="searchBox.OnSearchFieldFocus(false)"
  81. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  82. </span><span class="right">
  83. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  84. </span>
  85. </div>
  86. </li>
  87. </ul>
  88. </div>
  89. <div id="navrow2" class="tabs2">
  90. <ul class="tablist">
  91. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  92. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  93. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  94. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  95. </ul>
  96. </div>
  97. <div id="nav-path" class="navpath">
  98. <ul>
  99. <li class="navelem"><a class="el" href="namespace_w_sql.html">WSql</a> </li>
  100. <li class="navelem"><a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> </li>
  101. </ul>
  102. </div>
  103. </div>
  104. <div class="header">
  105. <div class="summary">
  106. <a href="#pub-methods">Public Member Functions</a> </div>
  107. <div class="headertitle">
  108. <h1>WSql::WSqlRecord Class Reference</h1> </div>
  109. </div>
  110. <div class="contents">
  111. <!-- doxytag: class="WSql::WSqlRecord" -->
  112. <p>The <a class="el" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> class represents a database record.
  113. <a href="#_details">More...</a></p>
  114. <p><code>#include &lt;<a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>&gt;</code></p>
  115. <p><a href="class_w_sql_1_1_w_sql_record-members.html">List of all members.</a></p>
  116. <table class="memberdecls">
  117. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  118. Public Member Functions</h2></td></tr>
  119. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a4716db4931210327d058e0be1092e37b">WSqlRecord</a> ()</td></tr>
  120. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a328f03b8b380a7336d3f717153dcd75c">WSqlRecord</a> (const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &amp;other)</td></tr>
  121. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a6908571d9d3a4305dd791e07dfc2e4eb">operator=</a> (const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &amp;other)</td></tr>
  122. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a4d225654e0fb640a88ba0062838d4447">~WSqlRecord</a> ()</td></tr>
  123. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#afed2c8e2bf71e773610fa57cc574b9a5">operator==</a> (const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &amp;other) const </td></tr>
  124. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#af14473620be2a96cb69b007edc69903d">operator!=</a> (const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &amp;other) const </td></tr>
  125. <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a5953463b769a1ccde83f556430e5159d">operator[]</a> (const std::string fieldname) const </td></tr>
  126. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator to return the data in field <em>fieldname</em> This operator allows for easy access to field data - for example: <a href="#a5953463b769a1ccde83f556430e5159d"></a><br/></td></tr>
  127. <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a28154b9bb9dfff22cf4c48f45113d303">operator[]</a> (const char *fieldname) const </td></tr>
  128. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a85bdf210bc04949c2e1a1c4dc086c87e">append</a> (<a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> field)</td></tr>
  129. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#af32612c3e051f7450538cd28c4fc0a2d">at</a> (int pos) const </td></tr>
  130. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a6b4afb8edabdf5643a56e293f87db609">field</a> (int pos) const </td></tr>
  131. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a554638cfe7ae6fbe746d92f9562e8754">field</a> (const std::string &amp;colname) const </td></tr>
  132. <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a59a5a0cab9e367cb3f80d7ff69c21584">data</a> (int pos) const </td></tr>
  133. <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a291e3e30f9aadca1dc68478426f2f248">data</a> (const std::string &amp;colname) const </td></tr>
  134. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#aefebaff2a8ac4f4a0bd25487eca230fb">isNull</a> (int i) const </td></tr>
  135. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a277d616c522bb856282ef5d1d5ee8978">isNull</a> (const std::string &amp;name) const </td></tr>
  136. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a36afa7bf1bd9c370b516c417ac7c2afc">indexOf</a> (const std::string &amp;name) const </td></tr>
  137. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#af61577cabef527cee9c50d14e7472d07">isValid</a> () const </td></tr>
  138. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a2953bb26d9c259a284353aba9cbd33da">empty</a> ()</td></tr>
  139. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#ab8901f9dda027740e651084084d9e617">size</a> () const </td></tr>
  140. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#aa807dec1b294186d17a550498b5aaf7f">count</a> () const </td></tr>
  141. <tr><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a6359bd78351e9ddb536114117c26890b">fields</a> () const </td></tr>
  142. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#ad55c83e8c1652f6acbe8ec077330b690">setNull</a> (int i)</td></tr>
  143. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#aa92f468442e5f4b55c8b30122f076431">setNull</a> (const std::string &amp;name)</td></tr>
  144. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a30877cd47a5bd04a02dbbe40a3ae6a55">clear</a> ()</td></tr>
  145. </table>
  146. <hr/><a name="_details"></a><h2>Detailed Description</h2>
  147. <div class="textblock"><p>The <a class="el" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> class represents a database record. </p>
  148. <p>The <a class="el" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> class represents a database record (AKA a "row") returned from a SELECT query as a vector of WSqlFields. <a class="el" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> supports adding and removing fields as well as setting and retrieving field names, data values and some metadata.</p>
  149. <p>The data values of a record's fields can be set by name or position with setData(). To find the position of a field by name use <a class="el" href="class_w_sql_1_1_w_sql_record.html#a36afa7bf1bd9c370b516c417ac7c2afc">indexOf()</a>, and to find the name of a field at a particular position use <a class="el" href="class_w_sql_1_1_w_sql_record.html#af32612c3e051f7450538cd28c4fc0a2d">at()</a>.name() Use <a class="el" href="class_w_sql_1_1_w_sql_record.html#a6b4afb8edabdf5643a56e293f87db609">field()</a> to retrieve a <a class="el" href="class_w_sql_1_1_w_sql_field.html" title="The WSqlField class represents a field in a record.">WSqlField</a> object for a field by name or position. To get a vector of all WSqlFields use <a class="el" href="class_w_sql_1_1_w_sql_record.html#a6359bd78351e9ddb536114117c26890b">fields()</a>.</p>
  150. <p>There are some convenience operators for getting the data from fields as well - operator[] supports fetching the data from a field by its name: </p>
  151. <div class="fragment"><pre class="fragment"> std::string fieldname = <span class="stringliteral">&quot;user_name&quot;</span>;
  152. std::string username = record[fieldname];
  153. </pre></div><p> This can also be used with plain const char* strings: </p>
  154. <div class="fragment"><pre class="fragment"> std::string username = record[<span class="stringliteral">&quot;user_name&quot;</span>];
  155. </pre></div><p>A record can have fields added with <a class="el" href="class_w_sql_1_1_w_sql_record.html#a85bdf210bc04949c2e1a1c4dc086c87e">append()</a> or insert(), replaced with replace(), and removed with remove(). All the fields can be removed with <a class="el" href="class_w_sql_1_1_w_sql_record.html#a30877cd47a5bd04a02dbbe40a3ae6a55">clear()</a>. The number of fields is given by <a class="el" href="class_w_sql_1_1_w_sql_record.html#aa807dec1b294186d17a550498b5aaf7f">count()</a>.</p>
  156. <p><a class="el" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> is used to populate a <a class="el" href="class_w_sql_1_1_w_sql_result.html" title="The WSqlResult class provides a representation of the result set from a query.">WSqlResult</a> set.</p>
  157. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_w_sql_1_1_w_sql_field.html" title="The WSqlField class represents a field in a record.">WSqlField</a> <a class="el" href="class_w_sql_1_1_w_sql_result.html" title="The WSqlResult class provides a representation of the result set from a query.">WSqlResult</a>. </dd></dl>
  158. <p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00030">30</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
  159. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  160. <a class="anchor" id="a4716db4931210327d058e0be1092e37b"></a><!-- doxytag: member="WSql::WSqlRecord::WSqlRecord" ref="a4716db4931210327d058e0be1092e37b" args="()" -->
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">WSql::WSqlRecord::WSqlRecord </td>
  166. <td>(</td>
  167. <td class="paramname"></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </div>
  172. <div class="memdoc">
  173. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00063">63</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  174. </div>
  175. </div>
  176. <a class="anchor" id="a328f03b8b380a7336d3f717153dcd75c"></a><!-- doxytag: member="WSql::WSqlRecord::WSqlRecord" ref="a328f03b8b380a7336d3f717153dcd75c" args="(const WSqlRecord &amp;other)" -->
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">WSql::WSqlRecord::WSqlRecord </td>
  182. <td>(</td>
  183. <td class="paramtype">const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &amp;&#160;</td>
  184. <td class="paramname"><em>other</em></td><td>)</td>
  185. <td></td>
  186. </tr>
  187. </table>
  188. </div>
  189. <div class="memdoc">
  190. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00068">68</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  191. </div>
  192. </div>
  193. <a class="anchor" id="a4d225654e0fb640a88ba0062838d4447"></a><!-- doxytag: member="WSql::WSqlRecord::~WSqlRecord" ref="a4d225654e0fb640a88ba0062838d4447" args="()" -->
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">WSql::WSqlRecord::~WSqlRecord </td>
  199. <td>(</td>
  200. <td class="paramname"></td><td>)</td>
  201. <td></td>
  202. </tr>
  203. </table>
  204. </div>
  205. <div class="memdoc">
  206. <p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000036">Todo:</a></b></dt><dd></dd></dl>
  207. </p>
  208. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00073">73</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  209. </div>
  210. </div>
  211. <hr/><h2>Member Function Documentation</h2>
  212. <a class="anchor" id="a85bdf210bc04949c2e1a1c4dc086c87e"></a><!-- doxytag: member="WSql::WSqlRecord::append" ref="a85bdf210bc04949c2e1a1c4dc086c87e" args="(WSqlField field)" -->
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">void WSql::WSqlRecord::append </td>
  218. <td>(</td>
  219. <td class="paramtype"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a>&#160;</td>
  220. <td class="paramname"><em>field</em></td><td>)</td>
  221. <td><code> [inline]</code></td>
  222. </tr>
  223. </table>
  224. </div>
  225. <div class="memdoc">
  226. <p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00043">43</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
  227. </div>
  228. </div>
  229. <a class="anchor" id="af32612c3e051f7450538cd28c4fc0a2d"></a><!-- doxytag: member="WSql::WSqlRecord::at" ref="af32612c3e051f7450538cd28c4fc0a2d" args="(int pos) const " -->
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> WSql::WSqlRecord::at </td>
  235. <td>(</td>
  236. <td class="paramtype">int&#160;</td>
  237. <td class="paramname"><em>pos</em></td><td>)</td>
  238. <td> const</td>
  239. </tr>
  240. </table>
  241. </div>
  242. <div class="memdoc">
  243. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00145">145</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  244. </div>
  245. </div>
  246. <a class="anchor" id="a30877cd47a5bd04a02dbbe40a3ae6a55"></a><!-- doxytag: member="WSql::WSqlRecord::clear" ref="a30877cd47a5bd04a02dbbe40a3ae6a55" args="()" -->
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">void WSql::WSqlRecord::clear </td>
  252. <td>(</td>
  253. <td class="paramname"></td><td>)</td>
  254. <td></td>
  255. </tr>
  256. </table>
  257. </div>
  258. <div class="memdoc">
  259. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00177">177</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  260. </div>
  261. </div>
  262. <a class="anchor" id="aa807dec1b294186d17a550498b5aaf7f"></a><!-- doxytag: member="WSql::WSqlRecord::count" ref="aa807dec1b294186d17a550498b5aaf7f" args="() const " -->
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname">int WSql::WSqlRecord::count </td>
  268. <td>(</td>
  269. <td class="paramname"></td><td>)</td>
  270. <td> const<code> [inline]</code></td>
  271. </tr>
  272. </table>
  273. </div>
  274. <div class="memdoc">
  275. <p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00056">56</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
  276. </div>
  277. </div>
  278. <a class="anchor" id="a59a5a0cab9e367cb3f80d7ff69c21584"></a><!-- doxytag: member="WSql::WSqlRecord::data" ref="a59a5a0cab9e367cb3f80d7ff69c21584" args="(int pos) const " -->
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="memname">
  282. <tr>
  283. <td class="memname">std::string WSql::WSqlRecord::data </td>
  284. <td>(</td>
  285. <td class="paramtype">int&#160;</td>
  286. <td class="paramname"><em>pos</em></td><td>)</td>
  287. <td> const</td>
  288. </tr>
  289. </table>
  290. </div>
  291. <div class="memdoc">
  292. <p>Returns the value of the field located at position <em>index</em> in the record. If <em>index</em> is out of bounds, an invalid <a class="el" href="class_w_sql_1_1_w_sql_datum.html" title="The WSqlDatum class represents an abstraction of a data element retrieved from a database.">WSqlDatum</a> is returned.</p>
  293. <dl class="see"><dt><b>See also:</b></dt><dd>fieldName() <a class="el" href="class_w_sql_1_1_w_sql_record.html#aefebaff2a8ac4f4a0bd25487eca230fb">isNull()</a> </dd></dl>
  294. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00113">113</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  295. </div>
  296. </div>
  297. <a class="anchor" id="a291e3e30f9aadca1dc68478426f2f248"></a><!-- doxytag: member="WSql::WSqlRecord::data" ref="a291e3e30f9aadca1dc68478426f2f248" args="(const std::string &amp;colname) const " -->
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname">std::string WSql::WSqlRecord::data </td>
  303. <td>(</td>
  304. <td class="paramtype">const std::string &amp;&#160;</td>
  305. <td class="paramname"><em>colname</em></td><td>)</td>
  306. <td> const</td>
  307. </tr>
  308. </table>
  309. </div>
  310. <div class="memdoc">
  311. <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns the value of the field called <em>name</em> in the record. If field <em>name</em> does not exist an invalid <a class="el" href="class_w_sql_1_1_w_sql_datum.html" title="The WSqlDatum class represents an abstraction of a data element retrieved from a database.">WSqlDatum</a> is returned.</p>
  312. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_w_sql_1_1_w_sql_record.html#a36afa7bf1bd9c370b516c417ac7c2afc">indexOf()</a> </dd></dl>
  313. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00126">126</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  314. </div>
  315. </div>
  316. <a class="anchor" id="a2953bb26d9c259a284353aba9cbd33da"></a><!-- doxytag: member="WSql::WSqlRecord::empty" ref="a2953bb26d9c259a284353aba9cbd33da" args="()" -->
  317. <div class="memitem">
  318. <div class="memproto">
  319. <table class="memname">
  320. <tr>
  321. <td class="memname">bool WSql::WSqlRecord::empty </td>
  322. <td>(</td>
  323. <td class="paramname"></td><td>)</td>
  324. <td><code> [inline]</code></td>
  325. </tr>
  326. </table>
  327. </div>
  328. <div class="memdoc">
  329. <p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00054">54</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
  330. </div>
  331. </div>
  332. <a class="anchor" id="a554638cfe7ae6fbe746d92f9562e8754"></a><!-- doxytag: member="WSql::WSqlRecord::field" ref="a554638cfe7ae6fbe746d92f9562e8754" args="(const std::string &amp;colname) const " -->
  333. <div class="memitem">
  334. <div class="memproto">
  335. <table class="memname">
  336. <tr>
  337. <td class="memname"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> WSql::WSqlRecord::field </td>
  338. <td>(</td>
  339. <td class="paramtype">const std::string &amp;&#160;</td>
  340. <td class="paramname"><em>colname</em></td><td>)</td>
  341. <td> const</td>
  342. </tr>
  343. </table>
  344. </div>
  345. <div class="memdoc">
  346. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00153">153</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  347. </div>
  348. </div>
  349. <a class="anchor" id="a6b4afb8edabdf5643a56e293f87db609"></a><!-- doxytag: member="WSql::WSqlRecord::field" ref="a6b4afb8edabdf5643a56e293f87db609" args="(int pos) const " -->
  350. <div class="memitem">
  351. <div class="memproto">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> WSql::WSqlRecord::field </td>
  355. <td>(</td>
  356. <td class="paramtype">int&#160;</td>
  357. <td class="paramname"><em>pos</em></td><td>)</td>
  358. <td> const</td>
  359. </tr>
  360. </table>
  361. </div>
  362. <div class="memdoc">
  363. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00140">140</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  364. </div>
  365. </div>
  366. <a class="anchor" id="a6359bd78351e9ddb536114117c26890b"></a><!-- doxytag: member="WSql::WSqlRecord::fields" ref="a6359bd78351e9ddb536114117c26890b" args="() const " -->
  367. <div class="memitem">
  368. <div class="memproto">
  369. <table class="memname">
  370. <tr>
  371. <td class="memname">const std::vector&lt;<a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a>&gt;&amp; WSql::WSqlRecord::fields </td>
  372. <td>(</td>
  373. <td class="paramname"></td><td>)</td>
  374. <td> const<code> [inline]</code></td>
  375. </tr>
  376. </table>
  377. </div>
  378. <div class="memdoc">
  379. <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000038">Todo:</a></b></dt><dd>THIS maybe should be const std::vector&lt;WSqlField *&gt;&amp; <a class="el" href="class_w_sql_1_1_w_sql_record.html#a6359bd78351e9ddb536114117c26890b">fields() const </a>{return _fields;}; </dd></dl>
  380. <p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00060">60</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
  381. </div>
  382. </div>
  383. <a class="anchor" id="a36afa7bf1bd9c370b516c417ac7c2afc"></a><!-- doxytag: member="WSql::WSqlRecord::indexOf" ref="a36afa7bf1bd9c370b516c417ac7c2afc" args="(const std::string &amp;name) const " -->
  384. <div class="memitem">
  385. <div class="memproto">
  386. <table class="memname">
  387. <tr>
  388. <td class="memname">int WSql::WSqlRecord::indexOf </td>
  389. <td>(</td>
  390. <td class="paramtype">const std::string &amp;&#160;</td>
  391. <td class="paramname"><em>name</em></td><td>)</td>
  392. <td> const</td>
  393. </tr>
  394. </table>
  395. </div>
  396. <div class="memdoc">
  397. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00158">158</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  398. </div>
  399. </div>
  400. <a class="anchor" id="a277d616c522bb856282ef5d1d5ee8978"></a><!-- doxytag: member="WSql::WSqlRecord::isNull" ref="a277d616c522bb856282ef5d1d5ee8978" args="(const std::string &amp;name) const " -->
  401. <div class="memitem">
  402. <div class="memproto">
  403. <table class="memname">
  404. <tr>
  405. <td class="memname">bool WSql::WSqlRecord::isNull </td>
  406. <td>(</td>
  407. <td class="paramtype">const std::string &amp;&#160;</td>
  408. <td class="paramname"><em>name</em></td><td>)</td>
  409. <td> const</td>
  410. </tr>
  411. </table>
  412. </div>
  413. <div class="memdoc">
  414. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00131">131</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  415. </div>
  416. </div>
  417. <a class="anchor" id="aefebaff2a8ac4f4a0bd25487eca230fb"></a><!-- doxytag: member="WSql::WSqlRecord::isNull" ref="aefebaff2a8ac4f4a0bd25487eca230fb" args="(int i) const " -->
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="memname">
  421. <tr>
  422. <td class="memname">bool WSql::WSqlRecord::isNull </td>
  423. <td>(</td>
  424. <td class="paramtype">int&#160;</td>
  425. <td class="paramname"><em>i</em></td><td>)</td>
  426. <td> const</td>
  427. </tr>
  428. </table>
  429. </div>
  430. <div class="memdoc">
  431. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00135">135</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  432. </div>
  433. </div>
  434. <a class="anchor" id="af61577cabef527cee9c50d14e7472d07"></a><!-- doxytag: member="WSql::WSqlRecord::isValid" ref="af61577cabef527cee9c50d14e7472d07" args="() const " -->
  435. <div class="memitem">
  436. <div class="memproto">
  437. <table class="memname">
  438. <tr>
  439. <td class="memname">bool WSql::WSqlRecord::isValid </td>
  440. <td>(</td>
  441. <td class="paramname"></td><td>)</td>
  442. <td> const<code> [inline]</code></td>
  443. </tr>
  444. </table>
  445. </div>
  446. <div class="memdoc">
  447. <p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00053">53</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
  448. </div>
  449. </div>
  450. <a class="anchor" id="af14473620be2a96cb69b007edc69903d"></a><!-- doxytag: member="WSql::WSqlRecord::operator!=" ref="af14473620be2a96cb69b007edc69903d" args="(const WSqlRecord &amp;other) const " -->
  451. <div class="memitem">
  452. <div class="memproto">
  453. <table class="memname">
  454. <tr>
  455. <td class="memname">bool WSql::WSqlRecord::operator!= </td>
  456. <td>(</td>
  457. <td class="paramtype">const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &amp;&#160;</td>
  458. <td class="paramname"><em>other</em></td><td>)</td>
  459. <td> const<code> [inline]</code></td>
  460. </tr>
  461. </table>
  462. </div>
  463. <div class="memdoc">
  464. <p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00039">39</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
  465. </div>
  466. </div>
  467. <a class="anchor" id="a6908571d9d3a4305dd791e07dfc2e4eb"></a><!-- doxytag: member="WSql::WSqlRecord::operator=" ref="a6908571d9d3a4305dd791e07dfc2e4eb" args="(const WSqlRecord &amp;other)" -->
  468. <div class="memitem">
  469. <div class="memproto">
  470. <table class="memname">
  471. <tr>
  472. <td class="memname"><a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &amp; WSql::WSqlRecord::operator= </td>
  473. <td>(</td>
  474. <td class="paramtype">const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &amp;&#160;</td>
  475. <td class="paramname"><em>other</em></td><td>)</td>
  476. <td></td>
  477. </tr>
  478. </table>
  479. </div>
  480. <div class="memdoc">
  481. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00078">78</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  482. </div>
  483. </div>
  484. <a class="anchor" id="afed2c8e2bf71e773610fa57cc574b9a5"></a><!-- doxytag: member="WSql::WSqlRecord::operator==" ref="afed2c8e2bf71e773610fa57cc574b9a5" args="(const WSqlRecord &amp;other) const " -->
  485. <div class="memitem">
  486. <div class="memproto">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname">bool WSql::WSqlRecord::operator== </td>
  490. <td>(</td>
  491. <td class="paramtype">const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &amp;&#160;</td>
  492. <td class="paramname"><em>other</em></td><td>)</td>
  493. <td> const</td>
  494. </tr>
  495. </table>
  496. </div>
  497. <div class="memdoc">
  498. <p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000037">Todo:</a></b></dt><dd></dd></dl>
  499. </p>
  500. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00084">84</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  501. </div>
  502. </div>
  503. <a class="anchor" id="a5953463b769a1ccde83f556430e5159d"></a><!-- doxytag: member="WSql::WSqlRecord::operator[]" ref="a5953463b769a1ccde83f556430e5159d" args="(const std::string fieldname) const " -->
  504. <div class="memitem">
  505. <div class="memproto">
  506. <table class="memname">
  507. <tr>
  508. <td class="memname">std::string WSql::WSqlRecord::operator[] </td>
  509. <td>(</td>
  510. <td class="paramtype">const std::string&#160;</td>
  511. <td class="paramname"><em>fieldname</em></td><td>)</td>
  512. <td> const<code> [inline]</code></td>
  513. </tr>
  514. </table>
  515. </div>
  516. <div class="memdoc">
  517. <p>Operator to return the data in field <em>fieldname</em> This operator allows for easy access to field data - for example: </p>
  518. <div class="fragment"><pre class="fragment"> std::string username = record[std::string(<span class="stringliteral">&quot;user_name&quot;</span>)];
  519. </pre></div>
  520. <p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00040">40</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
  521. </div>
  522. </div>
  523. <a class="anchor" id="a28154b9bb9dfff22cf4c48f45113d303"></a><!-- doxytag: member="WSql::WSqlRecord::operator[]" ref="a28154b9bb9dfff22cf4c48f45113d303" args="(const char *fieldname) const " -->
  524. <div class="memitem">
  525. <div class="memproto">
  526. <table class="memname">
  527. <tr>
  528. <td class="memname">std::string WSql::WSqlRecord::operator[] </td>
  529. <td>(</td>
  530. <td class="paramtype">const char *&#160;</td>
  531. <td class="paramname"><em>fieldname</em></td><td>)</td>
  532. <td> const<code> [inline]</code></td>
  533. </tr>
  534. </table>
  535. </div>
  536. <div class="memdoc">
  537. <p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00041">41</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
  538. </div>
  539. </div>
  540. <a class="anchor" id="aa92f468442e5f4b55c8b30122f076431"></a><!-- doxytag: member="WSql::WSqlRecord::setNull" ref="aa92f468442e5f4b55c8b30122f076431" args="(const std::string &amp;name)" -->
  541. <div class="memitem">
  542. <div class="memproto">
  543. <table class="memname">
  544. <tr>
  545. <td class="memname">void WSql::WSqlRecord::setNull </td>
  546. <td>(</td>
  547. <td class="paramtype">const std::string &amp;&#160;</td>
  548. <td class="paramname"><em>name</em></td><td>)</td>
  549. <td></td>
  550. </tr>
  551. </table>
  552. </div>
  553. <div class="memdoc">
  554. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00089">89</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  555. </div>
  556. </div>
  557. <a class="anchor" id="ad55c83e8c1652f6acbe8ec077330b690"></a><!-- doxytag: member="WSql::WSqlRecord::setNull" ref="ad55c83e8c1652f6acbe8ec077330b690" args="(int i)" -->
  558. <div class="memitem">
  559. <div class="memproto">
  560. <table class="memname">
  561. <tr>
  562. <td class="memname">void WSql::WSqlRecord::setNull </td>
  563. <td>(</td>
  564. <td class="paramtype">int&#160;</td>
  565. <td class="paramname"><em>i</em></td><td>)</td>
  566. <td></td>
  567. </tr>
  568. </table>
  569. </div>
  570. <div class="memdoc">
  571. <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000039">Todo:</a></b></dt><dd>template &lt;typename t&gt;=""&gt; void setData( T t, int pos ) { </dd></dl>
  572. <p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00093">93</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
  573. </div>
  574. </div>
  575. <a class="anchor" id="ab8901f9dda027740e651084084d9e617"></a><!-- doxytag: member="WSql::WSqlRecord::size" ref="ab8901f9dda027740e651084084d9e617" args="() const " -->
  576. <div class="memitem">
  577. <div class="memproto">
  578. <table class="memname">
  579. <tr>
  580. <td class="memname">int WSql::WSqlRecord::size </td>
  581. <td>(</td>
  582. <td class="paramname"></td><td>)</td>
  583. <td> const<code> [inline]</code></td>
  584. </tr>
  585. </table>
  586. </div>
  587. <div class="memdoc">
  588. <p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00055">55</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
  589. </div>
  590. </div>
  591. <hr/>The documentation for this class was generated from the following files:<ul>
  592. <li>src/sql/<a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a></li>
  593. <li>src/sql/<a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a></li>
  594. </ul>
  595. </div>
  596. <!--- window showing the filter options -->
  597. <div id="MSearchSelectWindow"
  598. onmouseover="return searchBox.OnSearchSelectShow()"
  599. onmouseout="return searchBox.OnSearchSelectHide()"
  600. onkeydown="return searchBox.OnSearchSelectKey(event)">
  601. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Defines</a></div>
  602. <!-- iframe showing the search results (closed by default) -->
  603. <div id="MSearchResultsWindow">
  604. <iframe src="" frameborder="0"
  605. name="MSearchResults" id="MSearchResults">
  606. </iframe>
  607. </div>
  608. <hr class="footer"/><address class="footer"><small>Generated on Fri Nov 18 2011 21:01:46 for WORM by&#160;
  609. <a href="http://www.doxygen.org/index.html">
  610. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
  611. </body>
  612. </html>