Show
Ignore:
Timestamp:
09/13/09 23:15:31 (15 years ago)
Author:
smidl
Message:

doc, sorted related pages

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1SettingResolver.html

    r614 r616  
    7474<p>This class serves to expand links used within configuration files.   
    7575<a href="#_details">More...</a></p> 
    76  
    77 <p><code>#include &lt;<a class="el" href="user__info_8h_source.html">user_info.h</a>&gt;</code></p> 
    78  
    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="" --> 
    90 const 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="()" --> 
    94 virtual 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)" --> 
    97 virtual 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 " --> 
    100 virtual 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="()" --> 
    103 virtual 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> 
    105 </table> 
    10676<hr/><a name="_details"></a><h2>Detailed Description</h2> 
    10777<p>This class serves to expand links used within configuration files. </p> 
    … …  
    147117</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> 
    148118<p><a class="el" href="ui_page.html">User Infos and their use</a> </p> 
     119 
     120<p><code>#include &lt;<a class="el" href="user__info_8h_source.html">user_info.h</a>&gt;</code></p> 
     121 
     122<p><a href="classbdm_1_1SettingResolver-members.html">List of all members.</a></p> 
     123<table border="0" cellpadding="0" cellspacing="0"> 
     124<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> 
     125<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)" --> 
     126&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> 
     127<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> 
     128<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8b29999710e2db98c1a3979e25e6bbc"></a><!-- doxytag: member="bdm::SettingResolver::~SettingResolver" ref="ac8b29999710e2db98c1a3979e25e6bbc" args="()" --> 
     129&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1SettingResolver.html#ac8b29999710e2db98c1a3979e25e6bbc">~SettingResolver</a> ()</td></tr> 
     130<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> 
     131<tr><td colspan="2"><h2>Public Attributes</h2></td></tr> 
     132<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aadfcd0a81d025c52c8335b6aea07b498"></a><!-- doxytag: member="bdm::SettingResolver::result" ref="aadfcd0a81d025c52c8335b6aea07b498" args="" --> 
     133const Setting &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1SettingResolver.html#aadfcd0a81d025c52c8335b6aea07b498">result</a></td></tr> 
     134<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> 
     135<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr> 
     136<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::SettingResolver::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" --> 
     137virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
     138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr> 
     139<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)" --> 
     140virtual 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> 
     141<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> 
     142<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 " --> 
     143virtual 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> 
     144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr> 
     145<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::SettingResolver::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     146virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
     147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr> 
     148</table> 
    149149<hr/>The documentation for this class was generated from the following files:<ul> 
    150150<li><a class="el" href="user__info_8h_source.html">user_info.h</a></li> 
    … …  
    152152</ul> 
    153153</div> 
    154 <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 13 22:40:43 2009 for mixpp by&nbsp; 
     154<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 13 23:08:56 2009 for mixpp by&nbsp; 
    155155<a href="http://www.doxygen.org/index.html"> 
    156156<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>