mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/simple-api/classEventGenerator.html
King_DuckZ 3552e76c6c v2.3.4
2020-02-17 22:24:47 +01:00

257 lines
16 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.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classEventGenerator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">EventGenerator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="EventGenerator_8hpp_source.html">EventGenerator.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for EventGenerator:</div>
<div class="dyncontent">
<div class="center"><img src="classEventGenerator__inherit__graph.png" border="0" usemap="#EventGenerator_inherit__map" alt="Inheritance graph"/></div>
<map name="EventGenerator_inherit__map" id="EventGenerator_inherit__map">
<area shape="rect" id="node3" href="classASTNodeEventGenerator.html" title="ASTNodeEventGenerator" alt="" coords="5,155,176,181"/><area shape="rect" id="node2" href="classReferenceCounted.html" title="Super class for reference counted classes. " alt="" coords="25,5,156,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ae6e5557a3042765b3be5e6d7136280fe"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classRefCountPointer.html">RefCountPointer</a><br class="typebreak"/>
&lt; <a class="el" href="classEventGenerator.html">EventGenerator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventGenerator.html#ae6e5557a3042765b3be5e6d7136280fe">Ptr</a></td></tr>
<tr class="separator:ae6e5557a3042765b3be5e6d7136280fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a65ef84c1033c722593ce41386efe679a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventGenerator.html#a65ef84c1033c722593ce41386efe679a">~EventGenerator</a> ()</td></tr>
<tr class="separator:a65ef84c1033c722593ce41386efe679a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a067ad4ae2db64171737fd6c1e538f90e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classEventGenerator.html#ae6e5557a3042765b3be5e6d7136280fe">EventGenerator::Ptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventGenerator.html#a067ad4ae2db64171737fd6c1e538f90e">generateEvents</a> (<a class="el" href="classEventHandler.html">EventHandler</a> *events, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)=0</td></tr>
<tr class="memdesc:a067ad4ae2db64171737fd6c1e538f90e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the result of this expression via the <a class="el" href="classEventHandler.html">EventHandler</a> provided. <a href="#a067ad4ae2db64171737fd6c1e538f90e">More...</a><br/></td></tr>
<tr class="separator:a067ad4ae2db64171737fd6c1e538f90e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classReferenceCounted"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classReferenceCounted')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classReferenceCounted.html">ReferenceCounted</a></td></tr>
<tr class="memitem:a5dc30ae895897b5008dc71ea26f175a1 inherit pub_methods_classReferenceCounted"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a5dc30ae895897b5008dc71ea26f175a1">ReferenceCounted</a> ()</td></tr>
<tr class="separator:a5dc30ae895897b5008dc71ea26f175a1 inherit pub_methods_classReferenceCounted"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a039b1f45b252a226c55598f31e3993cc inherit pub_methods_classReferenceCounted"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a039b1f45b252a226c55598f31e3993cc">~ReferenceCounted</a> ()</td></tr>
<tr class="separator:a039b1f45b252a226c55598f31e3993cc inherit pub_methods_classReferenceCounted"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a386d6aab0473c14a32ce81226b939cb3 inherit pub_methods_classReferenceCounted"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a386d6aab0473c14a32ce81226b939cb3">incrementRefCount</a> () const </td></tr>
<tr class="memdesc:a386d6aab0473c14a32ce81226b939cb3 inherit pub_methods_classReferenceCounted"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the reference count. <a href="#a386d6aab0473c14a32ce81226b939cb3">More...</a><br/></td></tr>
<tr class="separator:a386d6aab0473c14a32ce81226b939cb3 inherit pub_methods_classReferenceCounted"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a426ce234c4797e7150f44a9bb50537b5 inherit pub_methods_classReferenceCounted"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a426ce234c4797e7150f44a9bb50537b5">decrementRefCount</a> () const </td></tr>
<tr class="memdesc:a426ce234c4797e7150f44a9bb50537b5 inherit pub_methods_classReferenceCounted"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decrement the reference count, deleting if it becomes zero. <a href="#a426ce234c4797e7150f44a9bb50537b5">More...</a><br/></td></tr>
<tr class="separator:a426ce234c4797e7150f44a9bb50537b5 inherit pub_methods_classReferenceCounted"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a462eca1b13abf41350ef3d969435db2c inherit pub_methods_classReferenceCounted"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a462eca1b13abf41350ef3d969435db2c">getRefCount</a> () const </td></tr>
<tr class="separator:a462eca1b13abf41350ef3d969435db2c inherit pub_methods_classReferenceCounted"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af5706f4d964a19492fed64cb14a9eb73"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventGenerator.html#af5706f4d964a19492fed64cb14a9eb73">generateAndTailCall</a> (const <a class="el" href="classEventGenerator.html#ae6e5557a3042765b3be5e6d7136280fe">EventGenerator::Ptr</a> &amp;generator, <a class="el" href="classEventHandler.html">EventHandler</a> *events, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr class="separator:af5706f4d964a19492fed64cb14a9eb73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a546f948491fc8cb975afc82cd515ebd8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classResult.html">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEventGenerator.html#a546f948491fc8cb975afc82cd515ebd8">createResult</a> (const ASTNode *ast, const QueryPathNode *projection, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr class="separator:a546f948491fc8cb975afc82cd515ebd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classReferenceCounted"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classReferenceCounted')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classReferenceCounted.html">ReferenceCounted</a></td></tr>
<tr class="memitem:a09e5d033e5224cd8b94cdc061cb56fe0 inherit pro_attribs_classReferenceCounted"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a09e5d033e5224cd8b94cdc061cb56fe0">_ref_count</a></td></tr>
<tr class="separator:a09e5d033e5224cd8b94cdc061cb56fe0 inherit pro_attribs_classReferenceCounted"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="ae6e5557a3042765b3be5e6d7136280fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt;<a class="el" href="classEventGenerator.html">EventGenerator</a>&gt; <a class="el" href="classEventGenerator.html#ae6e5557a3042765b3be5e6d7136280fe">EventGenerator::Ptr</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a65ef84c1033c722593ce41386efe679a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual EventGenerator::~EventGenerator </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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a546f948491fc8cb975afc82cd515ebd8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classResult.html">Result</a> EventGenerator::createResult </td>
<td>(</td>
<td class="paramtype">const ASTNode *&#160;</td>
<td class="paramname"><em>ast</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QueryPathNode *&#160;</td>
<td class="paramname"><em>projection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&#160;</td>
<td class="paramname"><em>context</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af5706f4d964a19492fed64cb14a9eb73"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void EventGenerator::generateAndTailCall </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classEventGenerator.html#ae6e5557a3042765b3be5e6d7136280fe">EventGenerator::Ptr</a> &amp;&#160;</td>
<td class="paramname"><em>generator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classEventHandler.html">EventHandler</a> *&#160;</td>
<td class="paramname"><em>events</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&#160;</td>
<td class="paramname"><em>context</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>References <a class="el" href="classRefCountPointer.html#a1de8e3bd6a0af6661047049983243e1c">RefCountPointer&lt; T &gt;::notNull()</a>.</p>
</div>
</div>
<a class="anchor" id="a067ad4ae2db64171737fd6c1e538f90e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classEventGenerator.html#ae6e5557a3042765b3be5e6d7136280fe">EventGenerator::Ptr</a> EventGenerator::generateEvents </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classEventHandler.html">EventHandler</a> *&#160;</td>
<td class="paramname"><em>events</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&#160;</td>
<td class="paramname"><em>context</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the result of this expression via the <a class="el" href="classEventHandler.html">EventHandler</a> provided. </p>
<p>An <a class="el" href="classEventGenerator.html">EventGenerator</a> may be returned to be called as a tail call optimization </p>
<p>Implemented in <a class="el" href="classASTNodeEventGenerator.html#a0e9a356c47705b7dd398f2edf70a4583">ASTNodeEventGenerator</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="EventGenerator_8hpp_source.html">EventGenerator.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink