blob: d74551dbe2d8653b31874ff06ec886694721c7b5 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<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="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>TopLevelArg Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="TopLevelArg" -->
<p>This class holds an instance of an argument on the stack.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="TopLevelArg_8hpp_source.html">TopLevelArg.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for TopLevelArg:</div>
<div class="dyncontent">
<div class="center"><img src="classTopLevelArg__coll__graph.png" border="0" usemap="#TopLevelArg_coll__map" alt="Collaboration graph"/></div>
<map name="TopLevelArg_coll__map" id="TopLevelArg_coll__map">
<area shape="rect" id="node2" href="classXObjectPtr.html" title="Class to hold XObjectPtr return types." alt="" coords="380,419,471,448"/><area shape="rect" id="node4" href="classXObject.html" title="Class to hold XPath return types." alt="" coords="315,320,387,349"/><area shape="rect" id="node6" href="classXalanReferenceCountedObject.html" title="Class to hold reference count information." alt="" coords="5,101,224,131"/><area shape="rect" id="node8" href="classXObjectFactory.html" title="This class handles the creation of XObjects and manages their lifetime." alt="" coords="248,101,365,131"/><area shape="rect" id="node10" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="591,101,719,131"/><area shape="rect" id="node14" href="classXalanQNameByValue.html" title="XalanQNameByValue" alt="" coords="637,419,795,448"/><area shape="rect" id="node16" href="classXalanQName.html" title="Class to represent a qualified name." alt="" coords="829,320,936,349"/><area shape="rect" id="node12" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="541,5,768,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classTopLevelArg-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classTopLevelArg.html#a9ae58e613c7532f976725f34a9bee10a">TopLevelArg</a> (MemoryManager &amp;theManager, const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;name, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;expr)
<dl class="el"><dd class="mdescRight">Construct an argument object from a string expression. <a href="#a9ae58e613c7532f976725f34a9bee10a"></a><br/></dl><li><a class="el" href="classTopLevelArg.html#a60f024294619d796ec40e6e32e1bd2d4">TopLevelArg</a> (MemoryManager &amp;theManager, const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;name, const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> variable=<a class="el" href="classXObjectPtr.html">XObjectPtr</a>())
<dl class="el"><dd class="mdescRight">Construct an argument object from an <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> instance. <a href="#a60f024294619d796ec40e6e32e1bd2d4"></a><br/></dl><li><a class="el" href="classTopLevelArg.html#a3f3fc4d193c0141ffe9e306a9c6cb877">TopLevelArg</a> (const <a class="el" href="classTopLevelArg.html">TopLevelArg</a> &amp;theSource, MemoryManager &amp;theManager)
<dl class="el"><dd class="mdescRight">Copy constructor. <a href="#a3f3fc4d193c0141ffe9e306a9c6cb877"></a><br/></dl><li><a class="el" href="classTopLevelArg.html#a2a28cb991fa97dc7b98a92ee2f5e0324">~TopLevelArg</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <a href="#a2a28cb991fa97dc7b98a92ee2f5e0324"></a><br/></dl><li>const <a class="el" href="classXalanQName.html">XalanQName</a> &amp; <a class="el" href="classTopLevelArg.html#a52e7addcac4c5fab90c69db41baa16c9">getName</a> () const
<dl class="el"><dd class="mdescRight">Retrieve object name. <a href="#a52e7addcac4c5fab90c69db41baa16c9"></a><br/></dl><li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <a class="el" href="classTopLevelArg.html#af08658ace94b7a7a4b36a130d0df4309">getExpression</a> () const
<dl class="el"><dd class="mdescRight">Retrieve object's expression. <a href="#af08658ace94b7a7a4b36a130d0df4309"></a><br/></dl><li>const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> <a class="el" href="classTopLevelArg.html#a93fb02576338215c9d5931df659f109c">getXObject</a> () const
<dl class="el"><dd class="mdescRight">Retrieve object's <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> variable. <a href="#a93fb02576338215c9d5931df659f109c"></a><br/></dl><li><a class="el" href="classTopLevelArg.html">TopLevelArg</a> &amp; <a class="el" href="classTopLevelArg.html#a2f7610b32ade9f391fde9c572d7c2933">operator=</a> (const <a class="el" href="classTopLevelArg.html">TopLevelArg</a> &amp;theRHS)
<dl class="el"><dd class="mdescRight">Assignment operator. <a href="#a2f7610b32ade9f391fde9c572d7c2933"></a><br/></dl></ul>
<h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2>
<ul>
<li>static <a class="el" href="classTopLevelArg.html">TopLevelArg</a> * <a class="el" href="classTopLevelArg.html#a979f12cb731498ff10afeb0918ec4500">create</a> (MemoryManager &amp;theManager, const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;name, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;expr)
<li>static <a class="el" href="classTopLevelArg.html">TopLevelArg</a> * <a class="el" href="classTopLevelArg.html#a9786123711318eb7878cfd50bedec505">create</a> (MemoryManager &amp;theManager, const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;name, const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> variable=<a class="el" href="classXObjectPtr.html">XObjectPtr</a>())
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class holds an instance of an argument on the stack. </p>
<p>Definition at line <a class="el" href="TopLevelArg_8hpp_source.html#l00050">50</a> of file <a class="el" href="TopLevelArg_8hpp_source.html">TopLevelArg.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9ae58e613c7532f976725f34a9bee10a"></a><!-- doxytag: member="TopLevelArg::TopLevelArg" ref="a9ae58e613c7532f976725f34a9bee10a" args="(MemoryManager &amp;theManager, const XalanQName &amp;name, const XalanDOMString &amp;expr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TopLevelArg::TopLevelArg </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;&nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>expr</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an argument object from a string expression. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>name of argument </td></tr>
<tr><td valign="top"></td><td valign="top"><em>expr</em>&nbsp;</td><td>expression argument represents </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a60f024294619d796ec40e6e32e1bd2d4"></a><!-- doxytag: member="TopLevelArg::TopLevelArg" ref="a60f024294619d796ec40e6e32e1bd2d4" args="(MemoryManager &amp;theManager, const XalanQName &amp;name, const XObjectPtr variable=XObjectPtr())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TopLevelArg::TopLevelArg </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;&nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXObjectPtr.html">XObjectPtr</a>&nbsp;</td>
<td class="paramname"> <em>variable</em> = <code><a class="el" href="classXObjectPtr.html">XObjectPtr</a>()</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an argument object from an <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> instance. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>name of argument </td></tr>
<tr><td valign="top"></td><td valign="top"><em>variable</em>&nbsp;</td><td>the <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3f3fc4d193c0141ffe9e306a9c6cb877"></a><!-- doxytag: member="TopLevelArg::TopLevelArg" ref="a3f3fc4d193c0141ffe9e306a9c6cb877" args="(const TopLevelArg &amp;theSource, MemoryManager &amp;theManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TopLevelArg::TopLevelArg </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTopLevelArg.html">TopLevelArg</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theSource</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theSource</em>&nbsp;</td><td>the <a class="el" href="classTopLevelArg.html" title="This class holds an instance of an argument on the stack.">TopLevelArg</a> to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2a28cb991fa97dc7b98a92ee2f5e0324"></a><!-- doxytag: member="TopLevelArg::~TopLevelArg" ref="a2a28cb991fa97dc7b98a92ee2f5e0324" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TopLevelArg::~TopLevelArg </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a979f12cb731498ff10afeb0918ec4500"></a><!-- doxytag: member="TopLevelArg::create" ref="a979f12cb731498ff10afeb0918ec4500" args="(MemoryManager &amp;theManager, const XalanQName &amp;name, const XalanDOMString &amp;expr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTopLevelArg.html">TopLevelArg</a>* TopLevelArg::create </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;&nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>expr</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9786123711318eb7878cfd50bedec505"></a><!-- doxytag: member="TopLevelArg::create" ref="a9786123711318eb7878cfd50bedec505" args="(MemoryManager &amp;theManager, const XalanQName &amp;name, const XObjectPtr variable=XObjectPtr())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classTopLevelArg.html">TopLevelArg</a>* TopLevelArg::create </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanQName.html">XalanQName</a> &amp;&nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXObjectPtr.html">XObjectPtr</a>&nbsp;</td>
<td class="paramname"> <em>variable</em> = <code><a class="el" href="classXObjectPtr.html">XObjectPtr</a>()</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af08658ace94b7a7a4b36a130d0df4309"></a><!-- doxytag: member="TopLevelArg::getExpression" ref="af08658ace94b7a7a4b36a130d0df4309" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; TopLevelArg::getExpression </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve object's expression. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>string representation of expression </dd></dl>
<p>Definition at line <a class="el" href="TopLevelArg_8hpp_source.html#l00118">118</a> of file <a class="el" href="TopLevelArg_8hpp_source.html">TopLevelArg.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a52e7addcac4c5fab90c69db41baa16c9"></a><!-- doxytag: member="TopLevelArg::getName" ref="a52e7addcac4c5fab90c69db41baa16c9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXalanQName.html">XalanQName</a>&amp; TopLevelArg::getName </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve object name. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>qualified name of object </dd></dl>
<p>Definition at line <a class="el" href="TopLevelArg_8hpp_source.html#l00107">107</a> of file <a class="el" href="TopLevelArg_8hpp_source.html">TopLevelArg.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a93fb02576338215c9d5931df659f109c"></a><!-- doxytag: member="TopLevelArg::getXObject" ref="a93fb02576338215c9d5931df659f109c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXObjectPtr.html">XObjectPtr</a> TopLevelArg::getXObject </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve object's <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> variable. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> instance </dd></dl>
<p>Definition at line <a class="el" href="TopLevelArg_8hpp_source.html#l00129">129</a> of file <a class="el" href="TopLevelArg_8hpp_source.html">TopLevelArg.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2f7610b32ade9f391fde9c572d7c2933"></a><!-- doxytag: member="TopLevelArg::operator=" ref="a2f7610b32ade9f391fde9c572d7c2933" args="(const TopLevelArg &amp;theRHS)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTopLevelArg.html">TopLevelArg</a>&amp; TopLevelArg::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTopLevelArg.html">TopLevelArg</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theRHS</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<p>Definition at line <a class="el" href="TopLevelArg_8hpp_source.html#l00138">138</a> of file <a class="el" href="TopLevelArg_8hpp_source.html">TopLevelArg.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="TopLevelArg_8hpp_source.html">TopLevelArg.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">GraphViz</a> are
used to generate this API documentation from the Xalan-C header files.</i></font></p>
<table border="0" cellpadding="0" cellspacing="0" width="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>