Show
Ignore:
Timestamp:
10/12/09 13:49:39 (15 years ago)
Author:
mido
Message:

\doc directory cleaned a bit

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1ParticularUI.html

    r641 r651  
    1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
    2 <html xmlns="http://www.w3.org/1999/xhtml"> 
    3 <head> 
    4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 
     1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
     2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 
    53<title>mixpp: bdm::ParticularUI&lt; T &gt; Class Template Reference</title> 
    6 <link href="tabs.css" rel="stylesheet" type="text/css"/> 
    7 <link href="doxygen.css" rel="stylesheet" type="text/css"/> 
    8 </head> 
    9 <body> 
    10 <!-- Generated by Doxygen 1.6.1 --> 
     4<link href="tabs.css" rel="stylesheet" type="text/css"> 
     5<link href="doxygen.css" rel="stylesheet" type="text/css"> 
     6</head><body> 
     7<!-- Generated by Doxygen 1.5.9 --> 
    118<script type="text/javascript"> 
    129<!-- 
    … …  
    7168</div> 
    7269<div class="contents"> 
    73 <h1>bdm::ParticularUI&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="bdm::ParticularUI" --><!-- doxytag: inherits="bdm::UI" --><hr/><a name="_details"></a><h2>Detailed Description</h2> 
    74 <h3>template&lt;typename T&gt;<br/> 
     70<h1>bdm::ParticularUI&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="bdm::ParticularUI" --><!-- doxytag: inherits="bdm::UI" --><code>#include &lt;<a class="el" href="user__info_8h_source.html">user_info.h</a>&gt;</code> 
     71<p> 
     72 
     73<p> 
     74<a href="classbdm_1_1ParticularUI-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
     75<tr><td></td></tr> 
     76<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="3a75820d3cad5d2034f25b2252ce6be7"></a><!-- doxytag: member="bdm::ParticularUI::ParticularUI" ref="3a75820d3cad5d2034f25b2252ce6be7" args="(const string &amp;class_name)" --> 
     78&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#3a75820d3cad5d2034f25b2252ce6be7">ParticularUI</a> (const string &amp;class_name)</td></tr> 
     79 
     80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor used by the UIREGISTER macro. <br></td></tr> 
     81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14fea8c7372a3d0a736e4ed0b617702"></a><!-- doxytag: member="bdm::ParticularUI::new_instance" ref="a14fea8c7372a3d0a736e4ed0b617702" args="() const " --> 
     82<a class="el" href="classbdm_1_1root.html">root</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#a14fea8c7372a3d0a736e4ed0b617702">new_instance</a> () const </td></tr> 
     83 
     84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A method returning a brand new instance of class T, this method is the reason why there have to be a parameterless constructor in class T. <br></td></tr> 
     85<tr><td colspan="2"><br><h2>Private Types</h2></td></tr> 
     86<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> { <b>optional</b>,  
     87<b>compulsory</b> 
     88 }</td></tr> 
     89 
     90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enum type used to determine whether the data for concrete Settingis is compulsory or optional. <br></td></tr> 
     91<tr><td colspan="2"><br><h2>Static Private Member Functions</h2></td></tr> 
     92<tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr> 
     93<tr><td colspan="2"><div class="groupText">The type T has to be a <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">bdm::root</a> descendant class <br><br></div></td></tr> 
     94<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     95<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#1f3d45184f803e1256cfc896b43ed2f8">build</a> (const Setting &amp;element, const string &amp;name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
     96 
     97<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     98<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#f02851b299aedeb891e30c4807903081">build</a> (const Setting &amp;element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
     99 
     100<tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr> 
     101<tr><td colspan="2"><div class="groupText">The type T has to be int, double, string, vec, ivec or mat. <br><br></div></td></tr> 
     102<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     103<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#cd1667e6fec99ec64dabcb3ca2ff922d">get</a> (T &amp;instance, const Setting &amp;element, const string &amp;name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
     104 
     105<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     106<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#6fb95ccb13515a3f23080a397dacaa0e">get</a> (T &amp;instance, const Setting &amp;element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
     107 
     108<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="7d2ea138c7285565507fa61fbd9b038f"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="7d2ea138c7285565507fa61fbd9b038f" args="(T &amp;instance, const Setting &amp;element)" --> 
     109template&lt;class T &gt; </td></tr> 
     110<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#7d2ea138c7285565507fa61fbd9b038f">get</a> (T &amp;instance, const Setting &amp;element)</td></tr> 
     111 
     112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element directly. <br></td></tr> 
     113<tr><td colspan="2"><div class="groupHeader">Initialization of arrays Array&lt;T&gt;</div></td></tr> 
     114<tr><td colspan="2"><div class="groupText">The type T has to be int, double, string, vec, ivec or mat, or pointer to any <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant. <br><br></div></td></tr> 
     115<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     116<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#81ce18ed0bb9993a634db2b99612ad66">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
     117 
     118<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     119<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#29e450ed5560f81ef2f845e7b1021b71">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
     120 
     121<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="c9fad8376d2f0857e719511f92f93998"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="c9fad8376d2f0857e719511f92f93998" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)" --> 
     122template&lt;class T &gt; </td></tr> 
     123<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#c9fad8376d2f0857e719511f92f93998">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)</td></tr> 
     124 
     125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element. <br></td></tr> 
     126<tr><td colspan="2"><div class="groupHeader">Serialization of objects and structures into a new Setting</div></td></tr> 
     127<tr><td colspan="2"><div class="groupText">The new child Setting can be accessed either by its name - if some name is passed as a parameter - or by its integer index. In that case, the new element is added at the very end of the current list of child Settings. <br><br></div></td></tr> 
     128<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="c83987949e6a9e79d6e093797ab7d917"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="c83987949e6a9e79d6e093797ab7d917" args="(const T *const instance, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
     129template&lt;class T &gt; </td></tr> 
     130<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#c83987949e6a9e79d6e093797ab7d917">save</a> (const T *const instance, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
     131 
     132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant instance is stored in the new child Setting appended to the passed element. <br></td></tr> 
     133<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="7a307cd313e516b6d5629046dd321039"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="7a307cd313e516b6d5629046dd321039" args="(const shared_ptr&lt; T &gt; &amp;instance, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
     134template&lt;class T &gt; </td></tr> 
     135<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>save</b> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt; &amp;instance, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
     136 
     137<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="4514f93573a9d9126c506d176fbd3163"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="4514f93573a9d9126c506d176fbd3163" args="(const Array&lt; T &gt; &amp;array_to_save, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
     138template&lt;class T &gt; </td></tr> 
     139<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#4514f93573a9d9126c506d176fbd3163">save</a> (const Array&lt; T &gt; &amp;array_to_save, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
     140 
     141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An Array&lt;T&gt; instance is stored in the new child Setting appended to the passed element. <br></td></tr> 
     142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42e908a4f1b09d701be69c8784a02df7"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="42e908a4f1b09d701be69c8784a02df7" args="(const mat &amp;matrix, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
     143static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#42e908a4f1b09d701be69c8784a02df7">save</a> (const mat &amp;matrix, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
     144 
     145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A matrix(of type mat) is stored in the new child Setting appended to the passed element. <br></td></tr> 
     146<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc2afb61a772d8571f7bb19065da4695"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="cc2afb61a772d8571f7bb19065da4695" args="(const ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
     147static 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> 
     148 
     149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An integer vector (of type ivec) is stored in the new child Setting appended to the passed element. <br></td></tr> 
     150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c3b1846b2f29fb70e6a9d789daab808"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="7c3b1846b2f29fb70e6a9d789daab808" args="(const vec &amp;vector, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
     151static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7c3b1846b2f29fb70e6a9d789daab808">save</a> (const vec &amp;vector, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
     152 
     153<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A double vector (of type vec) is stored in the new child Setting appended to the passed element. <br></td></tr> 
     154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c822efd5f8550480d0756352d430c05"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="7c822efd5f8550480d0756352d430c05" args="(const string &amp;str, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
     155static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7c822efd5f8550480d0756352d430c05">save</a> (const string &amp;<a class="el" href="classbdm_1_1str.html">str</a>, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
     156 
     157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A string is stored in the new child Setting appended to the passed element. <br></td></tr> 
     158<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8cd58216bcd732856846d18503c92d48"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="8cd58216bcd732856846d18503c92d48" args="(const int &amp;integer, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
     159static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#8cd58216bcd732856846d18503c92d48">save</a> (const int &amp;integer, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
     160 
     161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An integer is stored in the new child Setting appended to the passed element. <br></td></tr> 
     162<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e943ed7b3e65c9fd2842670fa8cf4a8"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="4e943ed7b3e65c9fd2842670fa8cf4a8" args="(const double &amp;real, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
     163static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#4e943ed7b3e65c9fd2842670fa8cf4a8">save</a> (const double &amp;real, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
     164 
     165<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A double is stored in the new child Setting appended to the passed element. <br></td></tr> 
     166</table> 
     167<hr><a name="_details"></a><h2>Detailed Description</h2> 
     168<h3>template&lt;typename T&gt;<br> 
    75169 class bdm::ParticularUI&lt; T &gt;</h3> 
    76170 
    77 <p>The only <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> descendant class which is not intended for direct use. It should be accessed within the UIREGISTER macro only. <a class="el" href="ui_page.html">User Infos and their use</a> </p> 
    78  
    79 <p><code>#include &lt;<a class="el" href="user__info_8h_source.html">user_info.h</a>&gt;</code></p> 
    80  
    81 <p><a href="classbdm_1_1ParticularUI-members.html">List of all members.</a></p> 
    82 <table border="0" cellpadding="0" cellspacing="0"> 
    83 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> 
    84 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a75820d3cad5d2034f25b2252ce6be7"></a><!-- doxytag: member="bdm::ParticularUI::ParticularUI" ref="a3a75820d3cad5d2034f25b2252ce6be7" args="(const string &amp;class_name)" --> 
    85 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#a3a75820d3cad5d2034f25b2252ce6be7">ParticularUI</a> (const string &amp;class_name)</td></tr> 
    86 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor used by the UIREGISTER macro. <br/></td></tr> 
    87 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa14fea8c7372a3d0a736e4ed0b617702"></a><!-- doxytag: member="bdm::ParticularUI::new_instance" ref="aa14fea8c7372a3d0a736e4ed0b617702" args="() const " --> 
    88 <a class="el" href="classbdm_1_1root.html">root</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#aa14fea8c7372a3d0a736e4ed0b617702">new_instance</a> () const </td></tr> 
    89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A method returning a brand new instance of class T, this method is the reason why there have to be a parameterless constructor in class T. <br/></td></tr> 
    90 <tr><td colspan="2"><h2>Private Types</h2></td></tr> 
    91 <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> { <b>optional</b>,  
    92 <b>compulsory</b> 
    93  }</td></tr> 
    94 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Enum type used to determine whether the data for concrete Settingis is compulsory or optional. </p> 
    95 <br/></td></tr> 
    96 <tr><td colspan="2"><h2>Static Private Member Functions</h2></td></tr> 
    97 <tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr> 
    98 <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp3a55e6a2ce460fc0ef4560883d62c9a8"></a> The type T has to be a <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">bdm::root</a> descendant class </p> 
    99 <br/><br/></div></td></tr> 
    100 <tr><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr> 
    101 <tr><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a1f3d45184f803e1256cfc896b43ed2f8">build</a> (const Setting &amp;element, const string &amp;name, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
    102 <tr><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr> 
    103 <tr><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#af02851b299aedeb891e30c4807903081">build</a> (const Setting &amp;element, const int index, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
    104 <tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr> 
    105 <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp2f6254f904d5aa502f9248135b8a1928"></a> The type T has to be int, double, string, vec, ivec or mat. </p> 
    106 <br/><br/></div></td></tr> 
    107 <tr><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr> 
    108 <tr><td class="memTemplItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#acd1667e6fec99ec64dabcb3ca2ff922d">get</a> (T &amp;instance, const Setting &amp;element, const string &amp;name, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
    109 <tr><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr> 
    110 <tr><td class="memTemplItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a6fb95ccb13515a3f23080a397dacaa0e">get</a> (T &amp;instance, const Setting &amp;element, const int index, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
    111 <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a7d2ea138c7285565507fa61fbd9b038f"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="a7d2ea138c7285565507fa61fbd9b038f" args="(T &amp;instance, const Setting &amp;element)" --> 
    112 template&lt;class T &gt; </td></tr> 
    113 <tr><td class="memTemplItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a7d2ea138c7285565507fa61fbd9b038f">get</a> (T &amp;instance, const Setting &amp;element)</td></tr> 
    114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element directly. <br/></td></tr> 
    115 <tr><td colspan="2"><div class="groupHeader">Initialization of arrays Array&lt;T&gt;</div></td></tr> 
    116 <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpdc7b7e904f3afe234da7899219782a1e"></a> The type T has to be int, double, string, vec, ivec or mat, or pointer to any <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant. </p> 
    117 <br/><br/></div></td></tr> 
    118 <tr><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr> 
    119 <tr><td class="memTemplItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a81ce18ed0bb9993a634db2b99612ad66">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
    120 <tr><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr> 
    121 <tr><td class="memTemplItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a29e450ed5560f81ef2f845e7b1021b71">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index, <a class="el" href="classbdm_1_1UI.html#a88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
    122 <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ac9fad8376d2f0857e719511f92f93998"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="ac9fad8376d2f0857e719511f92f93998" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)" --> 
    123 template&lt;class T &gt; </td></tr> 
    124 <tr><td class="memTemplItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#ac9fad8376d2f0857e719511f92f93998">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)</td></tr> 
    125 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element. <br/></td></tr> 
    126 <tr><td colspan="2"><div class="groupHeader">Serialization of objects and structures into a new Setting</div></td></tr> 
    127 <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpbcd9e02fd9946d6ed8c1fbff1006b520"></a> The new child Setting can be accessed either by its name - if some name is passed as a parameter - or by its integer index. In that case, the new element is added at the very end of the current list of child Settings. </p> 
    128 <br/><br/></div></td></tr> 
    129 <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ac83987949e6a9e79d6e093797ab7d917"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="ac83987949e6a9e79d6e093797ab7d917" args="(const T *const instance, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    130 template&lt;class T &gt; </td></tr> 
    131 <tr><td class="memTemplItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#ac83987949e6a9e79d6e093797ab7d917">save</a> (const T *const instance, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
    132 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant instance is stored in the new child Setting appended to the passed element. <br/></td></tr> 
    133 <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a7a307cd313e516b6d5629046dd321039"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a7a307cd313e516b6d5629046dd321039" args="(const shared_ptr&lt; T &gt; &amp;instance, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    134 template&lt;class T &gt; </td></tr> 
    135 <tr><td class="memTemplItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>save</b> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; T &gt; &amp;instance, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
    136 <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a4514f93573a9d9126c506d176fbd3163"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a4514f93573a9d9126c506d176fbd3163" args="(const Array&lt; T &gt; &amp;array_to_save, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    137 template&lt;class T &gt; </td></tr> 
    138 <tr><td class="memTemplItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a4514f93573a9d9126c506d176fbd3163">save</a> (const Array&lt; T &gt; &amp;array_to_save, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
    139 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An Array&lt;T&gt; instance is stored in the new child Setting appended to the passed element. <br/></td></tr> 
    140 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42e908a4f1b09d701be69c8784a02df7"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a42e908a4f1b09d701be69c8784a02df7" args="(const mat &amp;matrix, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    141 static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a42e908a4f1b09d701be69c8784a02df7">save</a> (const mat &amp;matrix, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
    142 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A matrix(of type mat) is stored in the new child Setting appended to the passed element. <br/></td></tr> 
    143 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc2afb61a772d8571f7bb19065da4695"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="acc2afb61a772d8571f7bb19065da4695" args="(const ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    144 static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#acc2afb61a772d8571f7bb19065da4695">save</a> (const ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
    145 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An integer vector (of type ivec) is stored in the new child Setting appended to the passed element. <br/></td></tr> 
    146 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c3b1846b2f29fb70e6a9d789daab808"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a7c3b1846b2f29fb70e6a9d789daab808" args="(const vec &amp;vector, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    147 static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a7c3b1846b2f29fb70e6a9d789daab808">save</a> (const vec &amp;vector, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
    148 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A double vector (of type vec) is stored in the new child Setting appended to the passed element. <br/></td></tr> 
    149 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c822efd5f8550480d0756352d430c05"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a7c822efd5f8550480d0756352d430c05" args="(const string &amp;str, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    150 static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a7c822efd5f8550480d0756352d430c05">save</a> (const string &amp;<a class="el" href="classbdm_1_1str.html">str</a>, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
    151 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A string is stored in the new child Setting appended to the passed element. <br/></td></tr> 
    152 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cd58216bcd732856846d18503c92d48"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a8cd58216bcd732856846d18503c92d48" args="(const int &amp;integer, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    153 static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a8cd58216bcd732856846d18503c92d48">save</a> (const int &amp;integer, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
    154 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An integer is stored in the new child Setting appended to the passed element. <br/></td></tr> 
    155 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e943ed7b3e65c9fd2842670fa8cf4a8"></a><!-- doxytag: member="bdm::ParticularUI::save" ref="a4e943ed7b3e65c9fd2842670fa8cf4a8" args="(const double &amp;real, Setting &amp;element, const string &amp;name=&quot;&quot;)" --> 
    156 static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a4e943ed7b3e65c9fd2842670fa8cf4a8">save</a> (const double &amp;real, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr> 
    157 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A double is stored in the new child Setting appended to the passed element. <br/></td></tr> 
    158 </table> 
    159 <hr/>The documentation for this class was generated from the following file:<ul> 
    160 <li><a class="el" href="user__info_8h_source.html">user_info.h</a></li> 
    161 </ul> 
     171The only <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> descendant class which is not intended for direct use. It should be accessed within the UIREGISTER macro only. <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> 
     172<li><a class="el" href="user__info_8h_source.html">user_info.h</a></ul> 
    162173</div> 
    163 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 27 00:49:05 2009 for mixpp by&nbsp; 
     174<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:46 2009 for mixpp by&nbsp; 
    164175<a href="http://www.doxygen.org/index.html"> 
    165 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> 
     176<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    166177</body> 
    167178</html>