Show
Ignore:
Timestamp:
06/08/09 18:02:55 (16 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/html/classbdm_1_1Particular__UI.html

    r354 r368  
    7878<a href="classbdm_1_1Particular__UI-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
    7979<tr><td></td></tr> 
     80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
     81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eae5c94852df80078c33d316466c18a3"></a><!-- doxytag: member="bdm::Particular_UI::Particular_UI" ref="eae5c94852df80078c33d316466c18a3" args="(const string &amp;class_name)" --> 
     82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Particular__UI.html#eae5c94852df80078c33d316466c18a3">Particular_UI</a> (const string &amp;class_name)</td></tr> 
     83 
     84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor, which is intentionally declared as private <br></td></tr> 
     85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6ae004150ae2de7645c62219c74340ff"></a><!-- doxytag: member="bdm::Particular_UI::new_instance" ref="6ae004150ae2de7645c62219c74340ff" args="() const " --> 
     86<a class="el" href="classbdm_1_1bdmroot.html">bdmroot</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Particular__UI.html#6ae004150ae2de7645c62219c74340ff">new_instance</a> () const </td></tr> 
     87 
     88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">internal method assembling a typeless instance from components obtained by the 'AssemblyComponentsFromSetting()' method <br></td></tr> 
     89<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr> 
     90<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classbdm_1_1Particular__UI.html">Particular_UI</a>&lt; T &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1Particular__UI.html#ca33b00e0c341706003930c4b20a1e36">ui</a></td></tr> 
     91 
    8092<tr><td colspan="2"><br><h2>Static Private Member Functions</h2></td></tr> 
    81 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="792cae11679b69900ca7c7b99e5288c3"></a><!-- doxytag: member="bdm::Particular_UI::ui_error" ref="792cae11679b69900ca7c7b99e5288c3" args="(string message, const Setting &amp;element)" --> 
    82 static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>ui_error</b> (string message, const Setting &amp;element)</td></tr> 
    83  
    84 <tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     93<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="f0eccc7bbe4b680f3e1cb84b455a1125"></a><!-- doxytag: member="bdm::Particular_UI::build" ref="f0eccc7bbe4b680f3e1cb84b455a1125" args="(const Setting &amp;element, const int index)" --> 
     94template&lt;class T &gt; </td></tr> 
    8595<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#f0eccc7bbe4b680f3e1cb84b455a1125">build</a> (const Setting &amp;element, const int index)</td></tr> 
    8696 
    87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prototype of a <a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">UI</a> builder. Return value is by the second argument since it type checking via <code>dynamic_cast</code>.  <a href="#f0eccc7bbe4b680f3e1cb84b455a1125"></a><br></td></tr> 
     97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prototype of a <a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">UI</a> builder. Return value is by the second argument since it type checking via <code>dynamic_cast</code>. <br></td></tr> 
    8898<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="dda27449f8bd19d54db9ccfb2644e908"></a><!-- doxytag: member="bdm::Particular_UI::build" ref="dda27449f8bd19d54db9ccfb2644e908" args="(const Setting &amp;element, const string &amp;name)" --> 
    8999template&lt;class T &gt; </td></tr> 
    90100<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>build</b> (const Setting &amp;element, const string &amp;name)</td></tr> 
    91101 
    92 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="32e63fc6ca11603442d46350bb66a76f"></a><!-- doxytag: member="bdm::Particular_UI::get" ref="32e63fc6ca11603442d46350bb66a76f" args="(T &amp;instance, const Setting &amp;element, const string &amp;name)" --> 
     102<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="652bfd23f5052e4f1cb317057d74a3e2"></a><!-- doxytag: member="bdm::Particular_UI::get" ref="652bfd23f5052e4f1cb317057d74a3e2" args="(T &amp;instance, const Setting &amp;element, const string &amp;name)" --> 
    93103template&lt;class T &gt; </td></tr> 
    94 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#32e63fc6ca11603442d46350bb66a76f">get</a> (T &amp;instance, const Setting &amp;element, const string &amp;name)</td></tr> 
     104<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#652bfd23f5052e4f1cb317057d74a3e2">get</a> (T &amp;instance, const Setting &amp;element, const string &amp;name)</td></tr> 
    95105 
    96106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr> 
    97 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="0d197e27bb914fe6cc1ca41b90899742"></a><!-- doxytag: member="bdm::Particular_UI::get" ref="0d197e27bb914fe6cc1ca41b90899742" args="(T &amp;instance, const Setting &amp;element, const int index)" --> 
     107<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="3d04bb3d7dbcf0da0b4d5d3d5b7df51a"></a><!-- doxytag: member="bdm::Particular_UI::get" ref="3d04bb3d7dbcf0da0b4d5d3d5b7df51a" args="(T &amp;instance, const Setting &amp;element, const int index)" --> 
    98108template&lt;class T &gt; </td></tr> 
    99 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#0d197e27bb914fe6cc1ca41b90899742">get</a> (T &amp;instance, const Setting &amp;element, const int index)</td></tr> 
     109<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#3d04bb3d7dbcf0da0b4d5d3d5b7df51a">get</a> (T &amp;instance, const Setting &amp;element, const int index)</td></tr> 
    100110 
    101111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr> 
    102 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="7b83f1e2352f9ed7fb65437dd33e2005"></a><!-- doxytag: member="bdm::Particular_UI::get" ref="7b83f1e2352f9ed7fb65437dd33e2005" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)" --> 
     112<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="00bb5f2a328d272b0a3ffbda1a902d54"></a><!-- doxytag: member="bdm::Particular_UI::get" ref="00bb5f2a328d272b0a3ffbda1a902d54" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)" --> 
    103113template&lt;class T &gt; </td></tr> 
    104 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7b83f1e2352f9ed7fb65437dd33e2005">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)</td></tr> 
     114<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#00bb5f2a328d272b0a3ffbda1a902d54">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)</td></tr> 
    105115 
    106116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr> 
    107 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="472abdce7adb048a40ef3d84ed0f592d"></a><!-- doxytag: member="bdm::Particular_UI::get" ref="472abdce7adb048a40ef3d84ed0f592d" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index)" --> 
     117<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="b6a224b6aea027e167d3d565b39144e0"></a><!-- doxytag: member="bdm::Particular_UI::get" ref="b6a224b6aea027e167d3d565b39144e0" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index)" --> 
    108118template&lt;class T &gt; </td></tr> 
    109 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#472abdce7adb048a40ef3d84ed0f592d">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index)</td></tr> 
     119<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#b6a224b6aea027e167d3d565b39144e0">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index)</td></tr> 
    110120 
    111121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr> 
     
    123133 
    124134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double matrix. <br></td></tr> 
    125 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc2afb61a772d8571f7bb19065da4695"></a><!-- doxytag: member="bdm::Particular_UI::save" ref="cc2afb61a772d8571f7bb19065da4695" args="(const ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    126 static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#cc2afb61a772d8571f7bb19065da4695">save</a> (const ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
     135<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#cc2afb61a772d8571f7bb19065da4695">save</a> (const ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
    127136 
    128 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double vec. <br></td></tr> 
     137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double vec.  <a href="#cc2afb61a772d8571f7bb19065da4695"></a><br></td></tr> 
     138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d4028226c09da8bdf442c1e183d564e"></a><!-- doxytag: member="bdm::Particular_UI::save" ref="7d4028226c09da8bdf442c1e183d564e" args="(const vec &amp;vector, Setting &amp;element, const string &amp;name)" --> 
     139static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7d4028226c09da8bdf442c1e183d564e">save</a> (const vec &amp;vector, Setting &amp;element, const string &amp;name)</td></tr> 
     140 
     141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double vector. <br></td></tr> 
    129142</table> 
    130143<hr><a name="_details"></a><h2>Detailed Description</h2> 
     
    132145 class bdm::Particular_UI&lt; T &gt;</h3> 
    133146 
    134 The main userinfo template class. You should derive this class whenever you need a new userinfo of a class which is compound from smaller elements (all having its own userinfo class prepared). <hr>The documentation for this class was generated from the following file:<ul> 
     147The main userinfo template class. You should derive this class whenever you need a new userinfo of a class which is compound from smaller elements (all having its own userinfo class prepared). <hr><h2>Member Data Documentation</h2> 
     148<a class="anchor" name="ca33b00e0c341706003930c4b20a1e36"></a><!-- doxytag: member="bdm::Particular_UI::ui" ref="ca33b00e0c341706003930c4b20a1e36" args="" --> 
     149<div class="memitem"> 
     150<div class="memproto"> 
     151<div class="memtemplate"> 
     152template&lt;typename T &gt; </div> 
     153      <table class="memname"> 
     154        <tr> 
     155          <td class="memname">const <a class="el" href="classbdm_1_1Particular__UI.html">Particular_UI</a>&lt;T&gt;&amp; <a class="el" href="classbdm_1_1Particular__UI.html">bdm::Particular_UI</a>&lt; T &gt;::<a class="el" href="classbdm_1_1Particular__UI.html#ca33b00e0c341706003930c4b20a1e36">ui</a><code> [static]</code>          </td> 
     156        </tr> 
     157      </table> 
     158</div> 
     159<div class="memdoc"> 
     160 
     161<p> 
     162the only instance of this class (each type T has its own instance) which is used as a factory for processing related <a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">UI</a>  
     163</div> 
     164</div><p> 
     165<hr>The documentation for this class was generated from the following file:<ul> 
    135166<li><a class="el" href="user__info_8h-source.html">user_info.h</a></ul> 
    136167</div> 
    137 <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:11:01 2009 for mixpp by&nbsp; 
     168<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 8 18:02:35 2009 for mixpp by&nbsp; 
    138169<a href="http://www.doxygen.org/index.html"> 
    139170<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>