XQuilla/docs/simple-api/classResultImpl.html

325 lines
14 KiB
HTML
Raw Normal View History

2020-02-17 22:11:31 +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">
<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>
2020-02-17 22:19:08 +01:00
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>ResultImpl Class Reference</h1>A lazily evaluated query result.
2020-02-17 22:11:31 +01:00
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ResultImpl_8hpp-source.html">ResultImpl.hpp</a>&gt;</code>
<p>
2020-02-17 22:19:08 +01:00
Inheritance diagram for ResultImpl:<p><center><img src="classResultImpl__inherit__graph.png" border="0" usemap="#ResultImpl__inherit__map" alt="Inheritance graph"></center>
2020-02-17 22:11:31 +01:00
<map name="ResultImpl__inherit__map">
2020-02-17 22:19:08 +01:00
<area href="classGenerateEventsResult.html" shape="rect" coords="5,156,160,180" alt="">
<area href="classLocationInfo.html" shape="rect" coords="125,7,219,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classResultImpl-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
2020-02-17 22:11:31 +01:00
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
2020-02-17 22:19:08 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a0">~ResultImpl</a> ()</td></tr>
2020-02-17 22:11:31 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classResult.html">Result</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a1">getResultPointer</a> ()</td></tr>
2020-02-17 22:11:31 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a2">setResultPointer</a> (<a class="el" href="classResult.html">Result</a> *p)</td></tr>
2020-02-17 22:11:31 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a3">next</a> (<a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
2020-02-17 22:11:31 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the next item from the iterator. Returns null if the is no next value. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a4">nextOrTail</a> (<a class="el" href="classResult.html">Result</a> &amp;tail, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
2020-02-17 22:11:31 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the next item, or returns a tail call <a class="el" href="classResult.html">Result</a> which will give the next item. <a href="#a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classSequence.html">Sequence</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a5">toSequence</a> (<a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
2020-02-17 22:11:31 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cast operator to a <a class="el" href="classSequence.html">Sequence</a>. Only works properly before <a class="el" href="classResultImpl.html#a3">next()</a> has been called. <a href="#a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ResultBufferImpl *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#a6">toResultBuffer</a> (unsigned int readCount)</td></tr>
2020-02-17 22:11:31 +01:00
2020-02-17 22:19:08 +01:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a result buffer of the result. <a href="#a6"></a><br></td></tr>
2020-02-17 22:11:31 +01:00
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
2020-02-17 22:19:08 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#b0">ResultImpl</a> (const <a class="el" href="classLocationInfo.html">LocationInfo</a> *o)</td></tr>
2020-02-17 22:11:31 +01:00
2020-02-17 22:17:06 +01:00
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
2020-02-17 22:19:08 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classResult.html">Result</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#p0">resultPointer_</a></td></tr>
2020-02-17 22:17:06 +01:00
2020-02-17 22:11:31 +01:00
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
2020-02-17 22:19:08 +01:00
A lazily evaluated query result.
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:19:08 +01:00
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="ResultImpl::~ResultImpl"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:11:31 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">virtual ResultImpl::~<a class="el" href="classResultImpl.html">ResultImpl</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
2020-02-17 22:11:31 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<a class="anchor" name="b0" doxytag="ResultImpl::ResultImpl"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:11:31 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">ResultImpl::ResultImpl </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>o</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [protected]</code></td>
2020-02-17 22:11:31 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1" doxytag="ResultImpl::getResultPointer"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:11:31 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top"><a class="el" href="classResult.html">Result</a>* ResultImpl::getResultPointer </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
2020-02-17 22:11:31 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="ResultImpl::next"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:11:31 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a> ResultImpl::next </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>context</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
2020-02-17 22:11:31 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:17:06 +01:00
Get the next item from the iterator. Returns null if the is no next value.
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="ResultImpl::nextOrTail"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:11:31 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a> ResultImpl::nextOrTail </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classResult.html">Result</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>tail</em>, </td>
2020-02-17 22:11:31 +01:00
</tr>
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>context</em></td>
2020-02-17 22:11:31 +01:00
</tr>
<tr>
2020-02-17 22:19:08 +01:00
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
2020-02-17 22:11:31 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:19:08 +01:00
Gets the next item, or returns a tail call <a class="el" href="classResult.html">Result</a> which will give the next item.
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:19:08 +01:00
<p>
Reimplemented in <a class="el" href="classGenerateEventsResult.html#a1">GenerateEventsResult</a>. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="ResultImpl::setResultPointer"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:11:31 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">void ResultImpl::setResultPointer </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classResult.html">Result</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>p</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
2020-02-17 22:11:31 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="ResultImpl::toResultBuffer"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:11:31 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top">virtual ResultBufferImpl* ResultImpl::toResultBuffer </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">unsigned int&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>readCount</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
2020-02-17 22:11:31 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:17:06 +01:00
Returns a result buffer of the result.
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="ResultImpl::toSequence"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classSequence.html">Sequence</a> ResultImpl::toSequence </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>context</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:11:31 +01:00
2020-02-17 22:19:08 +01:00
<p>
Cast operator to a <a class="el" href="classSequence.html">Sequence</a>. Only works properly before <a class="el" href="classResultImpl.html#a3">next()</a> has been called.
<p>
</td>
</tr>
</table>
2020-02-17 22:17:06 +01:00
<hr><h2>Member Data Documentation</h2>
2020-02-17 22:19:08 +01:00
<a class="anchor" name="p0" doxytag="ResultImpl::resultPointer_"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 22:11:31 +01:00
<tr>
2020-02-17 22:19:08 +01:00
<td class="md" nowrap valign="top"><a class="el" href="classResult.html">Result</a>* <a class="el" href="classResultImpl.html#p0">ResultImpl::resultPointer_</a><code> [protected]</code> </td>
2020-02-17 22:11:31 +01:00
</tr>
</table>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 22:11:31 +01:00
<p>
2020-02-17 22:19:08 +01:00
</td>
</tr>
</table>
2020-02-17 22:11:31 +01:00
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ResultImpl_8hpp-source.html">ResultImpl.hpp</a></ul>
2020-02-17 22:19:08 +01:00
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:41 2009 for XQilla Simple API by&nbsp;
2020-02-17 22:11:31 +01:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 22:19:08 +01:00
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
2020-02-17 22:11:31 +01:00
</body>
</html>