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/classbdm_1_1SettingResolver.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: bdm::SettingResolver 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 --> 
     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<!-- 
    … …  
    6871</div> 
    6972<div class="contents"> 
    70 <h1>bdm::SettingResolver Class Reference</h1><!-- doxytag: class="bdm::SettingResolver" --><!-- doxytag: inherits="bdm::root" -->This class serves to expand links used within configuration files.   
    71 <a href="#_details">More...</a> 
    72 <p> 
    73 <code>#include &lt;<a class="el" href="user__info_8h-source.html">user_info.h</a>&gt;</code> 
    74 <p> 
     73<h1>bdm::SettingResolver Class Reference</h1><!-- doxytag: class="bdm::SettingResolver" --><!-- doxytag: inherits="bdm::root" --> 
     74<p>This class serves to expand links used within configuration files.   
     75<a href="#_details">More...</a></p> 
    7576 
    76 <p> 
    77 <a href="classbdm_1_1SettingResolver-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
    78 <tr><td></td></tr> 
    79 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    80 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e2299746b95bf8af54a867aaf52fc8da"></a><!-- doxytag: member="bdm::SettingResolver::SettingResolver" ref="e2299746b95bf8af54a867aaf52fc8da" args="(const Setting &amp;potential_link)" --> 
    81 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1SettingResolver.html#e2299746b95bf8af54a867aaf52fc8da">SettingResolver</a> (const Setting &amp;potential_link)</td></tr> 
     77<p><code>#include &lt;<a class="el" href="user__info_8h_source.html">user_info.h</a>&gt;</code></p> 
    8278 
    83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If potential_link contains a link to some other setting, it is resolved here. Anyway, the Setting reference <a class="el" href="classbdm_1_1SettingResolver.html#adfcd0a81d025c52c8335b6aea07b498" title="Reference to a resolved link or to the original Setting in the case it does not contain...">result</a> is prepared for use. <br></td></tr> 
    84 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8b29999710e2db98c1a3979e25e6bbc"></a><!-- doxytag: member="bdm::SettingResolver::~SettingResolver" ref="c8b29999710e2db98c1a3979e25e6bbc" args="()" --> 
    85 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1SettingResolver.html#c8b29999710e2db98c1a3979e25e6bbc">~SettingResolver</a> ()</td></tr> 
    86  
    87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An opened <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> file is closed here if necessary. <br></td></tr> 
    88 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> 
    89 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adfcd0a81d025c52c8335b6aea07b498"></a><!-- doxytag: member="bdm::SettingResolver::result" ref="adfcd0a81d025c52c8335b6aea07b498" args="" --> 
    90 const Setting &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1SettingResolver.html#adfcd0a81d025c52c8335b6aea07b498">result</a></td></tr> 
    91  
    92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference to a resolved link or to the original Setting in the case it does not contain a link. <br></td></tr> 
    93 <tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> 
    94 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::SettingResolver::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
    95 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    96  
    97 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    98 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::SettingResolver::from_setting" ref="0551e3121091c5199bf4413b50522176" args="(const Setting &amp;set)" --> 
    99 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">from_setting</a> (const Setting &amp;set)</td></tr> 
    100  
    101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr> 
    102 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::SettingResolver::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
    103 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr> 
    104  
    105 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    106 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::SettingResolver::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
    107 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    108  
    109 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
     79<p><a href="classbdm_1_1SettingResolver-members.html">List of all members.</a></p> 
     80<table border="0" cellpadding="0" cellspacing="0"> 
     81<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> 
     82<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae2299746b95bf8af54a867aaf52fc8da"></a><!-- doxytag: member="bdm::SettingResolver::SettingResolver" ref="ae2299746b95bf8af54a867aaf52fc8da" args="(const Setting &amp;potential_link)" --> 
     83&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1SettingResolver.html#ae2299746b95bf8af54a867aaf52fc8da">SettingResolver</a> (const Setting &amp;potential_link)</td></tr> 
     84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">If potential_link contains a link to some other setting, it is resolved here. Anyway, the Setting reference <a class="el" href="classbdm_1_1SettingResolver.html#aadfcd0a81d025c52c8335b6aea07b498" title="Reference to a resolved link or to the original Setting in the case it does not contain...">result</a> is prepared for use. <br/></td></tr> 
     85<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8b29999710e2db98c1a3979e25e6bbc"></a><!-- doxytag: member="bdm::SettingResolver::~SettingResolver" ref="ac8b29999710e2db98c1a3979e25e6bbc" args="()" --> 
     86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1SettingResolver.html#ac8b29999710e2db98c1a3979e25e6bbc">~SettingResolver</a> ()</td></tr> 
     87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An opened <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> file is closed here if necessary. <br/></td></tr> 
     88<tr><td colspan="2"><h2>Public Attributes</h2></td></tr> 
     89<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadfcd0a81d025c52c8335b6aea07b498"></a><!-- doxytag: member="bdm::SettingResolver::result" ref="aadfcd0a81d025c52c8335b6aea07b498" args="" --> 
     90const Setting &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1SettingResolver.html#aadfcd0a81d025c52c8335b6aea07b498">result</a></td></tr> 
     91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference to a resolved link or to the original Setting in the case it does not contain a link. <br/></td></tr> 
     92<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr> 
     93<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::SettingResolver::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" --> 
     94virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
     95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr> 
     96<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::SettingResolver::from_setting" ref="a0551e3121091c5199bf4413b50522176" args="(const Setting &amp;set)" --> 
     97virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a0551e3121091c5199bf4413b50522176">from_setting</a> (const Setting &amp;set)</td></tr> 
     98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br/></td></tr> 
     99<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::SettingResolver::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     100virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr> 
     101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr> 
     102<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::SettingResolver::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     103virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
     104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr> 
    110105</table> 
    111 <hr><a name="_details"></a><h2>Detailed Description</h2> 
    112 This class serves to expand links used within configuration files.  
    113 <p> 
    114 Value of any type but string can be linked to some other value of the same type defined elsewhere in the current configuration file or even in some different configuration file.<p> 
    115 Link have three parts, &lt;name&gt; : &lt;path&gt; &lt;@filename&gt;. Field &lt;name&gt; contains the name of the new setting, &lt;path&gt; is the relative path to the referenced setting, which has to be taken from the root Setting element. The last part &lt;@filename&gt; is optional, it contains filename in the case the link should refer to a variable stored in a different file. From the previous part &lt;path&gt;, it has to be separated by '@'.<p> 
     106<hr/><a name="_details"></a><h2>Detailed Description</h2> 
     107<p>This class serves to expand links used within configuration files. </p> 
     108<p>Value of any type but string can be linked to some other value of the same type defined elsewhere in the current configuration file or even in some different configuration file.</p> 
     109<p>Link have three parts, &lt;name&gt; : &lt;path&gt; &lt;@filename&gt;. Field &lt;name&gt; contains the name of the new setting, &lt;path&gt; is the relative path to the referenced setting, which has to be taken from the root Setting element. The last part &lt;@filename&gt; is optional, it contains filename in the case the link should refer to a variable stored in a different file. From the previous part &lt;path&gt;, it has to be separated by '@'.</p> 
    116110<div class="fragment"><pre class="fragment">    ... 
    117111        jardovo : 
    118112        { 
    119           <span class="keyword">class </span>= "Car"; 
     113          <span class="keyword">class </span>= &quot;Car&quot;; 
    120114          year = 1992; 
    121           manufacturer = <span class="stringliteral">"liaz"</span>; 
     115          manufacturer = <span class="stringliteral">&quot;liaz&quot;</span>; 
    122116          kilometers = 1555000; 
    123117        }; 
    124118        ondrejovo : 
    125119        { 
    126           <span class="keyword">class </span>= "Bike"; 
     120          <span class="keyword">class </span>= &quot;Bike&quot;; 
    127121          year = 1996; 
    128           manufacturer = <span class="stringliteral">"author"</span>; 
     122          manufacturer = <span class="stringliteral">&quot;author&quot;</span>; 
    129123          electricLights = <span class="keyword">true</span>; 
    130124          matr = ( 2, 2, [ 1.0, 0.0, 0.0, 1.0 ] ); 
    … …  
    132126 
    133127<span class="preprocessor">        #this is the example of local link to another mean of transport</span> 
    134 <span class="preprocessor"></span>        elisky = <span class="stringliteral">"jardovo"</span>; 
     128<span class="preprocessor"></span>        elisky = <span class="stringliteral">&quot;jardovo&quot;</span>; 
    135129 
    136130        ... 
    137131 
    138         # And <span class="keyword">this</span> link is external link pointing to the file <span class="stringliteral">"other_cars.cfg"</span> stored in the 
    139 <span class="preprocessor">        # same directory. In that file, it refers to the local Setting "magic_cars.skubankovo".</span> 
    140 <span class="preprocessor"></span>        kati = <span class="stringliteral">"magic_cars.skubankovo@other_cars.cfg"</span>; 
     132        # And <span class="keyword">this</span> link is external link pointing to the file <span class="stringliteral">&quot;other_cars.cfg&quot;</span> stored in the 
     133<span class="preprocessor">        # same directory. In that file, it refers to the local Setting &quot;magic_cars.skubankovo&quot;.</span> 
     134<span class="preprocessor"></span>        kati = <span class="stringliteral">&quot;magic_cars.skubankovo@other_cars.cfg&quot;</span>; 
    141135 
    142136    ... 
    143 </pre></div><p> 
    144 When you want to expand a possible linked setting "element" within your code, it has to be treated this way:<p> 
     137</pre></div><p>When you want to expand a possible linked setting "element" within your code, it has to be treated this way:</p> 
    145138<div class="fragment"><pre class="fragment">        ... 
    146139 
    147         <span class="keyword">const</span> <a class="code" href="classbdm_1_1SettingResolver.html#e2299746b95bf8af54a867aaf52fc8da" title="If potential_link contains a link to some other setting, it is resolved here. Anyway...">SettingResolver</a> link( element ); 
     140        <span class="keyword">const</span> <a class="code" href="classbdm_1_1SettingResolver.html#ae2299746b95bf8af54a867aaf52fc8da" title="If potential_link contains a link to some other setting, it is resolved here. Anyway...">SettingResolver</a> link( element ); 
    148141 
    149142        ... 
    … …  
    152145 
    153146        ... 
    154 </pre></div><p> 
    155 The whole point is that a resolved link (class member <a class="el" href="classbdm_1_1SettingResolver.html#adfcd0a81d025c52c8335b6aea07b498" title="Reference to a resolved link or to the original Setting in the case it does not contain...">result</a>, i.e., "link.result" in the previous example) could point into a different configuration file. In that case there has to be an <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> instance managing reading from this file. As the libconfig::Config deletes all its Settings when dealocated, <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> must not be dealocated until all the necessary operation on the linked Setting are finished (otherwise, the link <a class="el" href="classbdm_1_1SettingResolver.html#adfcd0a81d025c52c8335b6aea07b498" title="Reference to a resolved link or to the original Setting in the case it does not contain...">result</a> would be invalid just after the <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> dealocation). And that is exactly the mechanism implemented within <a class="el" href="classbdm_1_1SettingResolver.html" title="This class serves to expand links used within configuration files.">SettingResolver</a> class. It assures, that the <a class="el" href="classbdm_1_1SettingResolver.html#adfcd0a81d025c52c8335b6aea07b498" title="Reference to a resolved link or to the original Setting in the case it does not contain...">result</a> Setting reference is valid within the scope of <a class="el" href="classbdm_1_1SettingResolver.html" title="This class serves to expand links used within configuration files.">SettingResolver</a> instance.<p> 
    156 <a class="el" href="ui_page.html">User Infos and their use</a> <hr>The documentation for this class was generated from the following files:<ul> 
    157 <li><a class="el" href="user__info_8h-source.html">user_info.h</a><li>user_info.cpp</ul> 
     147</pre></div><p>The whole point is that a resolved link (class member <a class="el" href="classbdm_1_1SettingResolver.html#aadfcd0a81d025c52c8335b6aea07b498" title="Reference to a resolved link or to the original Setting in the case it does not contain...">result</a>, i.e., "link.result" in the previous example) could point into a different configuration file. In that case there has to be an <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> instance managing reading from this file. As the libconfig::Config deletes all its Settings when dealocated, <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> must not be dealocated until all the necessary operation on the linked Setting are finished (otherwise, the link <a class="el" href="classbdm_1_1SettingResolver.html#aadfcd0a81d025c52c8335b6aea07b498" title="Reference to a resolved link or to the original Setting in the case it does not contain...">result</a> would be invalid just after the <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> dealocation). And that is exactly the mechanism implemented within <a class="el" href="classbdm_1_1SettingResolver.html" title="This class serves to expand links used within configuration files.">SettingResolver</a> class. It assures, that the <a class="el" href="classbdm_1_1SettingResolver.html#aadfcd0a81d025c52c8335b6aea07b498" title="Reference to a resolved link or to the original Setting in the case it does not contain...">result</a> Setting reference is valid within the scope of <a class="el" href="classbdm_1_1SettingResolver.html" title="This class serves to expand links used within configuration files.">SettingResolver</a> instance.</p> 
     148<p><a class="el" href="ui_page.html">User Infos and their use</a> </p> 
     149<hr/>The documentation for this class was generated from the following files:<ul> 
     150<li><a class="el" href="user__info_8h_source.html">user_info.h</a></li> 
     151<li>user_info.cpp</li> 
     152</ul> 
    158153</div> 
    159 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 20:49:46 2009 for mixpp by&nbsp; 
     154<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:50 2009 for mixpp by&nbsp; 
    160155<a href="http://www.doxygen.org/index.html"> 
    161 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     156<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> 
    162157</body> 
    163158</html>