Show
Ignore:
Timestamp:
08/30/09 22:13:15 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/user__info_8h.html

    r590 r591  
    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"> 
     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"/> 
    35<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.8 --> 
     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 --> 
    811<script type="text/javascript"> 
    912<!-- 
    … …  
    6467</div> 
    6568<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> 
     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/> 
    7881 
    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::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> 
     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> 
    113104</table> 
    114 <hr><a name="_details"></a><h2>Detailed Description</h2> 
    115 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>.  
    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> 
    119 Using 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)" --> 
     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)" --> 
    121112<div class="memitem"> 
    122113<div class="memproto"> 
    123114      <table class="memname"> 
    124115        <tr> 
    125           <td class="memname">#define UIREGISTER          </td> 
     116          <td class="memname">#define UIREGISTER</td> 
    126117          <td>(</td> 
    127118          <td class="paramtype">class_name&nbsp;</td> 
    128           <td class="paramname">          </td> 
     119          <td class="paramname"></td> 
    129120          <td>&nbsp;)&nbsp;</td> 
    130121          <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> 
    … …  
    134125<div class="memdoc"> 
    135126 
    136 <p> 
    137 Macro for registration of class into map of user-infos, registered class is scriptable using UI static methods.  
    138 <p> 
    139 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> 
    140 <a class="el" href="ui_page.html">User Infos and their use</a>  
     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 
    141131</div> 
    142 </div><p> 
    143 <a class="anchor" name="b06f1e7c44a8306e321f62a0099210b9"></a><!-- doxytag: member="user_info.h::UIREGISTER2" ref="b06f1e7c44a8306e321f62a0099210b9" args="(class_name, temp_name)" --> 
     132</div> 
     133<a class="anchor" id="ab06f1e7c44a8306e321f62a0099210b9"></a><!-- doxytag: member="user_info.h::UIREGISTER2" ref="ab06f1e7c44a8306e321f62a0099210b9" args="(class_name, temp_name)" --> 
    144134<div class="memitem"> 
    145135<div class="memproto"> 
    146136      <table class="memname"> 
    147137        <tr> 
    148           <td class="memname">#define UIREGISTER2          </td> 
     138          <td class="memname">#define UIREGISTER2</td> 
    149139          <td>(</td> 
    150           <td class="paramtype">class_name,         <tr> 
     140          <td class="paramtype">class_name, </td> 
     141        </tr> 
     142        <tr> 
    151143          <td class="paramkey"></td> 
    152144          <td></td> 
    153145          <td class="paramtype">temp_name&nbsp;</td> 
    154           <td class="paramname">          </td> 
     146          <td class="paramname"></td> 
    155147          <td>&nbsp;)&nbsp;</td> 
    156148          <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> 
    … …  
    160152<div class="memdoc"> 
    161153 
    162 <p> 
    163 Variant of UIREGISTER for templated classes.  
    164 <p> 
    165 Technical 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>  
     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 
    167158</div> 
    168 </div><p> 
    169159</div> 
    170 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 20:49:42 2009 for mixpp by&nbsp; 
     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; 
    171162<a href="http://www.doxygen.org/index.html"> 
    172 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     163<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> 
    173164</body> 
    174165</html>