root/doc/html/classbdm_1_1UI.html @ 353

Revision 353, 16.1 kB (checked in by smidl, 16 years ago)

doc

Line 
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">
3<title>mixpp: bdm::UI Class Reference</title>
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.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1UI.html">UI</a>
68  </div>
69</div>
70<div class="contents">
71<h1>bdm::UI Class Reference</h1><!-- doxytag: class="bdm::UI" -->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. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="user__info_8h-source.html">user_info.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classbdm_1_1UI-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<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>Class_To_UI</b></td></tr>
82
83<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><b>Link_Expander</b></td></tr>
84
85<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)" -->
87static 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>
90<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#946a134eecd2da41c36cb53a371afa57">build</a> (Setting &amp;element, const int index)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prototype of a <a class="el" href="classbdm_1_1UI.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt;...">UI</a> builder. Return value is by the second argument since it type checking via <code>dynamic_cast</code>.  <a href="#946a134eecd2da41c36cb53a371afa57"></a><br></td></tr>
93<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="98baf84be72bcbcc79c61bf4c8619252"></a><!-- doxytag: member="bdm::UI::build" ref="98baf84be72bcbcc79c61bf4c8619252" args="(Setting &amp;element, const string &amp;name)" -->
94template&lt;class T &gt; </td></tr>
95<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>build</b> (Setting &amp;element, const string &amp;name)</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 void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#a86192d0fee67cc5b6f1eabe2bd0732a">save</a> (T &amp;instance, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
99
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fbba3fc8cf76b1aa297297a9cbf8f03"></a><!-- doxytag: member="bdm::UI::get" ref="7fbba3fc8cf76b1aa297297a9cbf8f03" args="(mat &amp;matrix, const Setting &amp;element, const string &amp;name)" -->
101static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7fbba3fc8cf76b1aa297297a9cbf8f03">get</a> (mat &amp;matrix, const Setting &amp;element, const string &amp;name)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05e62b97a2df97510af794716eb6c37a"></a><!-- doxytag: member="bdm::UI::get" ref="05e62b97a2df97510af794716eb6c37a" args="(mat &amp;matrix, const Setting &amp;element, const int index)" -->
105static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#05e62b97a2df97510af794716eb6c37a">get</a> (mat &amp;matrix, const Setting &amp;element, const int index)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double matrix. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8ba9b7294f2041fd31107726ef735f78"></a><!-- doxytag: member="bdm::UI::save" ref="8ba9b7294f2041fd31107726ef735f78" args="(mat &amp;matrix, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
109static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#8ba9b7294f2041fd31107726ef735f78">save</a> (mat &amp;matrix, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double matrix. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0eab3627b6a14b932ebde0e5a3d9cad4"></a><!-- doxytag: member="bdm::UI::get" ref="0eab3627b6a14b932ebde0e5a3d9cad4" args="(ivec &amp;vec, const Setting &amp;element, const string &amp;name)" -->
113static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#0eab3627b6a14b932ebde0e5a3d9cad4">get</a> (ivec &amp;vec, const Setting &amp;element, const string &amp;name)</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double vec. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de1ff787bb1c2fe8b000189d435575af"></a><!-- doxytag: member="bdm::UI::get" ref="de1ff787bb1c2fe8b000189d435575af" args="(ivec &amp;vec, const Setting &amp;element, const int index)" -->
117static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#de1ff787bb1c2fe8b000189d435575af">get</a> (ivec &amp;vec, const Setting &amp;element, const int index)</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double vec. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1524f48ac7c08f5dc339853584c2ad9f"></a><!-- doxytag: member="bdm::UI::save" ref="1524f48ac7c08f5dc339853584c2ad9f" args="(ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
121static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#1524f48ac7c08f5dc339853584c2ad9f">save</a> (ivec &amp;vec, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double vec. <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="990baf528b3a87609475ce91931b2a99"></a><!-- doxytag: member="bdm::UI::get" ref="990baf528b3a87609475ce91931b2a99" args="(Array&lt; string &gt; &amp;string_array, const Setting &amp;element, const string &amp;name)" -->
125static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#990baf528b3a87609475ce91931b2a99">get</a> (<a class="el" href="classitpp_1_1Array.html">Array</a>&lt; string &gt; &amp;string_array, const Setting &amp;element, const string &amp;name)</td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double string_array. <br></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b6f3d40865e53e7adf7da95e11bc776"></a><!-- doxytag: member="bdm::UI::get" ref="3b6f3d40865e53e7adf7da95e11bc776" args="(Array&lt; string &gt; &amp;string_array, const Setting &amp;element, const int index)" -->
129static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#3b6f3d40865e53e7adf7da95e11bc776">get</a> (<a class="el" href="classitpp_1_1Array.html">Array</a>&lt; string &gt; &amp;string_array, const Setting &amp;element, const int index)</td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to build a new double string_array. <br></td></tr>
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="367963d85dbafd3d4d3af0a5aefb161a"></a><!-- doxytag: member="bdm::UI::save" ref="367963d85dbafd3d4d3af0a5aefb161a" args="(Array&lt; string &gt; &amp;string_array, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
133static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#367963d85dbafd3d4d3af0a5aefb161a">save</a> (<a class="el" href="classitpp_1_1Array.html">Array</a>&lt; string &gt; &amp;string_array, Setting &amp;element, const string &amp;name=&quot;&quot;)</td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This methods tries to save a double string_array. <br></td></tr>
136<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4be507739428757eee17f40a594cab3"></a><!-- doxytag: member="bdm::UI::UI" ref="b4be507739428757eee17f40a594cab3" args="(const string &amp;class_name)" -->
138&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#b4be507739428757eee17f40a594cab3">UI</a> (const string &amp;class_name)</td></tr>
139
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br></td></tr>
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95a5a0e160bf21357f99a9291b0b5e88"></a><!-- doxytag: member="bdm::UI::~UI" ref="95a5a0e160bf21357f99a9291b0b5e88" args="()" -->
142virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#95a5a0e160bf21357f99a9291b0b5e88">~UI</a> ()</td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual destructor for future use;. <br></td></tr>
145</table>
146<hr><a name="_details"></a><h2>Detailed Description</h2>
147UserInfo 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.
148<p>
149Also, the main functions of the whole UserInfo library are included within this class, see static methods 'build' and 'save'.<p>
150/*!Builds computational object from a UserInfo structureReturn value is a pointer to the created object (memory management issue?) / <hr><h2>Member Function Documentation</h2>
151<a class="anchor" name="946a134eecd2da41c36cb53a371afa57"></a><!-- doxytag: member="bdm::UI::build" ref="946a134eecd2da41c36cb53a371afa57" args="(Setting &amp;element, const int index)" -->
152<div class="memitem">
153<div class="memproto">
154<div class="memtemplate">
155template&lt;class T &gt; </div>
156      <table class="memname">
157        <tr>
158          <td class="memname">static T* bdm::UI::build           </td>
159          <td>(</td>
160          <td class="paramtype">Setting &amp;&nbsp;</td>
161          <td class="paramname"> <em>element</em>, </td>
162        </tr>
163        <tr>
164          <td class="paramkey"></td>
165          <td></td>
166          <td class="paramtype">const int&nbsp;</td>
167          <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
168        </tr>
169        <tr>
170          <td></td>
171          <td>)</td>
172          <td></td><td></td><td><code> [inline, static]</code></td>
173        </tr>
174      </table>
175</div>
176<div class="memdoc">
177
178<p>
179Prototype of a <a class="el" href="classbdm_1_1UI.html" title="UserInfo is an abstract is for internal purposes only. Use CompoundUserInfo&lt;T&gt;...">UI</a> builder. Return value is by the second argument since it type checking via <code>dynamic_cast</code>.
180<p>
181This 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.
182</div>
183</div><p>
184<a class="anchor" name="a86192d0fee67cc5b6f1eabe2bd0732a"></a><!-- doxytag: member="bdm::UI::save" ref="a86192d0fee67cc5b6f1eabe2bd0732a" args="(T &amp;instance, Setting &amp;element, const string &amp;name=&quot;&quot;)" -->
185<div class="memitem">
186<div class="memproto">
187<div class="memtemplate">
188template&lt;class T &gt; </div>
189      <table class="memname">
190        <tr>
191          <td class="memname">static void bdm::UI::save           </td>
192          <td>(</td>
193          <td class="paramtype">T &amp;&nbsp;</td>
194          <td class="paramname"> <em>instance</em>, </td>
195        </tr>
196        <tr>
197          <td class="paramkey"></td>
198          <td></td>
199          <td class="paramtype">Setting &amp;&nbsp;</td>
200          <td class="paramname"> <em>element</em>, </td>
201        </tr>
202        <tr>
203          <td class="paramkey"></td>
204          <td></td>
205          <td class="paramtype">const string &amp;&nbsp;</td>
206          <td class="paramname"> <em>name</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td>
207        </tr>
208        <tr>
209          <td></td>
210          <td>)</td>
211          <td></td><td></td><td><code> [inline, static]</code></td>
212        </tr>
213      </table>
214</div>
215<div class="memdoc">
216
217<p>
218This methods tries to save an instance of type T (or some of its descendant types) and build DOM tree accordingly. Then, it creates a new DOMNode named according class_name and connecti it to the passed Setting as a new child node.
219</div>
220</div><p>
221<hr>The documentation for this class was generated from the following file:<ul>
222<li><a class="el" href="user__info_8h-source.html">user_info.h</a></ul>
223</div>
224<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 2009 for mixpp by&nbsp;
225<a href="http://www.doxygen.org/index.html">
226<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
227</body>
228</html>
Note: See TracBrowser for help on using the browser.