PageRenderTime 45ms CodeModel.GetById 15ms RepoModel.GetById 1ms app.codeStats 0ms

/XQilla-2.2.4/docs/simple-api/classExternalFunction.html

#
HTML | 299 lines | 283 code | 15 blank | 1 comment | 0 complexity | 7e428da4c4adfd6ad831f7fd8af61d8d MD5 | raw file
Possible License(s): Apache-2.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
    3. 

  3. <title>XQilla Simple API Documentation</title>
    4. 

  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="tabs.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <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>
    8. 

  8. <!-- Generated by Doxygen 1.6.1 -->
    9. 

  9. <div class="navigation" id="top">
    10. 

  10.   <div class="tabs">
    11. 

  11.     <ul>
    12. 

  12.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    13. 

  13.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    14. 

  14.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    15. 

  15.       <li><a href="files.html"><span>Files</span></a></li>
    16. 

  16.       <li><a href="examples.html"><span>Examples</span></a></li>
    17. 

  17.     </ul>
    18. 

  18.   </div>
    19. 

  19.   <div class="tabs">
    20. 

  20.     <ul>
    21. 

  21.       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    22. 

  22.       <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
    23. 

  23.       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    24. 

  24.       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    25. 

  25.     </ul>
    26. 

  26.   </div>
    27. 

  27. </div>
    28. 

  28. <div class="contents">
    29. 

  29. <h1>ExternalFunction Class Reference</h1><!-- doxytag: class="ExternalFunction" -->
    30. 

  30. <p><code>#include &lt;<a class="el" href="ExternalFunction_8hpp_source.html">ExternalFunction.hpp</a>&gt;</code></p>
    31. 

  31. 

  32. <p><a href="classExternalFunction-members.html">List of all members.</a></p>
    33. 

  33. <table border="0" cellpadding="0" cellspacing="0">
    34. 

  34. <tr><td colspan="2"><h2>Classes</h2></td></tr>
    35. 

  35. <tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a></td></tr>
    36. 

  36. <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
    37. 

  37. <tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a15c836af39ef9a5d79a3edbb87e22176">~ExternalFunction</a> ()</td></tr>
    38. 

  38. <tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a68d2eb21c7bd8072fdfd01cd3c794fd9">getURI</a> () const </td></tr>
    39. 

  39. <tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a8bf0aa847fbcc2defbe287e277223e58">getName</a> () const </td></tr>
    40. 

  40. <tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a45708d6c78ab5cbbc8e39483defeea76">getURINameHash</a> () const </td></tr>
    41. 

  41. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a6edce344cc26cbee3007846c922c2973">getNumberOfArguments</a> () const </td></tr>
    42. 

  42. <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classResult.html">Result</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a1f092fc7e07b1ff4075143282813b064">execute</a> (const <a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a> *args, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context) const </td></tr>
    43. 

  43. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Execute the (non-updating) function.  <a href="#a1f092fc7e07b1ff4075143282813b064"></a><br/></td></tr>
    44. 

  44. <tr><td class="memItemLeft" align="right" valign="top">virtual PendingUpdateList&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a04d1c19baeb22db53c1453efbbbb4c31">executeUpdate</a> (const <a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a> *args, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context) const </td></tr>
    45. 

  45. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Execute the updating function.  <a href="#a04d1c19baeb22db53c1453efbbbb4c31"></a><br/></td></tr>
    46. 

  46. <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
    47. 

  47. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#af2a09a3de46e742706969e60bd4db056">ExternalFunction</a> (const XMLCh *uri, const XMLCh *name, unsigned int numberOfArgs, <a class="el" href="classXPath2MemoryManager.html">XPath2MemoryManager</a> *mm)</td></tr>
    48. 

  48. <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
    49. 

  49. <tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a7707c9ebb2cbc37e915b849ffce4371f">uri_</a></td></tr>
    50. 

  50. <tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a9e666ea401b178e10ab3c0799b3270bd">name_</a></td></tr>
    51. 

  51. <tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#a0ad0a21279823e2a038364827e859725">uriName_</a></td></tr>
    52. 

  52. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classExternalFunction.html#ac4803adcaf53f91a84e6a83c25571cf5">numArgs_</a></td></tr>
    53. 

  53. </table>
    54. 

  54. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
    55. 

  55. <a class="anchor" id="a15c836af39ef9a5d79a3edbb87e22176"></a><!-- doxytag: member="ExternalFunction::~ExternalFunction" ref="a15c836af39ef9a5d79a3edbb87e22176" args="()" -->
    56. 

  56. <div class="memitem">
    57. 

  57. <div class="memproto">
    58. 

  58.       <table class="memname">
    59. 

  59.         <tr>
    60. 

  60.           <td class="memname">virtual ExternalFunction::~ExternalFunction </td>
    61. 

  61.           <td>(</td>
    62. 

  62.           <td class="paramname"></td>
    63. 

  63.           <td>&nbsp;)&nbsp;</td>
    64. 

  64.           <td><code> [inline, virtual]</code></td>
    65. 

  65.         </tr>
    66. 

  66.       </table>
    67. 

  67. </div>
    68. 

  68. <div class="memdoc">
    69. 

  69. 

  70. </div>
    71. 

  71. </div>
    72. 

  72. <a class="anchor" id="af2a09a3de46e742706969e60bd4db056"></a><!-- doxytag: member="ExternalFunction::ExternalFunction" ref="af2a09a3de46e742706969e60bd4db056" args="(const XMLCh *uri, const XMLCh *name, unsigned int numberOfArgs, XPath2MemoryManager *mm)" -->
    73. 

  73. <div class="memitem">
    74. 

  74. <div class="memproto">
    75. 

  75.       <table class="memname">
    76. 

  76.         <tr>
    77. 

  77.           <td class="memname">ExternalFunction::ExternalFunction </td>
    78. 

  78.           <td>(</td>
    79. 

  79.           <td class="paramtype">const XMLCh *&nbsp;</td>
    80. 

  80.           <td class="paramname"> <em>uri</em>, </td>
    81. 

  81.         </tr>
    82. 

  82.         <tr>
    83. 

  83.           <td class="paramkey"></td>
    84. 

  84.           <td></td>
    85. 

  85.           <td class="paramtype">const XMLCh *&nbsp;</td>
    86. 

  86.           <td class="paramname"> <em>name</em>, </td>
    87. 

  87.         </tr>
    88. 

  88.         <tr>
    89. 

  89.           <td class="paramkey"></td>
    90. 

  90.           <td></td>
    91. 

  91.           <td class="paramtype">unsigned int&nbsp;</td>
    92. 

  92.           <td class="paramname"> <em>numberOfArgs</em>, </td>
    93. 

  93.         </tr>
    94. 

  94.         <tr>
    95. 

  95.           <td class="paramkey"></td>
    96. 

  96.           <td></td>
    97. 

  97.           <td class="paramtype"><a class="el" href="classXPath2MemoryManager.html">XPath2MemoryManager</a> *&nbsp;</td>
    98. 

  98.           <td class="paramname"> <em>mm</em></td><td>&nbsp;</td>
    99. 

  99.         </tr>
    100. 

  100.         <tr>
    101. 

  101.           <td></td>
    102. 

  102.           <td>)</td>
    103. 

  103.           <td></td><td></td><td><code> [protected]</code></td>
    104. 

  104.         </tr>
    105. 

  105.       </table>
    106. 

  106. </div>
    107. 

  107. <div class="memdoc">
    108. 

  108. 

  109. </div>
    110. 

  110. </div>
    111. 

  111. <hr/><h2>Member Function Documentation</h2>
    112. 

  112. <a class="anchor" id="a1f092fc7e07b1ff4075143282813b064"></a><!-- doxytag: member="ExternalFunction::execute" ref="a1f092fc7e07b1ff4075143282813b064" args="(const Arguments *args, DynamicContext *context) const " -->
    113. 

  113. <div class="memitem">
    114. 

  114. <div class="memproto">
    115. 

  115.       <table class="memname">
    116. 

  116.         <tr>
    117. 

  117.           <td class="memname">virtual <a class="el" href="classResult.html">Result</a> ExternalFunction::execute </td>
    118. 

  118.           <td>(</td>
    119. 

  119.           <td class="paramtype">const <a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a> *&nbsp;</td>
    120. 

  120.           <td class="paramname"> <em>args</em>, </td>
    121. 

  121.         </tr>
    122. 

  122.         <tr>
    123. 

  123.           <td class="paramkey"></td>
    124. 

  124.           <td></td>
    125. 

  125.           <td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
    126. 

  126.           <td class="paramname"> <em>context</em></td><td>&nbsp;</td>
    127. 

  127.         </tr>
    128. 

  128.         <tr>
    129. 

  129.           <td></td>
    130. 

  130.           <td>)</td>
    131. 

  131.           <td></td><td></td><td> const<code> [virtual]</code></td>
    132. 

  132.         </tr>
    133. 

  133.       </table>
    134. 

  134. </div>
    135. 

  135. <div class="memdoc">
    136. 

  136. 

  137. <p>Execute the (non-updating) function. </p>
    138. 

  138. 

  139. </div>
    140. 

  140. </div>
    141. 

  141. <a class="anchor" id="a04d1c19baeb22db53c1453efbbbb4c31"></a><!-- doxytag: member="ExternalFunction::executeUpdate" ref="a04d1c19baeb22db53c1453efbbbb4c31" args="(const Arguments *args, DynamicContext *context) const " -->
    142. 

  142. <div class="memitem">
    143. 

  143. <div class="memproto">
    144. 

  144.       <table class="memname">
    145. 

  145.         <tr>
    146. 

  146.           <td class="memname">virtual PendingUpdateList ExternalFunction::executeUpdate </td>
    147. 

  147.           <td>(</td>
    148. 

  148.           <td class="paramtype">const <a class="el" href="classExternalFunction_1_1Arguments.html">Arguments</a> *&nbsp;</td>
    149. 

  149.           <td class="paramname"> <em>args</em>, </td>
    150. 

  150.         </tr>
    151. 

  151.         <tr>
    152. 

  152.           <td class="paramkey"></td>
    153. 

  153.           <td></td>
    154. 

  154.           <td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
    155. 

  155.           <td class="paramname"> <em>context</em></td><td>&nbsp;</td>
    156. 

  156.         </tr>
    157. 

  157.         <tr>
    158. 

  158.           <td></td>
    159. 

  159.           <td>)</td>
    160. 

  160.           <td></td><td></td><td> const<code> [virtual]</code></td>
    161. 

  161.         </tr>
    162. 

  162.       </table>
    163. 

  163. </div>
    164. 

  164. <div class="memdoc">
    165. 

  165. 

  166. <p>Execute the updating function. </p>
    167. 

  167. 

  168. </div>
    169. 

  169. </div>
    170. 

  170. <a class="anchor" id="a8bf0aa847fbcc2defbe287e277223e58"></a><!-- doxytag: member="ExternalFunction::getName" ref="a8bf0aa847fbcc2defbe287e277223e58" args="() const " -->
    171. 

  171. <div class="memitem">
    172. 

  172. <div class="memproto">
    173. 

  173.       <table class="memname">
    174. 

  174.         <tr>
    175. 

  175.           <td class="memname">const XMLCh* ExternalFunction::getName </td>
    176. 

  176.           <td>(</td>
    177. 

  177.           <td class="paramname"></td>
    178. 

  178.           <td>&nbsp;)&nbsp;</td>
    179. 

  179.           <td> const<code> [inline]</code></td>
    180. 

  180.         </tr>
    181. 

  181.       </table>
    182. 

  182. </div>
    183. 

  183. <div class="memdoc">
    184. 

  184. 

  185. </div>
    186. 

  186. </div>
    187. 

  187. <a class="anchor" id="a6edce344cc26cbee3007846c922c2973"></a><!-- doxytag: member="ExternalFunction::getNumberOfArguments" ref="a6edce344cc26cbee3007846c922c2973" args="() const " -->
    188. 

  188. <div class="memitem">
    189. 

  189. <div class="memproto">
    190. 

  190.       <table class="memname">
    191. 

  191.         <tr>
    192. 

  192.           <td class="memname">unsigned int ExternalFunction::getNumberOfArguments </td>
    193. 

  193.           <td>(</td>
    194. 

  194.           <td class="paramname"></td>
    195. 

  195.           <td>&nbsp;)&nbsp;</td>
    196. 

  196.           <td> const<code> [inline]</code></td>
    197. 

  197.         </tr>
    198. 

  198.       </table>
    199. 

  199. </div>
    200. 

  200. <div class="memdoc">
    201. 

  201. 

  202. </div>
    203. 

  203. </div>
    204. 

  204. <a class="anchor" id="a68d2eb21c7bd8072fdfd01cd3c794fd9"></a><!-- doxytag: member="ExternalFunction::getURI" ref="a68d2eb21c7bd8072fdfd01cd3c794fd9" args="() const " -->
    205. 

  205. <div class="memitem">
    206. 

  206. <div class="memproto">
    207. 

  207.       <table class="memname">
    208. 

  208.         <tr>
    209. 

  209.           <td class="memname">const XMLCh* ExternalFunction::getURI </td>
    210. 

  210.           <td>(</td>
    211. 

  211.           <td class="paramname"></td>
    212. 

  212.           <td>&nbsp;)&nbsp;</td>
    213. 

  213.           <td> const<code> [inline]</code></td>
    214. 

  214.         </tr>
    215. 

  215.       </table>
    216. 

  216. </div>
    217. 

  217. <div class="memdoc">
    218. 

  218. 

  219. </div>
    220. 

  220. </div>
    221. 

  221. <a class="anchor" id="a45708d6c78ab5cbbc8e39483defeea76"></a><!-- doxytag: member="ExternalFunction::getURINameHash" ref="a45708d6c78ab5cbbc8e39483defeea76" args="() const " -->
    222. 

  222. <div class="memitem">
    223. 

  223. <div class="memproto">
    224. 

  224.       <table class="memname">
    225. 

  225.         <tr>
    226. 

  226.           <td class="memname">const XMLCh* ExternalFunction::getURINameHash </td>
    227. 

  227.           <td>(</td>
    228. 

  228.           <td class="paramname"></td>
    229. 

  229.           <td>&nbsp;)&nbsp;</td>
    230. 

  230.           <td> const<code> [inline]</code></td>
    231. 

  231.         </tr>
    232. 

  232.       </table>
    233. 

  233. </div>
    234. 

  234. <div class="memdoc">
    235. 

  235. 

  236. </div>
    237. 

  237. </div>
    238. 

  238. <hr/><h2>Member Data Documentation</h2>
    239. 

  239. <a class="anchor" id="a9e666ea401b178e10ab3c0799b3270bd"></a><!-- doxytag: member="ExternalFunction::name_" ref="a9e666ea401b178e10ab3c0799b3270bd" args="" -->
    240. 

  240. <div class="memitem">
    241. 

  241. <div class="memproto">
    242. 

  242.       <table class="memname">
    243. 

  243.         <tr>
    244. 

  244.           <td class="memname">const XMLCh* <a class="el" href="classExternalFunction.html#a9e666ea401b178e10ab3c0799b3270bd">ExternalFunction::name_</a><code> [protected]</code></td>
    245. 

  245.         </tr>
    246. 

  246.       </table>
    247. 

  247. </div>
    248. 

  248. <div class="memdoc">
    249. 

  249. 

  250. </div>
    251. 

  251. </div>
    252. 

  252. <a class="anchor" id="ac4803adcaf53f91a84e6a83c25571cf5"></a><!-- doxytag: member="ExternalFunction::numArgs_" ref="ac4803adcaf53f91a84e6a83c25571cf5" args="" -->
    253. 

  253. <div class="memitem">
    254. 

  254. <div class="memproto">
    255. 

  255.       <table class="memname">
    256. 

  256.         <tr>
    257. 

  257.           <td class="memname">unsigned int <a class="el" href="classExternalFunction.html#ac4803adcaf53f91a84e6a83c25571cf5">ExternalFunction::numArgs_</a><code> [protected]</code></td>
    258. 

  258.         </tr>
    259. 

  259.       </table>
    260. 

  260. </div>
    261. 

  261. <div class="memdoc">
    262. 

  262. 

  263. </div>
    264. 

  264. </div>
    265. 

  265. <a class="anchor" id="a7707c9ebb2cbc37e915b849ffce4371f"></a><!-- doxytag: member="ExternalFunction::uri_" ref="a7707c9ebb2cbc37e915b849ffce4371f" args="" -->
    266. 

  266. <div class="memitem">
    267. 

  267. <div class="memproto">
    268. 

  268.       <table class="memname">
    269. 

  269.         <tr>
    270. 

  270.           <td class="memname">const XMLCh* <a class="el" href="classExternalFunction.html#a7707c9ebb2cbc37e915b849ffce4371f">ExternalFunction::uri_</a><code> [protected]</code></td>
    271. 

  271.         </tr>
    272. 

  272.       </table>
    273. 

  273. </div>
    274. 

  274. <div class="memdoc">
    275. 

  275. 

  276. </div>
    277. 

  277. </div>
    278. 

  278. <a class="anchor" id="a0ad0a21279823e2a038364827e859725"></a><!-- doxytag: member="ExternalFunction::uriName_" ref="a0ad0a21279823e2a038364827e859725" args="" -->
    279. 

  279. <div class="memitem">
    280. 

  280. <div class="memproto">
    281. 

  281.       <table class="memname">
    282. 

  282.         <tr>
    283. 

  283.           <td class="memname">const XMLCh* <a class="el" href="classExternalFunction.html#a0ad0a21279823e2a038364827e859725">ExternalFunction::uriName_</a><code> [protected]</code></td>
    284. 

  284.         </tr>
    285. 

  285.       </table>
    286. 

  286. </div>
    287. 

  287. <div class="memdoc">
    288. 

  288. 

  289. </div>
    290. 

  290. </div>
    291. 

  291. <hr/>The documentation for this class was generated from the following file:<ul>
    292. 

  292. <li><a class="el" href="ExternalFunction_8hpp_source.html">ExternalFunction.hpp</a></li>
    293. 

  293. </ul>
    294. 

  294. </div>
    295. 

  295. <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Mar 1 21:16:13 2010 for XQilla Simple API by&nbsp;
    296. 

  296. <a href="http://www.doxygen.org/index.html">
    297. 

  297. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
    298. 

  298. </body>
    299. 

  299. </html>
    300. 

  300.