PageRenderTime 138ms CodeModel.GetById 28ms RepoModel.GetById 0ms app.codeStats 1ms

/doc/web/doxygen/0986/api+framework+samples/html/classrebecca_1_1framework_1_1impl_1_1_formal.html

https://github.com/hallowname/librebecca
HTML | 198 lines | 188 code | 9 blank | 1 comment | 0 complexity | 85c06f1aff3f9e29ad5d9c2d11de2f63 MD5 | raw file
Possible License(s): GPL-3.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>RebeccaAIML: Formal Class Reference</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. <!-- Generated by Doxygen 1.4.5 -->
    8. 

  8. <div class="tabs">
    9. 

  9.   <ul>
    10. 

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

  11.     <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    12. 

  12.     <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
    13. 

  13.     <li><a href="files.html"><span>Files</span></a></li>
    14. 

  14.     <li><a href="dirs.html"><span>Directories</span></a></li>
    15. 

  15.     <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    16. 

  16.   </ul></div>
    17. 

  17. <div class="tabs">
    18. 

  18.   <ul>
    19. 

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

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

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

  22.   </ul></div>
    23. 

  23. <div class="nav">
    24. 

  24. <a class="el" href="namespacerebecca.html">rebecca</a>::<b>framework</b>::<b>impl</b>::<a class="el" href="classrebecca_1_1framework_1_1impl_1_1_formal.html">Formal</a></div>
    25. 

  25. <h1>Formal Class Reference</h1><!-- doxytag: class="rebecca::framework::impl::Formal" --><!-- doxytag: inherits="rebecca::framework::impl::InnerTemplateListImpl" --><a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html">AIML</a> class that represents the <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html">AIML</a> XML tag "formal".  
    26. 

  26. <a href="#_details">More...</a>
    27. 

  27. <p>
    28. 

  28. <code>#include &lt;<a class="el" href="_formal_8h-source.html">Formal.h</a>&gt;</code>
    29. 

  29. <p>
    30. 

  30. <p>Inheritance diagram for Formal:
    31. 

  31. <p><center><img src="classrebecca_1_1framework_1_1impl_1_1_formal.png" usemap="#Formal_map" border="0" alt=""></center>
    32. 

  32. <map name="Formal_map">
    33. 

  33. <area href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html" alt="InnerTemplateListImpl" shape="rect" coords="0,280,132,304">
    34. 

  34. <area href="classrebecca_1_1framework_1_1impl_1_1_inner_template.html" alt="InnerTemplate" shape="rect" coords="0,224,132,248">
    35. 

  35. <area href="classrebecca_1_1framework_1_1impl_1_1_inner_category.html" alt="InnerCategory" shape="rect" coords="0,168,132,192">
    36. 

  36. <area href="classrebecca_1_1framework_1_1impl_1_1_inner_topic.html" alt="InnerTopic" shape="rect" coords="0,112,132,136">
    37. 

  37. <area href="classrebecca_1_1framework_1_1impl_1_1_inner_a_i_m_l.html" alt="InnerAIML" shape="rect" coords="0,56,132,80">
    38. 

  38. <area href="classrebecca_1_1framework_1_1impl_1_1_tag.html" alt="Tag" shape="rect" coords="0,0,132,24">
    39. 

  39. </map>
    40. 

  40. <a href="classrebecca_1_1framework_1_1impl_1_1_formal-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
    41. 

  41. <tr><td></td></tr>
    42. 

  42. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
    43. 

  43. <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrebecca_1_1framework_1_1impl_1_1_formal.html#116a5bfa2bf4a4fea0f18ef78c8ae337">Formal</a> ()  throw (InternalProgrammerErrorException &amp;)</td></tr>
    44. 

  44. 

  45. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor to initalize the private implementation (m_pimpl) data.  <a href="#116a5bfa2bf4a4fea0f18ef78c8ae337"></a><br></td></tr>
    46. 

  46. <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classrebecca_1_1impl_1_1_string_pimpl.html">StringPimpl</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrebecca_1_1framework_1_1impl_1_1_formal.html#dfa4eaa2ffbfc57855a10e653151d861">getString</a> () const   throw (InternalProgrammerErrorException &amp;)</td></tr>
    47. 

  47. 

  48. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calls <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html#dfa4eaa2ffbfc57855a10e653151d861">InnerTemplateListImpl::getString()</a> and returns a "Formal" transformation on the text.  <a href="#dfa4eaa2ffbfc57855a10e653151d861"></a><br></td></tr>
    49. 

  49. <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrebecca_1_1framework_1_1impl_1_1_formal.html#fce05b2fe2593421dba516e9de4c3fac">~Formal</a> ()</td></tr>
    50. 

  50. 

  51. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default virtual destructor.  <a href="#fce05b2fe2593421dba516e9de4c3fac"></a><br></td></tr>
    52. 

  52. <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
    53. 

  53. <tr><td class="memItemLeft" nowrap align="right" valign="top">shared_ptr&lt; FormalImpl &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrebecca_1_1framework_1_1impl_1_1_formal.html#4582015ce16268e893f214d080dea714">m_pimpl</a></td></tr>
    54. 

  54. 

  55. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The private implementation in which you cannot get access to.  <a href="#4582015ce16268e893f214d080dea714"></a><br></td></tr>
    56. 

  56. </table>
    57. 

  57. <hr><a name="_details"></a><h2>Detailed Description</h2>
    58. 

  58. <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html">AIML</a> class that represents the <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html">AIML</a> XML tag "formal". 
    59. 

  59. <p>
    60. 

  60. Every time a XML <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_tag.html">Tag</a> of <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html">AIML</a> is encountered, an instance of this class will be created. All text inbetween the begin and end tag, all attributes, and all inner Tags will go through methods of this class. 
    61. 

  61. <p>
    62. 

  62. <hr><h2>Constructor &amp; Destructor Documentation</h2>
    63. 

  63. <a class="anchor" name="116a5bfa2bf4a4fea0f18ef78c8ae337"></a><!-- doxytag: member="rebecca::framework::impl::Formal::Formal" ref="116a5bfa2bf4a4fea0f18ef78c8ae337" args="()" --><p>
    64. 

  64. <table class="mdTable" cellpadding="2" cellspacing="0">
    65. 

  65.   <tr>
    66. 

  66.     <td class="mdRow">
    67. 

  67.       <table cellpadding="0" cellspacing="0" border="0">
    68. 

  68.         <tr>
    69. 

  69.           <td class="md" nowrap valign="top"><a class="el" href="classrebecca_1_1framework_1_1impl_1_1_formal.html">Formal</a>           </td>
    70. 

  70.           <td class="md" valign="top">(&nbsp;</td>
    71. 

  71.           <td class="mdname1" valign="top" nowrap>          </td>
    72. 

  72.           <td class="md" valign="top">&nbsp;)&nbsp;</td>
    73. 

  73.           <td class="md" nowrap>  throw (<a class="el" href="classrebecca_1_1impl_1_1_internal_programmer_error_exception.html">InternalProgrammerErrorException</a> &amp;)</td>
    74. 

  74.         </tr>
    75. 

  75.       </table>
    76. 

  76.     </td>
    77. 

  77.   </tr>
    78. 

  78. </table>
    79. 

  79. <table cellspacing="5" cellpadding="0" border="0">
    80. 

  80.   <tr>
    81. 

  81.     <td>
    82. 

  82.       &nbsp;
    83. 

  83.     </td>
    84. 

  84.     <td>
    85. 

  85. 

  86. <p>
    87. 

  87. Default constructor to initalize the private implementation (m_pimpl) data. 
    88. 

  88. <p>
    89. 

  89. <dl compact><dt><b>Exceptions:</b></dt><dd>
    90. 

  90.   <table border="0" cellspacing="2" cellpadding="0">
    91. 

  91.     <tr><td valign="top"></td><td valign="top"><em>InternalProgrammerErrorException</em>&nbsp;</td><td>is thrown only if the error is so grave that the entire <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html">AIML</a> engine has to be shut down. </td></tr>
    92. 

  92.   </table>
    93. 

  93. </dl>
    94. 

  94.     </td>
    95. 

  95.   </tr>
    96. 

  96. </table>
    97. 

  97. <a class="anchor" name="fce05b2fe2593421dba516e9de4c3fac"></a><!-- doxytag: member="rebecca::framework::impl::Formal::~Formal" ref="fce05b2fe2593421dba516e9de4c3fac" args="()" --><p>
    98. 

  98. <table class="mdTable" cellpadding="2" cellspacing="0">
    99. 

  99.   <tr>
    100. 

  100.     <td class="mdRow">
    101. 

  101.       <table cellpadding="0" cellspacing="0" border="0">
    102. 

  102.         <tr>
    103. 

  103.           <td class="md" nowrap valign="top">virtual ~<a class="el" href="classrebecca_1_1framework_1_1impl_1_1_formal.html">Formal</a>           </td>
    104. 

  104.           <td class="md" valign="top">(&nbsp;</td>
    105. 

  105.           <td class="mdname1" valign="top" nowrap>          </td>
    106. 

  106.           <td class="md" valign="top">&nbsp;)&nbsp;</td>
    107. 

  107.           <td class="md" nowrap><code> [virtual]</code></td>
    108. 

  108.         </tr>
    109. 

  109.       </table>
    110. 

  110.     </td>
    111. 

  111.   </tr>
    112. 

  112. </table>
    113. 

  113. <table cellspacing="5" cellpadding="0" border="0">
    114. 

  114.   <tr>
    115. 

  115.     <td>
    116. 

  116.       &nbsp;
    117. 

  117.     </td>
    118. 

  118.     <td>
    119. 

  119. 

  120. <p>
    121. 

  121. Default virtual destructor. 
    122. 

  122. <p>
    123. 

  123. Destroys the private implementation (m_pimpl) data.     </td>
    124. 

  124.   </tr>
    125. 

  125. </table>
    126. 

  126. <hr><h2>Member Function Documentation</h2>
    127. 

  127. <a class="anchor" name="dfa4eaa2ffbfc57855a10e653151d861"></a><!-- doxytag: member="rebecca::framework::impl::Formal::getString" ref="dfa4eaa2ffbfc57855a10e653151d861" args="() const " --><p>
    128. 

  128. <table class="mdTable" cellpadding="2" cellspacing="0">
    129. 

  129.   <tr>
    130. 

  130.     <td class="mdRow">
    131. 

  131.       <table cellpadding="0" cellspacing="0" border="0">
    132. 

  132.         <tr>
    133. 

  133.           <td class="md" nowrap valign="top">virtual <a class="el" href="classrebecca_1_1impl_1_1_string_pimpl.html">StringPimpl</a> getString           </td>
    134. 

  134.           <td class="md" valign="top">(&nbsp;</td>
    135. 

  135.           <td class="mdname1" valign="top" nowrap>          </td>
    136. 

  136.           <td class="md" valign="top">&nbsp;)&nbsp;</td>
    137. 

  137.           <td class="md" nowrap> const  throw (<a class="el" href="classrebecca_1_1impl_1_1_internal_programmer_error_exception.html">InternalProgrammerErrorException</a> &amp;)<code> [virtual]</code></td>
    138. 

  138.         </tr>
    139. 

  139.       </table>
    140. 

  140.     </td>
    141. 

  141.   </tr>
    142. 

  142. </table>
    143. 

  143. <table cellspacing="5" cellpadding="0" border="0">
    144. 

  144.   <tr>
    145. 

  145.     <td>
    146. 

  146.       &nbsp;
    147. 

  147.     </td>
    148. 

  148.     <td>
    149. 

  149. 

  150. <p>
    151. 

  151. Calls <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html#dfa4eaa2ffbfc57855a10e653151d861">InnerTemplateListImpl::getString()</a> and returns a "Formal" transformation on the text. 
    152. 

  152. <p>
    153. 

  153. <dl compact><dt><b>Returns:</b></dt><dd>A "Formal" transformation on the text that comes from <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html#dfa4eaa2ffbfc57855a10e653151d861">InnerTemplateListImpl::getString()</a></dd></dl>
    154. 

  154. <dl compact><dt><b>Exceptions:</b></dt><dd>
    155. 

  155.   <table border="0" cellspacing="2" cellpadding="0">
    156. 

  156.     <tr><td valign="top"></td><td valign="top"><em>InternalProgrammerErrorException</em>&nbsp;</td><td>is thrown only if the error is so grave that the entire <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html">AIML</a> engine has to be shut down. </td></tr>
    157. 

  157.   </table>
    158. 

  158. </dl>
    159. 

  159. 

  160. <p>
    161. 

  161. Reimplemented from <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html#dfa4eaa2ffbfc57855a10e653151d861">InnerTemplateListImpl</a>.    </td>
    162. 

  162.   </tr>
    163. 

  163. </table>
    164. 

  164. <hr><h2>Member Data Documentation</h2>
    165. 

  165. <a class="anchor" name="4582015ce16268e893f214d080dea714"></a><!-- doxytag: member="rebecca::framework::impl::Formal::m_pimpl" ref="4582015ce16268e893f214d080dea714" args="" --><p>
    166. 

  166. <table class="mdTable" cellpadding="2" cellspacing="0">
    167. 

  167.   <tr>
    168. 

  168.     <td class="mdRow">
    169. 

  169.       <table cellpadding="0" cellspacing="0" border="0">
    170. 

  170.         <tr>
    171. 

  171.           <td class="md" nowrap valign="top">shared_ptr&lt;FormalImpl&gt; <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_formal.html#4582015ce16268e893f214d080dea714">m_pimpl</a><code> [private]</code>          </td>
    172. 

  172.         </tr>
    173. 

  173.       </table>
    174. 

  174.     </td>
    175. 

  175.   </tr>
    176. 

  176. </table>
    177. 

  177. <table cellspacing="5" cellpadding="0" border="0">
    178. 

  178.   <tr>
    179. 

  179.     <td>
    180. 

  180.       &nbsp;
    181. 

  181.     </td>
    182. 

  182.     <td>
    183. 

  183. 

  184. <p>
    185. 

  185. The private implementation in which you cannot get access to. 
    186. 

  186. <p>
    187. 

  187. This shared_ptr holds the private methods and private member variables of this class. This makes ABI (Application Binary Interface) more resilient to change. See the private implementation idiom on the internet for more information about this. 
    188. 

  188. <p>
    189. 

  189. Reimplemented from <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html#4582015ce16268e893f214d080dea714">InnerTemplateListImpl</a>.    </td>
    190. 

  190.   </tr>
    191. 

  191. </table>
    192. 

  192. <hr>The documentation for this class was generated from the following file:<ul>
    193. 

  193. <li>C:/rebecca/include/rebecca/framework/<a class="el" href="_formal_8h-source.html">Formal.h</a></ul>
    194. 

  194. <hr size="1"><address style="align: right;"><small>Generated on Wed Jul 26 21:39:07 2006 for RebeccaAIML by&nbsp;
    195. 

  195. <a href="http://www.doxygen.org/index.html">
    196. 

  196. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
    197. 

  197. </body>
    198. 

  198. </html>
    199. 

  199.