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

Revision 591, 10.3 kB (checked in by smidl, 16 years ago)

doc

Line 
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"/>
5<title>mixpp: user_info.h File 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 -->
11<script type="text/javascript">
12<!--
13function changeDisplayState (e){
14  var num=this.id.replace(/[^[0-9]/g,'');
15  var button=this.firstChild;
16  var sectionDiv=document.getElementById('dynsection'+num);
17  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
18    sectionDiv.style.display='block';
19    button.src='open.gif';
20  }else{
21    sectionDiv.style.display='none';
22    button.src='closed.gif';
23  }
24}
25function initDynSections(){
26  var divs=document.getElementsByTagName('div');
27  var sectionCounter=1;
28  for(var i=0;i<divs.length-1;i++){
29    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
30      var header=divs[i];
31      var section=divs[i+1];
32      var button=header.firstChild;
33      if (button!='IMG'){
34        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
35        button=document.createElement('img');
36        divs[i].insertBefore(button,divs[i].firstChild);
37      }
38      header.style.cursor='pointer';
39      header.onclick=changeDisplayState;
40      header.id='dynheader'+sectionCounter;
41      button.src='closed.gif';
42      section.id='dynsection'+sectionCounter;
43      section.style.display='none';
44      section.style.marginLeft='14px';
45      sectionCounter++;
46    }
47  }
48}
49window.onload = initDynSections;
50-->
51</script>
52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
57      <li><a href="annotated.html"><span>Classes</span></a></li>
58      <li class="current"><a href="files.html"><span>Files</span></a></li>
59    </ul>
60  </div>
61  <div class="tabs">
62    <ul>
63      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
64      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67</div>
68<div class="contents">
69<h1>user_info.h File Reference</h1>
70<p>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>. 
71<a href="#_details">More...</a></p>
72<code>#include &lt;stdio.h&gt;</code><br/>
73<code>#include &lt;string&gt;</code><br/>
74<code>#include &lt;typeinfo&gt;</code><br/>
75<code>#include &lt;map&gt;</code><br/>
76<code>#include &lt;stdexcept&gt;</code><br/>
77<code>#include &quot;libconfig/libconfig.h++&quot;</code><br/>
78<code>#include &quot;../bdmroot.h&quot;</code><br/>
79<code>#include &quot;../shared_ptr.h&quot;</code><br/>
80<code>#include &quot;itpp/itbase.h&quot;</code><br/>
81
82<p><a href="user__info_8h_source.html">Go to the source code of this file.</a></p>
83<table border="0" cellpadding="0" cellspacing="0">
84<tr><td colspan="2"><h2>Classes</h2></td></tr>
85<tr><td class="memItemLeft" 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>
86<tr><td class="memItemLeft" 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>
87<tr><td class="memItemLeft" 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<tr><td class="memItemLeft" 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>
89<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>
90<tr><td class="memItemLeft" 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>
91<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>
92<tr><td class="memItemLeft" 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>
93<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>
94<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><b>bdm::UI::MappedUI</b></td></tr>
95<tr><td class="memItemLeft" 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>
96<tr><td colspan="2"><h2>Defines</h2></td></tr>
97<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="user__info_8h.html#a4f9de2f17e844047726487b99def99c6">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>
98<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="#a4f9de2f17e844047726487b99def99c6"></a><br/></td></tr>
99<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a852592d44ce65a0a870c76b42155aaca"></a><!-- doxytag: member="user_info.h::QUOTEME" ref="a852592d44ce65a0a870c76b42155aaca" args="(x)" -->
100#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="user__info_8h.html#a852592d44ce65a0a870c76b42155aaca">QUOTEME</a>(x)&nbsp;&nbsp;&nbsp;#x</td></tr>
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Instrumental macro for UIREGISTER2. <br/></td></tr>
102<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="user__info_8h.html#ab06f1e7c44a8306e321f62a0099210b9">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>
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Variant of UIREGISTER for templated classes.  <a href="#ab06f1e7c44a8306e321f62a0099210b9"></a><br/></td></tr>
104</table>
105<hr/><a name="_details"></a><h2>Detailed Description</h2>
106<p>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>. </p>
107<dl class="author"><dt><b>Author:</b></dt><dd>Vaclav Smidl.</dd></dl>
108<p>----------------------------------- BDM++ - C++ library for Bayesian Decision Making under Uncertainty</p>
109<p>Using IT++ for numerical operations ----------------------------------- </p>
110<hr/><h2>Define Documentation</h2>
111<a class="anchor" id="a4f9de2f17e844047726487b99def99c6"></a><!-- doxytag: member="user_info.h::UIREGISTER" ref="a4f9de2f17e844047726487b99def99c6" args="(class_name)" -->
112<div class="memitem">
113<div class="memproto">
114      <table class="memname">
115        <tr>
116          <td class="memname">#define UIREGISTER</td>
117          <td>(</td>
118          <td class="paramtype">class_name&nbsp;</td>
119          <td class="paramname"></td>
120          <td>&nbsp;)&nbsp;</td>
121          <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>
122        </tr>
123      </table>
124</div>
125<div class="memdoc">
126
127<p>Macro for registration of class into map of user-infos, registered class is scriptable using UI static methods. </p>
128<p>Argument <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>
129<p><a class="el" href="ui_page.html">User Infos and their use</a> </p>
130
131</div>
132</div>
133<a class="anchor" id="ab06f1e7c44a8306e321f62a0099210b9"></a><!-- doxytag: member="user_info.h::UIREGISTER2" ref="ab06f1e7c44a8306e321f62a0099210b9" args="(class_name, temp_name)" -->
134<div class="memitem">
135<div class="memproto">
136      <table class="memname">
137        <tr>
138          <td class="memname">#define UIREGISTER2</td>
139          <td>(</td>
140          <td class="paramtype">class_name, </td>
141        </tr>
142        <tr>
143          <td class="paramkey"></td>
144          <td></td>
145          <td class="paramtype">temp_name&nbsp;</td>
146          <td class="paramname"></td>
147          <td>&nbsp;)&nbsp;</td>
148          <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>
149        </tr>
150      </table>
151</div>
152<div class="memdoc">
153
154<p>Variant of UIREGISTER for templated classes. </p>
155<p>Technical meann of registering <a class="el" href="user__info_8h.html#a4f9de2f17e844047726487b99def99c6" title="Macro for registration of class into map of user-infos, registered class is scriptable...">UIREGISTER(class_name&lt;template_name&gt;)</a>.</p>
156<p><a class="el" href="ui_page.html">User Infos and their use</a> </p>
157
158</div>
159</div>
160</div>
161<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:49 2009 for mixpp by&nbsp;
162<a href="http://www.doxygen.org/index.html">
163<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
164</body>
165</html>
Note: See TracBrowser for help on using the browser.