mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/simple-api/classResult.html
King_DuckZ 4bc0157dcd v2.2.0
2020-02-17 22:17:06 +01:00

331 lines
15 KiB
HTML
Raw Blame History

<!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&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.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 class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<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>
<div class="contents">
<h1>Result Class Reference</h1><!-- doxytag: class="Result" -->A scoped pointer wrapper for the lazily evaluated query result.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Result_8hpp-source.html">Result.hpp</a>&gt;</code>
<p>
<p>
<a href="classResult-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="classResult.html#232db797580b11fbe088d1f09b88d235">Result</a> (const <a class="el" href="classRefCountPointer.html">Item::Ptr</a> &amp;item)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#e7bf9d370facffda6212c5d7cc96581d">Result</a> (const <a class="el" href="classSequence.html">Sequence</a> &amp;seq)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#0607f6add337b54115bd14020ee30992">Result</a> (<a class="el" href="classResultImpl.html">ResultImpl</a> *impl)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#b143fa79281509e165f52a9ff913ecb0">Result</a> (const <a class="el" href="classResult.html">Result</a> &amp;o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classResult.html">Result</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#1631e003d243021ffc180997ebea2147">operator=</a> (const <a class="el" href="classResult.html">Result</a> &amp;o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#b83cf33a31236b3da75d66aaf9a05ed0">~Result</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classResultImpl.html">ResultImpl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#6cc161373ec2b58852f250c1b2c4091e">operator-&gt;</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> object. <a href="#6cc161373ec2b58852f250c1b2c4091e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classResultImpl.html">ResultImpl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#3218a8e3d12a7d37885711bfb285960c">operator-&gt;</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> object. <a href="#3218a8e3d12a7d37885711bfb285960c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classResultImpl.html">ResultImpl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#98858dfc452cee5c5197bd957f9c0715">get</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> object. <a href="#98858dfc452cee5c5197bd957f9c0715"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classResultImpl.html">ResultImpl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#d699b382cbc38d188036f61bc54754e2">get</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> object. <a href="#d699b382cbc38d188036f61bc54754e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#fb0e13d1fd84752d4dd4f1c250442383">isNull</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the underlying pointer is null. <a href="#fb0e13d1fd84752d4dd4f1c250442383"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">EmptyResult *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty</a> () const </td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A scoped pointer wrapper for the lazily evaluated query result. <dl compact><dt><b>Examples: </b></dt><dd>
<p>
<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>.</dl><hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="232db797580b11fbe088d1f09b88d235"></a><!-- doxytag: member="Result::Result" ref="232db797580b11fbe088d1f09b88d235" args="(const Item::Ptr &amp;item)" -->
<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="classRefCountPointer.html">Item::Ptr</a> &amp;&nbsp;</td>
<td class="paramname"> <em>item</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e7bf9d370facffda6212c5d7cc96581d"></a><!-- doxytag: member="Result::Result" ref="e7bf9d370facffda6212c5d7cc96581d" args="(const Sequence &amp;seq)" -->
<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> &amp;&nbsp;</td>
<td class="paramname"> <em>seq</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0607f6add337b54115bd14020ee30992"></a><!-- doxytag: member="Result::Result" ref="0607f6add337b54115bd14020ee30992" args="(ResultImpl *impl)" -->
<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> *&nbsp;</td>
<td class="paramname"> <em>impl</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b143fa79281509e165f52a9ff913ecb0"></a><!-- doxytag: member="Result::Result" ref="b143fa79281509e165f52a9ff913ecb0" args="(const Result &amp;o)" -->
<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> &amp;&nbsp;</td>
<td class="paramname"> <em>o</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b83cf33a31236b3da75d66aaf9a05ed0"></a><!-- doxytag: member="Result::~Result" ref="b83cf33a31236b3da75d66aaf9a05ed0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Result::~Result </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1631e003d243021ffc180997ebea2147"></a><!-- doxytag: member="Result::operator=" ref="1631e003d243021ffc180997ebea2147" args="(const Result &amp;o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classResult.html">Result</a>&amp; Result::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classResult.html">Result</a> &amp;&nbsp;</td>
<td class="paramname"> <em>o</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="6cc161373ec2b58852f250c1b2c4091e"></a><!-- doxytag: member="Result::operator-&gt;" ref="6cc161373ec2b58852f250c1b2c4091e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classResultImpl.html">ResultImpl</a> * Result::operator-&gt; </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></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><p>
<a class="anchor" name="3218a8e3d12a7d37885711bfb285960c"></a><!-- doxytag: member="Result::operator-&gt;" ref="3218a8e3d12a7d37885711bfb285960c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classResultImpl.html">ResultImpl</a> * Result::operator-&gt; </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></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><p>
<a class="anchor" name="98858dfc452cee5c5197bd957f9c0715"></a><!-- doxytag: member="Result::get" ref="98858dfc452cee5c5197bd957f9c0715" args="()" -->
<div class="memitem">
<div class="memproto">
<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>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></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#1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty()</a>.</p>
</div>
</div><p>
<a class="anchor" name="d699b382cbc38d188036f61bc54754e2"></a><!-- doxytag: member="Result::get" ref="d699b382cbc38d188036f61bc54754e2" args="() const " -->
<div class="memitem">
<div class="memproto">
<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>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></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#1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty()</a>.</p>
</div>
</div><p>
<a class="anchor" name="fb0e13d1fd84752d4dd4f1c250442383"></a><!-- doxytag: member="Result::isNull" ref="fb0e13d1fd84752d4dd4f1c250442383" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Result::isNull </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the underlying pointer is null.
<p>
</div>
</div><p>
<a class="anchor" name="1d33d5326a611a9b1cd9e1c9f908bdb1"></a><!-- doxytag: member="Result::getEmpty" ref="1d33d5326a611a9b1cd9e1c9f908bdb1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EmptyResult* Result::getEmpty </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="Result_8hpp-source.html#l00077">get()</a>.</p>
</div>
</div><p>
<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></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:54:24 2009 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink