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

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • doc/html/classbdm_1_1UI.html

    r354 r368  
    7979<tr><td></td></tr> 
    8080<tr><td colspan="2"><br><h2>Classes</h2></td></tr> 
    81 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><b>Link_Expander</b></td></tr> 
    82  
    8381<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><b>Mapped_UI</b></td></tr> 
    8482 
     83<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI_1_1SettingsResolver.html">SettingsResolver</a></td></tr> 
     84 
    8585<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> 
    86 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="792cae11679b69900ca7c7b99e5288c3"></a><!-- doxytag: member="bdm::UI::ui_error" ref="792cae11679b69900ca7c7b99e5288c3" args="(string message, const Setting &amp;element)" --> 
    87 static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>ui_error</b> (string message, const Setting &amp;element)</td></tr> 
    88  
    89 <tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     86<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="f0eccc7bbe4b680f3e1cb84b455a1125"></a><!-- doxytag: member="bdm::UI::build" ref="f0eccc7bbe4b680f3e1cb84b455a1125" args="(const Setting &amp;element, const int index)" --> 
     87template&lt;class T &gt; </td></tr> 
    9088<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> 
    9189 
    92 <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> 
     90<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> 
    9391<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="dda27449f8bd19d54db9ccfb2644e908"></a><!-- doxytag: member="bdm::UI::build" ref="dda27449f8bd19d54db9ccfb2644e908" args="(const Setting &amp;element, const string &amp;name)" --> 
    9492template&lt;class T &gt; </td></tr> 
    9593<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> 
    9694 
    97 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="32e63fc6ca11603442d46350bb66a76f"></a><!-- doxytag: member="bdm::UI::get" ref="32e63fc6ca11603442d46350bb66a76f" args="(T &amp;instance, const Setting &amp;element, const string &amp;name)" --> 
    98 template&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#32e63fc6ca11603442d46350bb66a76f">get</a> (T &amp;instance, const Setting &amp;element, const string &amp;name)</td></tr> 
    100  
    101 <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="0d197e27bb914fe6cc1ca41b90899742"></a><!-- doxytag: member="bdm::UI::get" ref="0d197e27bb914fe6cc1ca41b90899742" args="(T &amp;instance, const Setting &amp;element, const int index)" --> 
    103 template&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#0d197e27bb914fe6cc1ca41b90899742">get</a> (T &amp;instance, const Setting &amp;element, const int index)</td></tr> 
    105  
    106 <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="7b83f1e2352f9ed7fb65437dd33e2005"></a><!-- doxytag: member="bdm::UI::get" ref="7b83f1e2352f9ed7fb65437dd33e2005" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)" --> 
    108 template&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#7b83f1e2352f9ed7fb65437dd33e2005">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)</td></tr> 
    110  
    111 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr> 
    112 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="472abdce7adb048a40ef3d84ed0f592d"></a><!-- doxytag: member="bdm::UI::get" ref="472abdce7adb048a40ef3d84ed0f592d" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index)" --> 
    113 template&lt;class T &gt; </td></tr> 
    114 <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> 
     95<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="652bfd23f5052e4f1cb317057d74a3e2"></a><!-- doxytag: member="bdm::UI::get" ref="652bfd23f5052e4f1cb317057d74a3e2" args="(T &amp;instance, const Setting &amp;element, const string &amp;name)" --> 
     96template&lt;class T &gt; </td></tr> 
     97<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> 
     98 
     99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr> 
     100<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="3d04bb3d7dbcf0da0b4d5d3d5b7df51a"></a><!-- doxytag: member="bdm::UI::get" ref="3d04bb3d7dbcf0da0b4d5d3d5b7df51a" args="(T &amp;instance, const Setting &amp;element, const int index)" --> 
     101template&lt;class T &gt; </td></tr> 
     102<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> 
     103 
     104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr> 
     105<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="00bb5f2a328d272b0a3ffbda1a902d54"></a><!-- doxytag: member="bdm::UI::get" ref="00bb5f2a328d272b0a3ffbda1a902d54" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)" --> 
     106template&lt;class T &gt; </td></tr> 
     107<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> 
     108 
     109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr> 
     110<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="b6a224b6aea027e167d3d565b39144e0"></a><!-- doxytag: member="bdm::UI::get" ref="b6a224b6aea027e167d3d565b39144e0" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index)" --> 
     111template&lt;class T &gt; </td></tr> 
     112<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> 
    115113 
    116114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr> 
     
    128126 
    129127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double matrix. <br></td></tr> 
    130 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc2afb61a772d8571f7bb19065da4695"></a><!-- doxytag: member="bdm::UI::save" ref="cc2afb61a772d8571f7bb19065da4695" args="(const ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    131 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> 
    132  
    133 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double vec. <br></td></tr> 
     128<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> 
     129 
     130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double vec.  <a href="#cc2afb61a772d8571f7bb19065da4695"></a><br></td></tr> 
     131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d4028226c09da8bdf442c1e183d564e"></a><!-- doxytag: member="bdm::UI::save" ref="7d4028226c09da8bdf442c1e183d564e" args="(const vec &amp;vector, Setting &amp;element, const string &amp;name)" --> 
     132static 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> 
     133 
     134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double vector. <br></td></tr> 
    134135<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> 
    135136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d60234c0673f345424329894b9b0cef8"></a><!-- doxytag: member="bdm::UI::UI" ref="d60234c0673f345424329894b9b0cef8" args="(const string &amp;class_name, const type_info *const class_type_info)" --> 
     
    154155        UserInfo::build&lt;T&gt;(root,<span class="stringliteral">"TT"</span>); 
    155156</pre></div><p> 
    156 UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt; or Particular_UI&lt;T&gt; instead. The raison d'etre of this class is to allow pointers to its templated descendants.Also, the main functions of the whole UserInfo library are included within this class, see static methods 'build' and 'save'.<p> 
    157 /*!Builds computational object from a UserInfo structureReturn value is a pointer to the created object (memory management issue?) / <hr><h2>Member Function Documentation</h2> 
    158 <a class="anchor" name="f0eccc7bbe4b680f3e1cb84b455a1125"></a><!-- doxytag: member="bdm::UI::build" ref="f0eccc7bbe4b680f3e1cb84b455a1125" args="(const Setting &amp;element, const int index)" --> 
     157UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt; or Particular_UI&lt;T&gt; instead. The raison d'etre of this class is to allow pointers to its templated descendants.Also, the main functions of the whole UserInfo library are included within this class, see static methods 'build' and 'save'. <hr><h2>Member Function Documentation</h2> 
     158<a class="anchor" name="cc2afb61a772d8571f7bb19065da4695"></a><!-- doxytag: member="bdm::UI::save" ref="cc2afb61a772d8571f7bb19065da4695" args="(const ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    159159<div class="memitem"> 
    160160<div class="memproto"> 
    161 <div class="memtemplate"> 
    162 template&lt;class T &gt; </div> 
    163161      <table class="memname"> 
    164162        <tr> 
    165           <td class="memname">static T* bdm::UI::build           </td> 
     163          <td class="memname">void bdm::UI::save           </td> 
    166164          <td>(</td> 
    167           <td class="paramtype">const Setting &amp;&nbsp;</td> 
    168           <td class="paramname"> <em>element</em>, </td> 
     165          <td class="paramtype">const ivec &amp;&nbsp;</td> 
     166          <td class="paramname"> <em>vec</em>, </td> 
    169167        </tr> 
    170168        <tr> 
    171169          <td class="paramkey"></td> 
    172170          <td></td> 
    173           <td class="paramtype">const int&nbsp;</td> 
    174           <td class="paramname"> <em>index</em></td><td>&nbsp;</td> 
     171          <td class="paramtype">Setting &amp;&nbsp;</td> 
     172          <td class="paramname"> <em>element</em>, </td> 
     173        </tr> 
     174        <tr> 
     175          <td class="paramkey"></td> 
     176          <td></td> 
     177          <td class="paramtype">const string &amp;&nbsp;</td> 
     178          <td class="paramname"> <em>name</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td> 
    175179        </tr> 
    176180        <tr> 
    177181          <td></td> 
    178182          <td>)</td> 
    179           <td></td><td></td><td><code> [inline, static]</code></td> 
     183          <td></td><td></td><td><code> [static]</code></td> 
    180184        </tr> 
    181185      </table> 
     
    184188 
    185189<p> 
    186 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>.  
    187 <p> 
    188 This methods tries to build a new instance of type T (or some of its descendant types) according to a data stored in a DOMNode named class_name within a child nodes of the passed element. If an ui_error occurs, it returns a NULL pointer.  
     190This methods tries to save a double vec.  
     191<p> 
     192This methods tries to save a integer vector.  
    189193</div> 
    190194</div><p> 
     
    192196<li><a class="el" href="user__info_8h-source.html">user_info.h</a><li>user_info.cpp</ul> 
    193197</div> 
    194 <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:11:01 2009 for mixpp by&nbsp; 
     198<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 8 18:02:35 2009 for mixpp by&nbsp; 
    195199<a href="http://www.doxygen.org/index.html"> 
    196200<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>