XQuilla/docs/simple-api/classStackFrame.html
2020-02-17 22:21:23 +01:00

363 lines
18 KiB
HTML

<!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.6.1 -->
<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="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 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>
</ul>
</div>
</div>
<div class="contents">
<h1>StackFrame Class Reference</h1><!-- doxytag: class="StackFrame" -->
<p>A class that represents an item in a query call stack.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="StackFrame_8hpp_source.html">StackFrame.hpp</a>&gt;</code></p>
<p><a href="classStackFrame-members.html">List of all members.</a></p>
<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">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#ae3d14b6d23bb7f8ab5e6c78ebb4be18a">~StackFrame</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a122c8864d02c50e4172e203a3ebe5be3">getLocationInfo</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classStackFrame.html">StackFrame</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a870282cd662a6115a3c9ccf97410342f">getPreviousFrame</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classSequence.html">Sequence</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#ad9ded19822f5ce8574399ccf470b7b41">query</a> (const XMLCh *query) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#ad4af1075d79a1f376256d8bd8de5235f">query</a> (const XMLCh *query, <a class="el" href="classEventHandler.html">EventHandler</a> *events) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const ASTNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#ae89c3afeccff74d2326ad13be996b5e1">getASTNode</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const TupleNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a5bd6e4e69cc366cc602c68548df4c269">getTupleNode</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a3b2134e70dd2df043b86434e05a96c61">getQueryPlan</a> () const =0</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#ab011fbb5ac9f44dfe6f5c77e500a2d7c">StackFrame</a> (const <a class="el" href="classLocationInfo.html">LocationInfo</a> *location, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#acdadba111c7943f1855287576dfd4a93">location_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a6acd59336ed7c8a05d218d7e27ef1f6f">context_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRefCountPointer.html">Item::Ptr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#aa3adf6736983e167fc6b2a82c9ed2b5f">contextItem_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a6282e12116bf469a8c11aed9117bdbc1">contextPosition_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a36dbdf7b2678d0e311c93637c67f42e9">contextSize_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classVariableStore.html">VariableStore</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#aed7d66589b38e61f45a7d4acf5cb513d">variables_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classxercesc_1_1DOMXPathNSResolver.html">xercesc::DOMXPathNSResolver</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a24c1ad7d5e7a4cfcc918f86399075ebb">nsResolver_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a0dff85c57d4f6c4a1d4c5f46a92e56dd">defaultElementNS_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classStackFrame.html">StackFrame</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classStackFrame.html#a7d982ac901ba9bb947bd11b49de8dbe6">prev_</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A class that represents an item in a query call stack. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae3d14b6d23bb7f8ab5e6c78ebb4be18a"></a><!-- doxytag: member="StackFrame::~StackFrame" ref="ae3d14b6d23bb7f8ab5e6c78ebb4be18a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual StackFrame::~StackFrame </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab011fbb5ac9f44dfe6f5c77e500a2d7c"></a><!-- doxytag: member="StackFrame::StackFrame" ref="ab011fbb5ac9f44dfe6f5c77e500a2d7c" args="(const LocationInfo *location, DynamicContext *context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StackFrame::StackFrame </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&nbsp;</td>
<td class="paramname"> <em>location</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><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae89c3afeccff74d2326ad13be996b5e1"></a><!-- doxytag: member="StackFrame::getASTNode" ref="ae89c3afeccff74d2326ad13be996b5e1" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const ASTNode* StackFrame::getASTNode </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a122c8864d02c50e4172e203a3ebe5be3"></a><!-- doxytag: member="StackFrame::getLocationInfo" ref="a122c8864d02c50e4172e203a3ebe5be3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classLocationInfo.html">LocationInfo</a>* StackFrame::getLocationInfo </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a870282cd662a6115a3c9ccf97410342f"></a><!-- doxytag: member="StackFrame::getPreviousFrame" ref="a870282cd662a6115a3c9ccf97410342f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classStackFrame.html">StackFrame</a>* StackFrame::getPreviousFrame </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3b2134e70dd2df043b86434e05a96c61"></a><!-- doxytag: member="StackFrame::getQueryPlan" ref="a3b2134e70dd2df043b86434e05a96c61" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string StackFrame::getQueryPlan </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a5bd6e4e69cc366cc602c68548df4c269"></a><!-- doxytag: member="StackFrame::getTupleNode" ref="a5bd6e4e69cc366cc602c68548df4c269" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const TupleNode* StackFrame::getTupleNode </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad4af1075d79a1f376256d8bd8de5235f"></a><!-- doxytag: member="StackFrame::query" ref="ad4af1075d79a1f376256d8bd8de5235f" args="(const XMLCh *query, EventHandler *events) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void StackFrame::query </td>
<td>(</td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classEventHandler.html">EventHandler</a> *&nbsp;</td>
<td class="paramname"> <em>events</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad9ded19822f5ce8574399ccf470b7b41"></a><!-- doxytag: member="StackFrame::query" ref="ad9ded19822f5ce8574399ccf470b7b41" args="(const XMLCh *query) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classSequence.html">Sequence</a> StackFrame::query </td>
<td>(</td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>query</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a6acd59336ed7c8a05d218d7e27ef1f6f"></a><!-- doxytag: member="StackFrame::context_" ref="a6acd59336ed7c8a05d218d7e27ef1f6f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDynamicContext.html">DynamicContext</a>* <a class="el" href="classStackFrame.html#a6acd59336ed7c8a05d218d7e27ef1f6f">StackFrame::context_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa3adf6736983e167fc6b2a82c9ed2b5f"></a><!-- doxytag: member="StackFrame::contextItem_" ref="aa3adf6736983e167fc6b2a82c9ed2b5f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRefCountPointer.html">Item::Ptr</a> <a class="el" href="classStackFrame.html#aa3adf6736983e167fc6b2a82c9ed2b5f">StackFrame::contextItem_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6282e12116bf469a8c11aed9117bdbc1"></a><!-- doxytag: member="StackFrame::contextPosition_" ref="a6282e12116bf469a8c11aed9117bdbc1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classStackFrame.html#a6282e12116bf469a8c11aed9117bdbc1">StackFrame::contextPosition_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a36dbdf7b2678d0e311c93637c67f42e9"></a><!-- doxytag: member="StackFrame::contextSize_" ref="a36dbdf7b2678d0e311c93637c67f42e9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classStackFrame.html#a36dbdf7b2678d0e311c93637c67f42e9">StackFrame::contextSize_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0dff85c57d4f6c4a1d4c5f46a92e56dd"></a><!-- doxytag: member="StackFrame::defaultElementNS_" ref="a0dff85c57d4f6c4a1d4c5f46a92e56dd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const XMLCh* <a class="el" href="classStackFrame.html#a0dff85c57d4f6c4a1d4c5f46a92e56dd">StackFrame::defaultElementNS_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="acdadba111c7943f1855287576dfd4a93"></a><!-- doxytag: member="StackFrame::location_" ref="acdadba111c7943f1855287576dfd4a93" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classLocationInfo.html">LocationInfo</a>* <a class="el" href="classStackFrame.html#acdadba111c7943f1855287576dfd4a93">StackFrame::location_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a24c1ad7d5e7a4cfcc918f86399075ebb"></a><!-- doxytag: member="StackFrame::nsResolver_" ref="a24c1ad7d5e7a4cfcc918f86399075ebb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const xercesc:: DOMXPathNSResolver* <a class="el" href="classStackFrame.html#a24c1ad7d5e7a4cfcc918f86399075ebb">StackFrame::nsResolver_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7d982ac901ba9bb947bd11b49de8dbe6"></a><!-- doxytag: member="StackFrame::prev_" ref="a7d982ac901ba9bb947bd11b49de8dbe6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classStackFrame.html">StackFrame</a>* <a class="el" href="classStackFrame.html#a7d982ac901ba9bb947bd11b49de8dbe6">StackFrame::prev_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aed7d66589b38e61f45a7d4acf5cb513d"></a><!-- doxytag: member="StackFrame::variables_" ref="aed7d66589b38e61f45a7d4acf5cb513d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classVariableStore.html">VariableStore</a>* <a class="el" href="classStackFrame.html#aed7d66589b38e61f45a7d4acf5cb513d">StackFrame::variables_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="StackFrame_8hpp_source.html">StackFrame.hpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Mar 1 21:16:15 2010 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>