XQuilla/docs/simple-api/classResult.html

297 lines
14 KiB
HTML
Raw Normal View History

2020-02-17 22:05:20 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
2020-02-17 22:11:31 +01:00
<title>XQilla Simple API Documentation</title>
2020-02-17 22:05:20 +01:00
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
2020-02-17 22:11:31 +01:00
<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>
2020-02-17 22:23:16 +01:00
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
2020-02-17 22:19:57 +01:00
<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>
2020-02-17 22:23:16 +01:00
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</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>
2020-02-17 22:19:57 +01:00
</ul>
</div>
</div>
<div class="contents">
2020-02-17 22:23:16 +01:00
<h1>Result Class Reference</h1><!-- doxytag: class="Result" -->
2020-02-17 22:19:57 +01:00
<p>A scoped pointer wrapper for the lazily evaluated query result.
<a href="#_details">More...</a></p>
2020-02-17 22:11:31 +01:00
2020-02-17 22:19:57 +01:00
<p><code>#include &lt;<a class="el" href="Result_8hpp_source.html">Result.hpp</a>&gt;</code></p>
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
<p><a href="classResult-members.html">List of all members.</a></p>
2020-02-17 22:23:16 +01:00
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#a232db797580b11fbe088d1f09b88d235">Result</a> (const <a class="el" href="classRefCountPointer.html">Item::Ptr</a> &amp;item)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#ae7bf9d370facffda6212c5d7cc96581d">Result</a> (const <a class="el" href="classSequence.html">Sequence</a> &amp;seq)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</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><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#ab143fa79281509e165f52a9ff913ecb0">Result</a> (const <a class="el" href="classResult.html">Result</a> &amp;o)</td></tr>
<tr><td class="memItemLeft" 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#a1631e003d243021ffc180997ebea2147">operator=</a> (const <a class="el" href="classResult.html">Result</a> &amp;o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#ab83cf33a31236b3da75d66aaf9a05ed0">~Result</a> ()</td></tr>
<tr><td class="memItemLeft" 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#a6cc161373ec2b58852f250c1b2c4091e">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="#a6cc161373ec2b58852f250c1b2c4091e"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#a3218a8e3d12a7d37885711bfb285960c">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="#a3218a8e3d12a7d37885711bfb285960c"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#a98858dfc452cee5c5197bd957f9c0715">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="#a98858dfc452cee5c5197bd957f9c0715"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#ad699b382cbc38d188036f61bc54754e2">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="#ad699b382cbc38d188036f61bc54754e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#afb0e13d1fd84752d4dd4f1c250442383">isNull</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the underlying pointer is null. <a href="#afb0e13d1fd84752d4dd4f1c250442383"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EmptyResult *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResult.html#a1d33d5326a611a9b1cd9e1c9f908bdb1">getEmpty</a> () const </td></tr>
2020-02-17 22:05:20 +01:00
</table>
2020-02-17 22:19:57 +01:00
<hr/><a name="_details"></a><h2>Detailed Description</h2>
2020-02-17 22:23:16 +01:00
<p>A scoped pointer wrapper for the lazily evaluated query result. </p>
2020-02-17 22:19:57 +01:00
<dl><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>.</p>
</dd>
2020-02-17 22:23:16 +01:00
</dl><hr/><h2>Constructor &amp; Destructor Documentation</h2>
2020-02-17 22:19:57 +01:00
<a class="anchor" id="a232db797580b11fbe088d1f09b88d235"></a><!-- doxytag: member="Result::Result" ref="a232db797580b11fbe088d1f09b88d235" args="(const Item::Ptr &amp;item)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:11:31 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">Result::Result </td>
<td>(</td>
2020-02-17 22:23:16 +01:00
<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>
2020-02-17 22:19:57 +01:00
<td></td>
2020-02-17 22:11:31 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:11:31 +01:00
2020-02-17 22:19:57 +01:00
</div>
</div>
<a class="anchor" id="ae7bf9d370facffda6212c5d7cc96581d"></a><!-- doxytag: member="Result::Result" ref="ae7bf9d370facffda6212c5d7cc96581d" args="(const Sequence &amp;seq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">Result::Result </td>
<td>(</td>
2020-02-17 22:23:16 +01:00
<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>
2020-02-17 22:19:57 +01:00
<td></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
</div>
</div>
<a class="anchor" id="a0607f6add337b54115bd14020ee30992"></a><!-- doxytag: member="Result::Result" ref="a0607f6add337b54115bd14020ee30992" args="(ResultImpl *impl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">Result::Result </td>
<td>(</td>
2020-02-17 22:23:16 +01:00
<td class="paramtype"><a class="el" href="classResultImpl.html">ResultImpl</a> *&nbsp;</td>
<td class="paramname"> <em>impl</em></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 22:19:57 +01:00
<td></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
</div>
</div>
<a class="anchor" id="ab143fa79281509e165f52a9ff913ecb0"></a><!-- doxytag: member="Result::Result" ref="ab143fa79281509e165f52a9ff913ecb0" args="(const Result &amp;o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">Result::Result </td>
<td>(</td>
2020-02-17 22:23:16 +01:00
<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>
2020-02-17 22:19:57 +01:00
<td></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
</div>
</div>
<a class="anchor" id="ab83cf33a31236b3da75d66aaf9a05ed0"></a><!-- doxytag: member="Result::~Result" ref="ab83cf33a31236b3da75d66aaf9a05ed0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">Result::~Result </td>
<td>(</td>
2020-02-17 22:23:16 +01:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 22:19:57 +01:00
<td></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
2020-02-17 22:23:16 +01:00
<a class="anchor" id="ad699b382cbc38d188036f61bc54754e2"></a><!-- doxytag: member="Result::get" ref="ad699b382cbc38d188036f61bc54754e2" args="() const " -->
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:23:16 +01:00
<td class="memname">const <a class="el" href="classResultImpl.html">ResultImpl</a> * Result::get </td>
2020-02-17 22:19:57 +01:00
<td>(</td>
2020-02-17 22:23:16 +01:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
<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>
2020-02-17 22:23:16 +01:00
<a class="anchor" id="a98858dfc452cee5c5197bd957f9c0715"></a><!-- doxytag: member="Result::get" ref="a98858dfc452cee5c5197bd957f9c0715" args="()" -->
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:23:16 +01:00
<td class="memname"><a class="el" href="classResultImpl.html">ResultImpl</a> * Result::get </td>
2020-02-17 22:19:57 +01:00
<td>(</td>
2020-02-17 22:23:16 +01:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
<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><!-- doxytag: member="Result::getEmpty" ref="a1d33d5326a611a9b1cd9e1c9f908bdb1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">EmptyResult* Result::getEmpty </td>
<td>(</td>
2020-02-17 22:23:16 +01:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 22:19:57 +01:00
<td> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:23:16 +01:00
<p>Referenced by <a class="el" href="Result_8hpp_source.html#l00075">get()</a>.</p>
2020-02-17 22:19:57 +01:00
</div>
</div>
<a class="anchor" id="afb0e13d1fd84752d4dd4f1c250442383"></a><!-- doxytag: member="Result::isNull" ref="afb0e13d1fd84752d4dd4f1c250442383" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">bool Result::isNull </td>
<td>(</td>
2020-02-17 22:23:16 +01:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 22:19:57 +01:00
<td> const<code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
<p>Returns true if the underlying pointer is null. </p>
</div>
</div>
2020-02-17 22:23:16 +01:00
<a class="anchor" id="a3218a8e3d12a7d37885711bfb285960c"></a><!-- doxytag: member="Result::operator&#45;&gt;" ref="a3218a8e3d12a7d37885711bfb285960c" args="() const " -->
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:23:16 +01:00
<td class="memname">const <a class="el" href="classResultImpl.html">ResultImpl</a> * Result::operator-&gt; </td>
2020-02-17 22:19:57 +01:00
<td>(</td>
2020-02-17 22:23:16 +01:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
<p>Returns the underlying <a class="el" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a> object. </p>
</div>
</div>
2020-02-17 22:23:16 +01:00
<a class="anchor" id="a6cc161373ec2b58852f250c1b2c4091e"></a><!-- doxytag: member="Result::operator&#45;&gt;" ref="a6cc161373ec2b58852f250c1b2c4091e" args="()" -->
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:23:16 +01:00
<td class="memname"><a class="el" href="classResultImpl.html">ResultImpl</a> * Result::operator-&gt; </td>
2020-02-17 22:19:57 +01:00
<td>(</td>
2020-02-17 22:23:16 +01:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
<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><!-- doxytag: member="Result::operator=" ref="a1631e003d243021ffc180997ebea2147" args="(const Result &amp;o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname"><a class="el" href="classResult.html">Result</a>&amp; Result::operator= </td>
<td>(</td>
2020-02-17 22:23:16 +01:00
<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>
2020-02-17 22:19:57 +01:00
<td></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
2020-02-17 22:19:57 +01:00
</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>
2020-02-17 22:24:17 +01:00
<hr size="1"/><address style="text-align: right;"><small>Generated on 18 May 2015 for XQilla Simple API by&nbsp;
2020-02-17 22:05:20 +01:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 22:23:16 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
2020-02-17 22:05:20 +01:00
</body>
</html>