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

274 lines
14 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>ResultImpl Class Reference</h1><!-- doxytag: class="ResultImpl" --><!-- doxytag: inherits="LocationInfo" -->A lazily evaluated query result.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ResultImpl_8hpp-source.html">ResultImpl.hpp</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for ResultImpl:</div>
<div class="dynsection">
<p><center><img src="classResultImpl__inherit__graph.png" border="0" usemap="#ResultImpl__inherit__map" alt="Inheritance graph"></center>
<map name="ResultImpl__inherit__map">
<area shape="rect" href="classGenerateEventsResult.html" title="GenerateEventsResult" alt="" coords="5,156,157,180"><area shape="rect" title="Top level lazy result iterator." alt="" coords="181,156,336,180"><area shape="rect" href="classLocationInfo.html" title="A class that gives records a location in the query." alt="" coords="124,7,215,31"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classResultImpl-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">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#8f4c0a79354b00cfcf58b2ef3100bf57">~ResultImpl</a> ()</td></tr>
<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#fe6b26d2f92bd9a494c60ff2c21dbbac">getResultPointer</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResultImpl.html#6f4ce236cfd8dba22738c3718e0cda4c">setResultPointer</a> (<a class="el" href="classResult.html">Result</a> *p)</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#4820c3c36a27975b1b704b903d2d1c5f">next</a> (<a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<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="#4820c3c36a27975b1b704b903d2d1c5f"></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#8f095d8add3f386c32a9580524c44ae3">nextOrTail</a> (<a class="el" href="classResult.html">Result</a> &amp;tail, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the next item, or returns a tail call <a class="el" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a> which will give the next item. <a href="#8f095d8add3f386c32a9580524c44ae3"></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#e88cb3ac28f6dc7a8a712903fdd44377">toSequence</a> (<a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cast operator to a <a class="el" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a>. Only works properly before <a class="el" href="classResultImpl.html#4820c3c36a27975b1b704b903d2d1c5f" title="Get the next item from the iterator. Returns null if the is no next value.">next()</a> has been called. <a href="#e88cb3ac28f6dc7a8a712903fdd44377"></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#c4152b3ff07d311cd9d669e4a11b47dd">toResultBuffer</a> (unsigned int readCount)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a result buffer of the result. <a href="#c4152b3ff07d311cd9d669e4a11b47dd"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected 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="classResultImpl.html#e7fdab3da3aecae7cfe9a031ca79b8d7">ResultImpl</a> (const <a class="el" href="classLocationInfo.html">LocationInfo</a> *o)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<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#e9e8cbdcfea2cff7ea65fc014bc5ea13">resultPointer_</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A lazily evaluated query result. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="8f4c0a79354b00cfcf58b2ef3100bf57"></a><!-- doxytag: member="ResultImpl::~ResultImpl" ref="8f4c0a79354b00cfcf58b2ef3100bf57" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ResultImpl::~ResultImpl </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e7fdab3da3aecae7cfe9a031ca79b8d7"></a><!-- doxytag: member="ResultImpl::ResultImpl" ref="e7fdab3da3aecae7cfe9a031ca79b8d7" args="(const LocationInfo *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ResultImpl::ResultImpl </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&nbsp;</td>
<td class="paramname"> <em>o</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fe6b26d2f92bd9a494c60ff2c21dbbac"></a><!-- doxytag: member="ResultImpl::getResultPointer" ref="fe6b26d2f92bd9a494c60ff2c21dbbac" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classResult.html">Result</a>* ResultImpl::getResultPointer </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>
</div>
</div><p>
<a class="anchor" name="6f4ce236cfd8dba22738c3718e0cda4c"></a><!-- doxytag: member="ResultImpl::setResultPointer" ref="6f4ce236cfd8dba22738c3718e0cda4c" args="(Result *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ResultImpl::setResultPointer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classResult.html">Result</a> *&nbsp;</td>
<td class="paramname"> <em>p</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="4820c3c36a27975b1b704b903d2d1c5f"></a><!-- doxytag: member="ResultImpl::next" ref="4820c3c36a27975b1b704b903d2d1c5f" args="(DynamicContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a> ResultImpl::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the next item from the iterator. Returns null if the is no next value.
<p>
</div>
</div><p>
<a class="anchor" name="8f095d8add3f386c32a9580524c44ae3"></a><!-- doxytag: member="ResultImpl::nextOrTail" ref="8f095d8add3f386c32a9580524c44ae3" args="(Result &amp;tail, DynamicContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRefCountPointer.html">Item::Ptr</a> ResultImpl::nextOrTail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classResult.html">Result</a> &amp;&nbsp;</td>
<td class="paramname"> <em>tail</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the next item, or returns a tail call <a class="el" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a> which will give the next item.
<p>
<p>Reimplemented in <a class="el" href="classGenerateEventsResult.html#0b852c6cbb3807c7b2cdb42d7e1e62ad">GenerateEventsResult</a>.</p>
</div>
</div><p>
<a class="anchor" name="e88cb3ac28f6dc7a8a712903fdd44377"></a><!-- doxytag: member="ResultImpl::toSequence" ref="e88cb3ac28f6dc7a8a712903fdd44377" args="(DynamicContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classSequence.html">Sequence</a> ResultImpl::toSequence </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cast operator to a <a class="el" href="classSequence.html" title="An eagerly evaluated result of a query execution.">Sequence</a>. Only works properly before <a class="el" href="classResultImpl.html#4820c3c36a27975b1b704b903d2d1c5f" title="Get the next item from the iterator. Returns null if the is no next value.">next()</a> has been called.
<p>
</div>
</div><p>
<a class="anchor" name="c4152b3ff07d311cd9d669e4a11b47dd"></a><!-- doxytag: member="ResultImpl::toResultBuffer" ref="c4152b3ff07d311cd9d669e4a11b47dd" args="(unsigned int readCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ResultBufferImpl* ResultImpl::toResultBuffer </td>
<td>(</td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>readCount</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a result buffer of the result.
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="e9e8cbdcfea2cff7ea65fc014bc5ea13"></a><!-- doxytag: member="ResultImpl::resultPointer_" ref="e9e8cbdcfea2cff7ea65fc014bc5ea13" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classResult.html">Result</a>* <a class="el" href="classResultImpl.html#e9e8cbdcfea2cff7ea65fc014bc5ea13">ResultImpl::resultPointer_</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<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>
</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