Show
Ignore:
Timestamp:
08/29/09 20:54:10 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • library/doc/html/classbdm_1_1UIException.html

    r538 r590  
    7575<tr><td></td></tr> 
    7676<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    77 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="351bfe4a6e8d0288500e3412313f3301"></a><!-- doxytag: member="bdm::UIException::UIException" ref="351bfe4a6e8d0288500e3412313f3301" args="(const string &amp;message, const Setting &amp;element)" --> 
    78 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html#351bfe4a6e8d0288500e3412313f3301">UIException</a> (const string &amp;<a class="el" href="classbdm_1_1UIException.html#82b5104b04c1ed5047a7a344dc702f68">message</a>, const Setting &amp;element)</td></tr> 
     77<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html#7b2b53f2265165deea6f7c0cce1aa770">UIException</a> (const string &amp;message)</td></tr> 
    7978 
    80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Use this constructor when you can pass the problematical Setting as a parameter. <br></td></tr> 
    81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="691e5563c06a1d4d9e02e01a1a187dae"></a><!-- doxytag: member="bdm::UIException::UIException" ref="691e5563c06a1d4d9e02e01a1a187dae" args="(const string &amp;message, const string &amp;path)" --> 
    82 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html#691e5563c06a1d4d9e02e01a1a187dae">UIException</a> (const string &amp;<a class="el" href="classbdm_1_1UIException.html#82b5104b04c1ed5047a7a344dc702f68">message</a>, const string &amp;<a class="el" href="classbdm_1_1UIException.html#c25dbbe6c642e5a70a810673ab9929d2">path</a>)</td></tr> 
    83  
    84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This constructor is for other occasions, when only path of problematical Setting is known. <br></td></tr> 
     79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor.  <a href="#7b2b53f2265165deea6f7c0cce1aa770"></a><br></td></tr> 
    8580<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1bf477e4ea19abb638fe5b883f09218e"></a><!-- doxytag: member="bdm::UIException::what" ref="1bf477e4ea19abb638fe5b883f09218e" args="() const " --> 
    8681virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html#1bf477e4ea19abb638fe5b883f09218e">what</a> () const   throw ()</td></tr> 
    8782 
    88 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overriden method for reporting an error message. <br></td></tr> 
    89 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> 
    90 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="82b5104b04c1ed5047a7a344dc702f68"></a><!-- doxytag: member="bdm::UIException::message" ref="82b5104b04c1ed5047a7a344dc702f68" args="" --> 
    91 const string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html#82b5104b04c1ed5047a7a344dc702f68">message</a></td></tr> 
     83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overriden method for reporting the error message. <br></td></tr> 
     84<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr> 
     85<tr><td class="memItemLeft" nowrap align="right" valign="top">static string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html#864c8a6b9000691ea3e0f2b48b6f9d6a">format_message</a> (const string &amp;reason, const string &amp;path)</td></tr> 
    9286 
    93 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error message. <br></td></tr> 
    94 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c25dbbe6c642e5a70a810673ab9929d2"></a><!-- doxytag: member="bdm::UIException::path" ref="c25dbbe6c642e5a70a810673ab9929d2" args="" --> 
    95 const string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html#c25dbbe6c642e5a70a810673ab9929d2">path</a></td></tr> 
    96  
    97 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Path to the problematic setting. <br></td></tr> 
    9887</table> 
    9988<hr><a name="_details"></a><h2>Detailed Description</h2> 
    100 Exception prepared for reporting user-info errors which are always related to some concrete Setting path<p> 
    101 <a class="el" href="ui_page.html">User Infos and their use</a> <hr>The documentation for this class was generated from the following file:<ul> 
    102 <li><a class="el" href="user__info_8h-source.html">user_info.h</a></ul> 
     89Generic exception for reporting configuration errors<p> 
     90<a class="el" href="ui_page.html">User Infos and their use</a> <hr><h2>Constructor &amp; Destructor Documentation</h2> 
     91<a class="anchor" name="7b2b53f2265165deea6f7c0cce1aa770"></a><!-- doxytag: member="bdm::UIException::UIException" ref="7b2b53f2265165deea6f7c0cce1aa770" args="(const string &amp;message)" --> 
     92<div class="memitem"> 
     93<div class="memproto"> 
     94      <table class="memname"> 
     95        <tr> 
     96          <td class="memname">bdm::UIException::UIException           </td> 
     97          <td>(</td> 
     98          <td class="paramtype">const string &amp;&nbsp;</td> 
     99          <td class="paramname"> <em>message</em>          </td> 
     100          <td>&nbsp;)&nbsp;</td> 
     101          <td><code> [inline]</code></td> 
     102        </tr> 
     103      </table> 
    103104</div> 
    104 <hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 16 17:58:19 2009 for mixpp by&nbsp; 
     105<div class="memdoc"> 
     106 
     107<p> 
     108The constructor.  
     109<p> 
     110<dl compact><dt><b>Parameters:</b></dt><dd> 
     111  <table border="0" cellspacing="2" cellpadding="0"> 
     112    <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>the reason for throwing the exception. Should be a complete English sentence (or a couple sentences), starting with "UIException: ". </td></tr> 
     113  </table> 
     114</dl> 
     115 
     116</div> 
     117</div><p> 
     118<hr><h2>Member Function Documentation</h2> 
     119<a class="anchor" name="864c8a6b9000691ea3e0f2b48b6f9d6a"></a><!-- doxytag: member="bdm::UIException::format_message" ref="864c8a6b9000691ea3e0f2b48b6f9d6a" args="(const string &amp;reason, const string &amp;path)" --> 
     120<div class="memitem"> 
     121<div class="memproto"> 
     122      <table class="memname"> 
     123        <tr> 
     124          <td class="memname">string bdm::UIException::format_message           </td> 
     125          <td>(</td> 
     126          <td class="paramtype">const string &amp;&nbsp;</td> 
     127          <td class="paramname"> <em>reason</em>, </td> 
     128        </tr> 
     129        <tr> 
     130          <td class="paramkey"></td> 
     131          <td></td> 
     132          <td class="paramtype">const string &amp;&nbsp;</td> 
     133          <td class="paramname"> <em>path</em></td><td>&nbsp;</td> 
     134        </tr> 
     135        <tr> 
     136          <td></td> 
     137          <td>)</td> 
     138          <td></td><td></td><td><code> [static, protected]</code></td> 
     139        </tr> 
     140      </table> 
     141</div> 
     142<div class="memdoc"> 
     143 
     144<p> 
     145Formats error messages for derived classes, which use a Setting path in addition to the message.  
     146</div> 
     147</div><p> 
     148<hr>The documentation for this class was generated from the following files:<ul> 
     149<li><a class="el" href="user__info_8h-source.html">user_info.h</a><li>user_info.cpp</ul> 
     150</div> 
     151<hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 20:49:46 2009 for mixpp by&nbsp; 
    105152<a href="http://www.doxygen.org/index.html"> 
    106153<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>