330 lines
16 KiB
HTML
330 lines
16 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>XQilla Simple API Documentation</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classResult-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Result Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A scoped pointer wrapper for the lazily evaluated query result.
|
|
<a href="classResult.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Result_8hpp_source.html">Result.hpp</a>></code></p>
|
|
<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:a232db797580b11fbe088d1f09b88d235"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#a232db797580b11fbe088d1f09b88d235">Result</a> (const <a class="el" href="classItem.html#a73b92c0cc87378a05bd46328eed7f4ff">Item::Ptr</a> &item)</td></tr>
|
|
<tr class="separator:a232db797580b11fbe088d1f09b88d235"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7bf9d370facffda6212c5d7cc96581d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#ae7bf9d370facffda6212c5d7cc96581d">Result</a> (const <a class="el" href="classSequence.html">Sequence</a> &seq)</td></tr>
|
|
<tr class="separator:ae7bf9d370facffda6212c5d7cc96581d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0607f6add337b54115bd14020ee30992"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#a0607f6add337b54115bd14020ee30992">Result</a> (<a class="el" href="classResultImpl.html">ResultImpl</a> *impl)</td></tr>
|
|
<tr class="separator:a0607f6add337b54115bd14020ee30992"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab143fa79281509e165f52a9ff913ecb0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#ab143fa79281509e165f52a9ff913ecb0">Result</a> (const <a class="el" href="classResult.html">Result</a> &o)</td></tr>
|
|
<tr class="separator:ab143fa79281509e165f52a9ff913ecb0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1631e003d243021ffc180997ebea2147"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classResult.html">Result</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#a1631e003d243021ffc180997ebea2147">operator=</a> (const <a class="el" href="classResult.html">Result</a> &o)</td></tr>
|
|
<tr class="separator:a1631e003d243021ffc180997ebea2147"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab83cf33a31236b3da75d66aaf9a05ed0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#ab83cf33a31236b3da75d66aaf9a05ed0">~Result</a> ()</td></tr>
|
|
<tr class="separator:ab83cf33a31236b3da75d66aaf9a05ed0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6cc161373ec2b58852f250c1b2c4091e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classResultImpl.html">ResultImpl</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#a6cc161373ec2b58852f250c1b2c4091e">operator-></a> ()</td></tr>
|
|
<tr class="memdesc:a6cc161373ec2b58852f250c1b2c4091e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result. ">ResultImpl</a> object. <a href="#a6cc161373ec2b58852f250c1b2c4091e">More...</a><br/></td></tr>
|
|
<tr class="separator:a6cc161373ec2b58852f250c1b2c4091e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3218a8e3d12a7d37885711bfb285960c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classResultImpl.html">ResultImpl</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#a3218a8e3d12a7d37885711bfb285960c">operator-></a> () const </td></tr>
|
|
<tr class="memdesc:a3218a8e3d12a7d37885711bfb285960c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result. ">ResultImpl</a> object. <a href="#a3218a8e3d12a7d37885711bfb285960c">More...</a><br/></td></tr>
|
|
<tr class="separator:a3218a8e3d12a7d37885711bfb285960c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98858dfc452cee5c5197bd957f9c0715"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classResultImpl.html">ResultImpl</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#a98858dfc452cee5c5197bd957f9c0715">get</a> ()</td></tr>
|
|
<tr class="memdesc:a98858dfc452cee5c5197bd957f9c0715"><td class="mdescLeft"> </td><td class="mdescRight">Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result. ">ResultImpl</a> object. <a href="#a98858dfc452cee5c5197bd957f9c0715">More...</a><br/></td></tr>
|
|
<tr class="separator:a98858dfc452cee5c5197bd957f9c0715"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad699b382cbc38d188036f61bc54754e2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classResultImpl.html">ResultImpl</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#ad699b382cbc38d188036f61bc54754e2">get</a> () const </td></tr>
|
|
<tr class="memdesc:ad699b382cbc38d188036f61bc54754e2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result. ">ResultImpl</a> object. <a href="#ad699b382cbc38d188036f61bc54754e2">More...</a><br/></td></tr>
|
|
<tr class="separator:ad699b382cbc38d188036f61bc54754e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb0e13d1fd84752d4dd4f1c250442383"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#afb0e13d1fd84752d4dd4f1c250442383">isNull</a> () const </td></tr>
|
|
<tr class="memdesc:afb0e13d1fd84752d4dd4f1c250442383"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the underlying pointer is null. <a href="#afb0e13d1fd84752d4dd4f1c250442383">More...</a><br/></td></tr>
|
|
<tr class="separator:afb0e13d1fd84752d4dd4f1c250442383"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d33d5326a611a9b1cd9e1c9f908bdb1"><td class="memItemLeft" align="right" valign="top">EmptyResult * </td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#a1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty</a> () const </td></tr>
|
|
<tr class="separator:a1d33d5326a611a9b1cd9e1c9f908bdb1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A scoped pointer wrapper for the lazily evaluated query result. </p>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="simple-basic_8cpp-example.html#_a3">simple-basic.cpp</a>, and <a class="el" href="simple-context-item_8cpp-example.html#_a4">simple-context-item.cpp</a>.</dd>
|
|
</dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a232db797580b11fbe088d1f09b88d235"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Result::Result </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classItem.html#a73b92c0cc87378a05bd46328eed7f4ff">Item::Ptr</a> & </td>
|
|
<td class="paramname"><em>item</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae7bf9d370facffda6212c5d7cc96581d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Result::Result </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classSequence.html">Sequence</a> & </td>
|
|
<td class="paramname"><em>seq</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0607f6add337b54115bd14020ee30992"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Result::Result </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classResultImpl.html">ResultImpl</a> * </td>
|
|
<td class="paramname"><em>impl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab143fa79281509e165f52a9ff913ecb0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Result::Result </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classResult.html">Result</a> & </td>
|
|
<td class="paramname"><em>o</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab83cf33a31236b3da75d66aaf9a05ed0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Result::~Result </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a98858dfc452cee5c5197bd957f9c0715"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classResultImpl.html">ResultImpl</a> * Result::get </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result. ">ResultImpl</a> object. </p>
|
|
|
|
<p>References <a class="el" href="classResult.html#a1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad699b382cbc38d188036f61bc54754e2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classResultImpl.html">ResultImpl</a> * Result::get </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result. ">ResultImpl</a> object. </p>
|
|
|
|
<p>References <a class="el" href="classResult.html#a1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1d33d5326a611a9b1cd9e1c9f908bdb1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">EmptyResult* Result::getEmpty </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Referenced by <a class="el" href="classResult.html#a98858dfc452cee5c5197bd957f9c0715">get()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afb0e13d1fd84752d4dd4f1c250442383"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Result::isNull </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if the underlying pointer is null. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6cc161373ec2b58852f250c1b2c4091e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classResultImpl.html">ResultImpl</a> * Result::operator-> </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result. ">ResultImpl</a> object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3218a8e3d12a7d37885711bfb285960c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classResultImpl.html">ResultImpl</a> * Result::operator-> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result. ">ResultImpl</a> object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1631e003d243021ffc180997ebea2147"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classResult.html">Result</a>& Result::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classResult.html">Result</a> & </td>
|
|
<td class="paramname"><em>o</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Result_8hpp_source.html">Result.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|