| <!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 Page</span></a></li> |
| <li><a href="pages.html"><span>Related 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 List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> </div> |
| <div class="headertitle"> |
| <h1>XalanEXSLTFunctionObjectType Class Reference</h1> </div> |
| </div> |
| <div class="contents"> |
| <!-- doxytag: class="XalanEXSLTFunctionObjectType" --><!-- doxytag: inherits="Function" --> |
| <p><code>#include <<a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html">XalanEXSLTCommonImpl.hpp</a>></code></p> |
| |
| <p>Inherits <a class="el" href="classFunction.html">Function</a>.</p> |
| <div class="dynheader"> |
| Collaboration diagram for XalanEXSLTFunctionObjectType:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classXalanEXSLTFunctionObjectType__coll__graph.png" border="0" usemap="#XalanEXSLTFunctionObjectType_coll__map" alt="Collaboration graph"/></div> |
| <map name="XalanEXSLTFunctionObjectType_coll__map" id="XalanEXSLTFunctionObjectType_coll__map"> |
| <area shape="rect" id="node2" href="classFunction.html" title="Function" alt="" coords="37,101,112,131"/><area shape="rect" id="node4" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="136,101,264,131"/><area shape="rect" id="node6" href="classXalanVector.html" title="XalanVector\< XalanDOMChar \>" alt="" coords="87,5,313,35"/></map> |
| <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> |
| |
| <p><a href="classXalanEXSLTFunctionObjectType-members.html">List of all members.</a></p> |
| <h2><a name="pub-types"></a> |
| Public Types</h2> |
| <ul> |
| <li>typedef <a class="el" href="classFunction.html">Function</a> <a class="el" href="classXalanEXSLTFunctionObjectType.html#af84880da292830eda161c4965a67a34e">ParentType</a> |
| </ul> |
| <h2><a name="pub-methods"></a> |
| Public Member Functions</h2> |
| <ul> |
| <li><a class="el" href="classXalanEXSLTFunctionObjectType.html#aab80edaecb383bc8f5caab21cd52589d">XalanEXSLTFunctionObjectType</a> (MemoryManager &theManager) |
| <li><a class="el" href="classXalanEXSLTFunctionObjectType.html#a82a1ad4477a0cb0c19e5a99f293fec19">XalanEXSLTFunctionObjectType</a> (MemoryManager &theManager, int) |
| <li>virtual <a class="el" href="classXalanEXSLTFunctionObjectType.html#aacd34da3af79eb4e9f5f632bb77b6397">~XalanEXSLTFunctionObjectType</a> () |
| <li>virtual <a class="el" href="classXObjectPtr.html">XObjectPtr</a> <a class="el" href="classXalanEXSLTFunctionObjectType.html#abf03d07996f66a4e144eaf4c58377cc3">execute</a> (<a class="el" href="classXPathExecutionContext.html">XPathExecutionContext</a> &executionContext, <a class="el" href="classXalanNode.html">XalanNode</a> *context, const <a class="el" href="classXalanVector.html">XObjectArgVectorType</a> &args, const Locator *locator) const |
| <dl class="el"><dd class="mdescRight">Execute an <a class="el" href="classXPath.html">XPath</a> function object. <a href="#abf03d07996f66a4e144eaf4c58377cc3"></a><br/></dl><li>virtual <br class="typebreak"/> |
| <a class="el" href="classXalanEXSLTFunctionObjectType.html">XalanEXSLTFunctionObjectType</a> * <a class="el" href="classXalanEXSLTFunctionObjectType.html#a525af9d95aa06a565321bf37781c56b9">clone</a> (MemoryManager &theManager) const |
| <dl class="el"><dd class="mdescRight">Create a copy of the function object. <a href="#a525af9d95aa06a565321bf37781c56b9"></a><br/></dl></ul> |
| <h2><a name="pro-methods"></a> |
| Protected Member Functions</h2> |
| <ul> |
| <li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> & <a class="el" href="classXalanEXSLTFunctionObjectType.html#a327a7c46a8a924ee23717807fc813fc1">getError</a> (<a class="el" href="classXalanDOMString.html">XalanDOMString</a> &<a class="el" href="XalanDOMString_8hpp.html#ad0987a2085caff760532b7f16b5c6f2e">theResult</a>) const |
| <dl class="el"><dd class="mdescRight">Get the error message to report when the function is called with the wrong number of arguments. <a href="#a327a7c46a8a924ee23717807fc813fc1"></a><br/></dl></ul> |
| <hr/><a name="_details"></a><h2>Detailed Description</h2> |
| |
| <p>Definition at line <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html#l00104">104</a> of file <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html">XalanEXSLTCommonImpl.hpp</a>.</p> |
| <hr/><h2>Member Typedef Documentation</h2> |
| <a class="anchor" id="af84880da292830eda161c4965a67a34e"></a><!-- doxytag: member="XalanEXSLTFunctionObjectType::ParentType" ref="af84880da292830eda161c4965a67a34e" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef <a class="el" href="classFunction.html">Function</a> <a class="el" href="classFunction.html">XalanEXSLTFunctionObjectType::ParentType</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html#l00108">108</a> of file <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html">XalanEXSLTCommonImpl.hpp</a>.</p> |
| |
| </div> |
| </div> |
| <hr/><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="aab80edaecb383bc8f5caab21cd52589d"></a><!-- doxytag: member="XalanEXSLTFunctionObjectType::XalanEXSLTFunctionObjectType" ref="aab80edaecb383bc8f5caab21cd52589d" args="(MemoryManager &theManager)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanEXSLTFunctionObjectType::XalanEXSLTFunctionObjectType </td> |
| <td>(</td> |
| <td class="paramtype">MemoryManager & </td> |
| <td class="paramname"> <em>theManager</em></td> |
| <td> ) </td> |
| <td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html#l00110">110</a> of file <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html">XalanEXSLTCommonImpl.hpp</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a82a1ad4477a0cb0c19e5a99f293fec19"></a><!-- doxytag: member="XalanEXSLTFunctionObjectType::XalanEXSLTFunctionObjectType" ref="a82a1ad4477a0cb0c19e5a99f293fec19" args="(MemoryManager &theManager, int)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">XalanEXSLTFunctionObjectType::XalanEXSLTFunctionObjectType </td> |
| <td>(</td> |
| <td class="paramtype">MemoryManager & </td> |
| <td class="paramname"> <em>theManager</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html#l00122">122</a> of file <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html">XalanEXSLTCommonImpl.hpp</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aacd34da3af79eb4e9f5f632bb77b6397"></a><!-- doxytag: member="XalanEXSLTFunctionObjectType::~XalanEXSLTFunctionObjectType" ref="aacd34da3af79eb4e9f5f632bb77b6397" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual XalanEXSLTFunctionObjectType::~XalanEXSLTFunctionObjectType </td> |
| <td>(</td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td><code> [inline, virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html#l00134">134</a> of file <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html">XalanEXSLTCommonImpl.hpp</a>.</p> |
| |
| </div> |
| </div> |
| <hr/><h2>Member Function Documentation</h2> |
| <a class="anchor" id="a525af9d95aa06a565321bf37781c56b9"></a><!-- doxytag: member="XalanEXSLTFunctionObjectType::clone" ref="a525af9d95aa06a565321bf37781c56b9" args="(MemoryManager &theManager) const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classXalanEXSLTFunctionObjectType.html">XalanEXSLTFunctionObjectType</a>* XalanEXSLTFunctionObjectType::clone </td> |
| <td>(</td> |
| <td class="paramtype">MemoryManager & </td> |
| <td class="paramname"> <em>theManager</em></td> |
| <td> ) </td> |
| <td> const<code> [inline, virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Create a copy of the function object. </p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the new object </dd></dl> |
| |
| <p>Implements <a class="el" href="classFunction.html#a2fadcb58a8f88f7cff630a30ce16203c">Function</a>.</p> |
| |
| <p>Definition at line <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html#l00154">154</a> of file <a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html">XalanEXSLTCommonImpl.hpp</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abf03d07996f66a4e144eaf4c58377cc3"></a><!-- doxytag: member="XalanEXSLTFunctionObjectType::execute" ref="abf03d07996f66a4e144eaf4c58377cc3" args="(XPathExecutionContext &executionContext, XalanNode *context, const XObjectArgVectorType &args, const Locator *locator) const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classXObjectPtr.html">XObjectPtr</a> XalanEXSLTFunctionObjectType::execute </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classXPathExecutionContext.html">XPathExecutionContext</a> & </td> |
| <td class="paramname"> <em>executionContext</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classXalanNode.html">XalanNode</a> * </td> |
| <td class="paramname"> <em>context</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classXalanVector.html">XObjectArgVectorType</a> & </td> |
| <td class="paramname"> <em>args</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const Locator * </td> |
| <td class="paramname"> <em>locator</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td> const<code> [virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Execute an <a class="el" href="classXPath.html">XPath</a> function object. </p> |
| <p>The function must return a valid object. Extension functions should override this version of <a class="el" href="classXalanEXSLTFunctionObjectType.html#abf03d07996f66a4e144eaf4c58377cc3" title="Execute an XPath function object.">execute()</a>, rather than one of the other calls designed for a specific number of arguments, since the extension function mechanism will call this version first. Extension functions that accept more than three arguments _must_ override this version.</p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>executionContext</em> </td><td>executing context </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>current context node </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>vector of pointers to <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> arguments </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>locator</em> </td><td>Locator instance for the <a class="el" href="classXPath.html">XPath</a> expression that contains the function call </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>pointer to the result <a class="el" href="classXObject.html" title="Class to hold XPath return types.">XObject</a> </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classFunction.html#aa4b335cec171fe9b244240d7cc23cc9a">Function</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a327a7c46a8a924ee23717807fc813fc1"></a><!-- doxytag: member="XalanEXSLTFunctionObjectType::getError" ref="a327a7c46a8a924ee23717807fc813fc1" args="(XalanDOMString &theResult) const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>& XalanEXSLTFunctionObjectType::getError </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classXalanDOMString.html">XalanDOMString</a> & </td> |
| <td class="paramname"> <em>theBuffer</em></td> |
| <td> ) </td> |
| <td> const<code> [protected, virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Get the error message to report when the function is called with the wrong number of arguments. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theBuffer</em> </td><td>The <a class="el" href="classXalanDOMString.html">XalanDOMString</a> for the message. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>The error message </dd></dl> |
| |
| <p>Implements <a class="el" href="classFunction.html#a2a9ce8b0b9ec2d6581355346ec84ae30">Function</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="XalanEXSLTCommonImpl_8hpp_source.html">XalanEXSLTCommonImpl.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 © 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> |
