<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>incron: IncronCfg Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>IncronCfg Class Reference</h1><!-- doxytag: class="IncronCfg" -->Configuration class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="incroncfg_8h-source.html">incroncfg.h</a>></code>
<p>
<p>
<a href="classIncronCfg-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronCfg.html#9fe219f0d98b358a32fd4e58804f1213">Init</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes default configuration values. <a href="#9fe219f0d98b358a32fd4e58804f1213"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronCfg.html#c75ef9eab5f3878c4470b08231afd1e1">Load</a> (const std::string &rPath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads configuration values. <a href="#c75ef9eab5f3878c4470b08231afd1e1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronCfg.html#bcb3d392c025d0d93f9c9c49ef8f7d42">GetValue</a> (const std::string &rKey, std::string &rVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a configuration value. <a href="#bcb3d392c025d0d93f9c9c49ef8f7d42"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronCfg.html#7d895e75750a5db599e7583cdfd3ea71">GetValue</a> (const std::string &rKey, int &rVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a configuration value. <a href="#7d895e75750a5db599e7583cdfd3ea71"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronCfg.html#daf0adc9641cc14ed6f889cd3d317deb">GetValue</a> (const std::string &rKey, unsigned &rVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a configuration value. <a href="#daf0adc9641cc14ed6f889cd3d317deb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronCfg.html#d0542b2131c813fdce5f704b399ebaab">GetValue</a> (const std::string &rKey, bool &rVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a configuration value. <a href="#d0542b2131c813fdce5f704b399ebaab"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronCfg.html#68271df7c649d11b4c405422f21d779b">BuildPath</a> (const std::string &rPath, const std::string &rName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Builds a file path. <a href="#68271df7c649d11b4c405422f21d779b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronCfg.html#fe4381ce8e57579dd59097192bd75ac6">ParseLine</a> (const char *s, std::string &rKey, std::string &rVal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a line a attempts to get a key and a value. <a href="#fe4381ce8e57579dd59097192bd75ac6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronCfg.html#b995e931ef67fc62a833227332a10735">IsComment</a> (const char *s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a line is a comment. <a href="#b995e931ef67fc62a833227332a10735"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Configuration class.
<p>
This class provides access to values loaded from a configuration file (either a explicitly specified one or the default one). <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9fe219f0d98b358a32fd4e58804f1213"></a><!-- doxytag: member="IncronCfg::Init" ref="9fe219f0d98b358a32fd4e58804f1213" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IncronCfg::Init </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initializes default configuration values.
<p>
</div>
</div><p>
<a class="anchor" name="c75ef9eab5f3878c4470b08231afd1e1"></a><!-- doxytag: member="IncronCfg::Load" ref="c75ef9eab5f3878c4470b08231afd1e1" args="(const std::string &rPath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IncronCfg::Load </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rPath</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Loads configuration values.
<p>
This method attempts to load configuration values from the specified file. If it fails (e.g. the file doesn't exist) the default file is read. As the last resort (for the case the default file can't be loaded) the hard-wired values are used.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rPath</em> </td><td>configuration file path </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="bcb3d392c025d0d93f9c9c49ef8f7d42"></a><!-- doxytag: member="IncronCfg::GetValue" ref="bcb3d392c025d0d93f9c9c49ef8f7d42" args="(const std::string &rKey, std::string &rVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronCfg::GetValue </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>rVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves a configuration value.
<p>
This method attempts to find the appropriate configuration value for the given key and stores it into the given variable.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rKey</em> </td><td>value key </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rVal</em> </td><td>retrieved value </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = success, false = failure (invalid key) </dd></dl>
</div>
</div><p>
<a class="anchor" name="7d895e75750a5db599e7583cdfd3ea71"></a><!-- doxytag: member="IncronCfg::GetValue" ref="7d895e75750a5db599e7583cdfd3ea71" args="(const std::string &rKey, int &rVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronCfg::GetValue </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>rVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves a configuration value.
<p>
This method attempts to find the appropriate configuration value for the given key and stores it into the given variable.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rKey</em> </td><td>value key </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rVal</em> </td><td>retrieved value </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = success, false = failure (invalid key) </dd></dl>
</div>
</div><p>
<a class="anchor" name="daf0adc9641cc14ed6f889cd3d317deb"></a><!-- doxytag: member="IncronCfg::GetValue" ref="daf0adc9641cc14ed6f889cd3d317deb" args="(const std::string &rKey, unsigned &rVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronCfg::GetValue </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned & </td>
<td class="paramname"> <em>rVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves a configuration value.
<p>
This method attempts to find the appropriate configuration value for the given key and stores it into the given variable.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rKey</em> </td><td>value key </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rVal</em> </td><td>retrieved value </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = success, false = failure (invalid key) </dd></dl>
</div>
</div><p>
<a class="anchor" name="d0542b2131c813fdce5f704b399ebaab"></a><!-- doxytag: member="IncronCfg::GetValue" ref="d0542b2131c813fdce5f704b399ebaab" args="(const std::string &rKey, bool &rVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronCfg::GetValue </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"> <em>rVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves a configuration value.
<p>
This method attempts to find the appropriate configuration value for the given key and stores it into the given variable.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rKey</em> </td><td>value key </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rVal</em> </td><td>retrieved value </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = success, false = failure (invalid key) </dd></dl>
</div>
</div><p>
<a class="anchor" name="68271df7c649d11b4c405422f21d779b"></a><!-- doxytag: member="IncronCfg::BuildPath" ref="68271df7c649d11b4c405422f21d779b" args="(const std::string &rPath, const std::string &rName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string IncronCfg::BuildPath </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rName</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Builds a file path.
<p>
This function composes a path from a base path and a file name.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rPath</em> </td><td>base path </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rName</em> </td><td>file name </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>full path </dd></dl>
</div>
</div><p>
<a class="anchor" name="fe4381ce8e57579dd59097192bd75ac6"></a><!-- doxytag: member="IncronCfg::ParseLine" ref="fe4381ce8e57579dd59097192bd75ac6" args="(const char *s, std::string &rKey, std::string &rVal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronCfg::ParseLine </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>rKey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>rVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a line a attempts to get a key and a value.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>s</em> </td><td>text line </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rKey</em> </td><td>key </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rVal</em> </td><td>value </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = success, false = failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="b995e931ef67fc62a833227332a10735"></a><!-- doxytag: member="IncronCfg::IsComment" ref="b995e931ef67fc62a833227332a10735" args="(const char *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronCfg::IsComment </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>s</em> </td>
<td> ) </td>
<td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks whether a line is a comment.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>s</em> </td><td>text line </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = comment, false = otherwise </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="incroncfg_8h-source.html">incroncfg.h</a><li><a class="el" href="incroncfg_8cpp.html">incroncfg.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jun 21 22:27:24 2009 for incron by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
a964702347d726c5f8ba742f8b9d5908
>
files
>
28
