PageRenderTime 57ms CodeModel.GetById 27ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/web/doxygen/11tp1/api+framework/html/classrebecca_1_1framework_1_1impl_1_1_system.html

https://github.com/hallowname/librebecca
HTML | 168 lines | 153 code | 14 blank | 1 comment | 0 complexity | 5a2249925246f2111d0eab1cc5ad7492 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=UTF-8">
    3. 

  3. <title>RebeccaAIML: System 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.5.3 -->
    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 class="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>
    17. 

  17. </div>
    18. 

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

  19.   <ul>
    20. 

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

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

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

  23.   </ul>
    24. 

  24. </div>
    25. 

  25. <div class="nav">
    26. 

  26. <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_system.html">System</a></div>
    27. 

  27. <h1>System Class Reference</h1><!-- doxytag: class="rebecca::framework::impl::System" --><!-- doxytag: inherits="rebecca::framework::impl::InnerTemplateListImpl" --><a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html" title="AIML class that represents the AIML XML tag &quot;aiml&quot;.">AIML</a> class that represents the <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html" title="AIML class that represents the AIML XML tag &quot;aiml&quot;.">AIML</a> XML tag "system".  
    28. 

  28. <a href="#_details">More...</a>
    29. 

  29. <p>
    30. 

  30. <code>#include &lt;<a class="el" href="_system_8h-source.html">System.h</a>&gt;</code>
    31. 

  31. <p>
    32. 

  32. <div class="dynheader">
    33. 

  33. Inheritance diagram for System:</div>
    34. 

  34. <div class="dynsection">
    35. 

  35. 

  36. <p><center><img src="classrebecca_1_1framework_1_1impl_1_1_system.png" usemap="#System_map" border="0" alt=""></center>
    37. 

  37. <map name="System_map">
    38. 

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

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

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

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

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

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

  44. </map>
    45. 

  45. </div>
    46. 

  46. 

  47. <p>
    48. 

  48. <a href="classrebecca_1_1framework_1_1impl_1_1_system-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
    49. 

  49. <tr><td></td></tr>
    50. 

  50. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
    51. 

  51. <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_system.html#587c9d6cda3737a781f0f37216436aee">getString</a> () const   throw (InternalProgrammerErrorException &amp;)</td></tr>
    52. 

  52. 

  53. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Executes the command given inbetween its begin and end tag on the current operating system by calling <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html#587c9d6cda3737a781f0f37216436aee" title="Iterates through the internal linked list, calls InnerTemplate::getString() on each...">InnerTemplateListImpl::getString()</a>.  <a href="#587c9d6cda3737a781f0f37216436aee"></a><br></td></tr>
    54. 

  54. <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_system.html#a99f92b482c36f6e72a05b28c3d6f748">System</a> ()  throw (InternalProgrammerErrorException &amp;)</td></tr>
    55. 

  55. 

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

  57. <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_system.html#a7229e118bb766e4752281389b321ed6">~System</a> ()</td></tr>
    58. 

  58. 

  59. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default virtual destructor.  <a href="#a7229e118bb766e4752281389b321ed6"></a><br></td></tr>
    60. 

  60. <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
    61. 

  61. <tr><td class="memItemLeft" nowrap align="right" valign="top">SystemImpl *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrebecca_1_1framework_1_1impl_1_1_system.html#1af988bf7d0fa0ef2c95525e1f364cd6">m_pimpl</a></td></tr>
    62. 

  62. 

  63. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The private implementation in which you cannot get access to.  <a href="#1af988bf7d0fa0ef2c95525e1f364cd6"></a><br></td></tr>
    64. 

  64. </table>
    65. 

  65. <hr><a name="_details"></a><h2>Detailed Description</h2>
    66. 

  66. <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html" title="AIML class that represents the AIML XML tag &quot;aiml&quot;.">AIML</a> class that represents the <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html" title="AIML class that represents the AIML XML tag &quot;aiml&quot;.">AIML</a> XML tag "system". 
    67. 

  67. <p>
    68. 

  68. Every time a XML <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_tag.html" title="The abstract AIML XML Tag class that all other AIML XML tags should inherit from...">Tag</a> of <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html" title="AIML class that represents the AIML XML tag &quot;aiml&quot;.">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. <hr><h2>Constructor &amp; Destructor Documentation</h2>
    69. 

  69. <a class="anchor" name="a99f92b482c36f6e72a05b28c3d6f748"></a><!-- doxytag: member="rebecca::framework::impl::System::System" ref="a99f92b482c36f6e72a05b28c3d6f748" args="()" -->
    70. 

  70. <div class="memitem">
    71. 

  71. <div class="memproto">
    72. 

  72.       <table class="memname">
    73. 

  73.         <tr>
    74. 

  74.           <td class="memname"><a class="el" href="classrebecca_1_1framework_1_1impl_1_1_system.html">System</a>           </td>
    75. 

  75.           <td>(</td>
    76. 

  76.           <td class="paramname">          </td>
    77. 

  77.           <td>&nbsp;)&nbsp;</td>
    78. 

  78.           <td width="100%">  throw (<a class="el" href="classrebecca_1_1impl_1_1_internal_programmer_error_exception.html">InternalProgrammerErrorException</a> &amp;)</td>
    79. 

  79.         </tr>
    80. 

  80.       </table>
    81. 

  81. </div>
    82. 

  82. <div class="memdoc">
    83. 

  83. 

  84. <p>
    85. 

  85. Default constructor to initalize the private implementation (m_pimpl) data. 
    86. 

  86. <p>
    87. 

  87. <dl compact><dt><b>Exceptions:</b></dt><dd>
    88. 

  88.   <table border="0" cellspacing="2" cellpadding="0">
    89. 

  89.     <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" title="AIML class that represents the AIML XML tag &quot;aiml&quot;.">AIML</a> engine has to be shut down. </td></tr>
    90. 

  90.   </table>
    91. 

  91. </dl>
    92. 

  92. 

  93. </div>
    94. 

  94. </div><p>
    95. 

  95. <a class="anchor" name="a7229e118bb766e4752281389b321ed6"></a><!-- doxytag: member="rebecca::framework::impl::System::~System" ref="a7229e118bb766e4752281389b321ed6" args="()" -->
    96. 

  96. <div class="memitem">
    97. 

  97. <div class="memproto">
    98. 

  98.       <table class="memname">
    99. 

  99.         <tr>
    100. 

  100.           <td class="memname">virtual ~<a class="el" href="classrebecca_1_1framework_1_1impl_1_1_system.html">System</a>           </td>
    101. 

  101.           <td>(</td>
    102. 

  102.           <td class="paramname">          </td>
    103. 

  103.           <td>&nbsp;)&nbsp;</td>
    104. 

  104.           <td width="100%"><code> [virtual]</code></td>
    105. 

  105.         </tr>
    106. 

  106.       </table>
    107. 

  107. </div>
    108. 

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

  109. 

  110. <p>
    111. 

  111. Default virtual destructor. 
    112. 

  112. <p>
    113. 

  113. Destroys the private implementation (m_pimpl) data. 
    114. 

  114. </div>
    115. 

  115. </div><p>
    116. 

  116. <hr><h2>Member Function Documentation</h2>
    117. 

  117. <a class="anchor" name="587c9d6cda3737a781f0f37216436aee"></a><!-- doxytag: member="rebecca::framework::impl::System::getString" ref="587c9d6cda3737a781f0f37216436aee" args="() const " -->
    118. 

  118. <div class="memitem">
    119. 

  119. <div class="memproto">
    120. 

  120.       <table class="memname">
    121. 

  121.         <tr>
    122. 

  122.           <td class="memname">virtual <a class="el" href="classrebecca_1_1impl_1_1_string_pimpl.html">StringPimpl</a> getString           </td>
    123. 

  123.           <td>(</td>
    124. 

  124.           <td class="paramname">          </td>
    125. 

  125.           <td>&nbsp;)&nbsp;</td>
    126. 

  126.           <td width="100%"> const  throw (<a class="el" href="classrebecca_1_1impl_1_1_internal_programmer_error_exception.html">InternalProgrammerErrorException</a> &amp;)<code> [virtual]</code></td>
    127. 

  127.         </tr>
    128. 

  128.       </table>
    129. 

  129. </div>
    130. 

  130. <div class="memdoc">
    131. 

  131. 

  132. <p>
    133. 

  133. Executes the command given inbetween its begin and end tag on the current operating system by calling <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html#587c9d6cda3737a781f0f37216436aee" title="Iterates through the internal linked list, calls InnerTemplate::getString() on each...">InnerTemplateListImpl::getString()</a>. 
    134. 

  134. <p>
    135. 

  135. On Linux and Unix systems the shell executing the command will be the default /bin/sh shell. Also on Linux and Unix systems if you have multiple system commands that you want to execute you must seperate them all by semicolons and NOT by new lines in your <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_a_i_m_l.html" title="AIML class that represents the AIML XML tag &quot;aiml&quot;.">AIML</a> code.<p>
    136. 

  136. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns the output from the operating system after executing the command it gets from <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html#587c9d6cda3737a781f0f37216436aee" title="Iterates through the internal linked list, calls InnerTemplate::getString() on each...">InnerTemplateListImpl::getString()</a> </dd></dl>
    137. 

  137. 

  138. <p>Reimplemented from <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html#587c9d6cda3737a781f0f37216436aee">InnerTemplateListImpl</a>.</p>
    139. 

  139. 

  140. </div>
    141. 

  141. </div><p>
    142. 

  142. <hr><h2>Member Data Documentation</h2>
    143. 

  143. <a class="anchor" name="1af988bf7d0fa0ef2c95525e1f364cd6"></a><!-- doxytag: member="rebecca::framework::impl::System::m_pimpl" ref="1af988bf7d0fa0ef2c95525e1f364cd6" args="" -->
    144. 

  144. <div class="memitem">
    145. 

  145. <div class="memproto">
    146. 

  146.       <table class="memname">
    147. 

  147.         <tr>
    148. 

  148.           <td class="memname">SystemImpl* <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_system.html#1af988bf7d0fa0ef2c95525e1f364cd6">m_pimpl</a><code> [private]</code>          </td>
    149. 

  149.         </tr>
    150. 

  150.       </table>
    151. 

  151. </div>
    152. 

  152. <div class="memdoc">
    153. 

  153. 

  154. <p>
    155. 

  155. The private implementation in which you cannot get access to. 
    156. 

  156. <p>
    157. 

  157. This pointer 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. 
    158. 

  158. <p>Reimplemented from <a class="el" href="classrebecca_1_1framework_1_1impl_1_1_inner_template_list_impl.html#9be681eee50cebcef2650e42970d3163">InnerTemplateListImpl</a>.</p>
    159. 

  159. 

  160. </div>
    161. 

  161. </div><p>
    162. 

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

  163. <li>C:/rebecca/include/rebecca/framework/<a class="el" href="_system_8h-source.html">System.h</a></ul>
    164. 

  164. <hr size="1"><address style="text-align: right;"><small>Generated on Mon Aug 27 12:26:49 2007 for RebeccaAIML by&nbsp;
    165. 

  165. <a href="http://www.doxygen.org/index.html">
    166. 

  166. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
    167. 

  167. </body>
    168. 

  168. </html>
    169. 

  169.