root/library/doc/html/user__info_8h.html @ 652

Revision 651, 10.4 kB (checked in by mido, 15 years ago)

\doc directory cleaned a bit

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: user_info.h File 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.9 -->
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="annotated.html"><span>Classes</span></a></li>
55      <li class="current"><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
61      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
62    </ul>
63  </div>
64</div>
65<div class="contents">
66<h1>user_info.h File Reference</h1>UI (user info) class for loading/saving objects from/to configuration files. It is designed with use of libconfig C/C++ Configuration File Library <a class="el" href="ui_page.html">User Infos and their use</a>. 
67<a href="#_details">More...</a>
68<p>
69<code>#include &lt;stdio.h&gt;</code><br>
70<code>#include &lt;string&gt;</code><br>
71<code>#include &lt;typeinfo&gt;</code><br>
72<code>#include &lt;map&gt;</code><br>
73<code>#include &lt;stdexcept&gt;</code><br>
74<code>#include &quot;libconfig/libconfig.h++&quot;</code><br>
75<code>#include &quot;<a class="el" href="bdmroot_8h_source.html">../bdmroot.h</a>&quot;</code><br>
76<code>#include &quot;<a class="el" href="shared__ptr_8h_source.html">../shared_ptr.h</a>&quot;</code><br>
77<code>#include &quot;itpp/itbase.h&quot;</code><br>
78
79<p>
80<a href="user__info_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
81<tr><td></td></tr>
82<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIException.html">bdm::UIException</a></td></tr>
84
85<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UISettingException.html">bdm::UISettingException</a></td></tr>
86
87<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIClassException.html">bdm::UIClassException</a></td></tr>
88
89<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html">bdm::UIFile</a></td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This class serves to load and/or save user-infos into/from configuration files stored on a hard-disk.  <a href="classbdm_1_1UIFile.html#_details">More...</a><br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1SettingResolver.html">bdm::SettingResolver</a></td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This class serves to expand links used within configuration files.  <a href="classbdm_1_1SettingResolver.html#_details">More...</a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html">bdm::UI</a></td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><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> is an abstract class which collects all the auxiliary functions useful to prepare some concrete user-infos.  <a href="classbdm_1_1UI.html#_details">More...</a><br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><b>bdm::UI::MappedUI</b></td></tr>
99
100<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html">bdm::ParticularUI&lt; T &gt;</a></td></tr>
101
102<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="user__info_8h.html#4f9de2f17e844047726487b99def99c6">UIREGISTER</a>(class_name)&nbsp;&nbsp;&nbsp;static <a class="el" href="classbdm_1_1ParticularUI.html">bdm::ParticularUI</a>&lt;class_name&gt; UI##class_name(#class_name)</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Macro for registration of class into map of user-infos, registered class is scriptable using UI static methods.  <a href="#4f9de2f17e844047726487b99def99c6"></a><br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="852592d44ce65a0a870c76b42155aaca"></a><!-- doxytag: member="user_info.h::QUOTEME" ref="852592d44ce65a0a870c76b42155aaca" args="(x)" -->
107#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="user__info_8h.html#852592d44ce65a0a870c76b42155aaca">QUOTEME</a>(x)&nbsp;&nbsp;&nbsp;#x</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Instrumental macro for UIREGISTER2. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="user__info_8h.html#b06f1e7c44a8306e321f62a0099210b9">UIREGISTER2</a>(class_name, temp_name)&nbsp;&nbsp;&nbsp;static <a class="el" href="classbdm_1_1ParticularUI.html">bdm::ParticularUI</a>&lt;class_name&lt;temp_name&gt; &gt; UI##class_name##_##temp_name( QUOTEME(class_name&lt;temp_name&gt;) )</td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Variant of UIREGISTER for templated classes.  <a href="#b06f1e7c44a8306e321f62a0099210b9"></a><br></td></tr>
113</table>
114<hr><h2>Detailed Description</h2>
115UI (user info) class for loading/saving objects from/to configuration files. It is designed with use of libconfig C/C++ Configuration File Library <a class="el" href="ui_page.html">User Infos and their use</a>.
116<p>
117<dl class="author" compact><dt><b>Author:</b></dt><dd>Vaclav Smidl.</dd></dl>
118----------------------------------- BDM++ - C++ library for Bayesian Decision Making under Uncertainty<p>
119Using IT++ for numerical operations ----------------------------------- <hr><h2>Define Documentation</h2>
120<a class="anchor" name="4f9de2f17e844047726487b99def99c6"></a><!-- doxytag: member="user_info.h::UIREGISTER" ref="4f9de2f17e844047726487b99def99c6" args="(class_name)" -->
121<div class="memitem">
122<div class="memproto">
123      <table class="memname">
124        <tr>
125          <td class="memname">#define UIREGISTER          </td>
126          <td>(</td>
127          <td class="paramtype">class_name&nbsp;</td>
128          <td class="paramname">          </td>
129          <td>&nbsp;)&nbsp;</td>
130          <td>&nbsp;&nbsp;&nbsp;static <a class="el" href="classbdm_1_1ParticularUI.html">bdm::ParticularUI</a>&lt;class_name&gt; UI##class_name(#class_name)</td>
131        </tr>
132      </table>
133</div>
134<div class="memdoc">
135
136<p>
137Macro for registration of class into map of user-infos, registered class is scriptable using UI static methods.
138<p>
139Argument <em>class_name</em> has to be a descendant of root class and also to have a default constructor. This macro should be used in header file, immediately after a class declaration.<p>
140<a class="el" href="ui_page.html">User Infos and their use</a> 
141</div>
142</div><p>
143<a class="anchor" name="b06f1e7c44a8306e321f62a0099210b9"></a><!-- doxytag: member="user_info.h::UIREGISTER2" ref="b06f1e7c44a8306e321f62a0099210b9" args="(class_name, temp_name)" -->
144<div class="memitem">
145<div class="memproto">
146      <table class="memname">
147        <tr>
148          <td class="memname">#define UIREGISTER2          </td>
149          <td>(</td>
150          <td class="paramtype">class_name,         <tr>
151          <td class="paramkey"></td>
152          <td></td>
153          <td class="paramtype">temp_name&nbsp;</td>
154          <td class="paramname">          </td>
155          <td>&nbsp;)&nbsp;</td>
156          <td>&nbsp;&nbsp;&nbsp;static <a class="el" href="classbdm_1_1ParticularUI.html">bdm::ParticularUI</a>&lt;class_name&lt;temp_name&gt; &gt; UI##class_name##_##temp_name( QUOTEME(class_name&lt;temp_name&gt;) )</td>
157        </tr>
158      </table>
159</div>
160<div class="memdoc">
161
162<p>
163Variant of UIREGISTER for templated classes.
164<p>
165Technical meann of registering <a class="el" href="user__info_8h.html#4f9de2f17e844047726487b99def99c6" title="Macro for registration of class into map of user-infos, registered class is scriptable...">UIREGISTER(class_name&lt;template_name&gt;)</a>.<p>
166<a class="el" href="ui_page.html">User Infos and their use</a> 
167</div>
168</div><p>
169</div>
170<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:44 2009 for mixpp by&nbsp;
171<a href="http://www.doxygen.org/index.html">
172<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
173</body>
174</html>
Note: See TracBrowser for help on using the browser.