<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>The MRPT project: mrpt::utils::CConfigFile Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</span><span class="right"></span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespacemrpt.html">mrpt</a> </li>
<li><a class="el" href="namespacemrpt_1_1utils.html">utils</a> </li>
<li><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html">CConfigFile</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<h1>mrpt::utils::CConfigFile Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::utils::CConfigFile" --><!-- doxytag: inherits="mrpt::utils::CConfigFileBase" --><hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class allows loading and storing values and vectors of different types from ".ini" files easily. </p>
<p>The contents of the file will be modified by "write" operations in memory, and will be saved back to the file at the destructor, and only if at least one write operation has been applied. </p>
<p>Definition at line <a class="el" href="_c_config_file_8h_source.html#l00047">47</a> of file <a class="el" href="_c_config_file_8h_source.html">CConfigFile.h</a>.</p>
<p><code>#include <<a class="el" href="_c_config_file_8h_source.html">mrpt/utils/CConfigFile.h</a>></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for mrpt::utils::CConfigFile:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classmrpt_1_1utils_1_1_c_config_file__inherit__graph.png" border="0" usemap="#mrpt_1_1utils_1_1_c_config_file_inherit__map" alt="Inheritance graph"/></div>
<map name="mrpt_1_1utils_1_1_c_config_file_inherit__map" id="mrpt_1_1utils_1_1_c_config_file_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="classmrpt_1_1utils_1_1_c_config_file-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#abf18b3a13f274c5e649202510845b727">CConfigFile</a> (const std::string &fileName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor that opens a configuration file. <a href="#abf18b3a13f274c5e649202510845b727"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#ad1d001b2971959053eae9b7c3a7ca670">CConfigFile</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor, does not open any file. <a href="#ad1d001b2971959053eae9b7c3a7ca670"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#aafcefa07b09c2c41a18f75c2ae4df83e">setFileName</a> (const std::string &fil_path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Associate this object with the given file, so future read/write operations will be applied to that file (it's synchronized at destruction). <a href="#aafcefa07b09c2c41a18f75c2ae4df83e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#afa330002e3a5e166f57441184301a5ab">writeNow</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dumps the changes to the physical configuration file now, not waiting until destruction. <a href="#afa330002e3a5e166f57441184301a5ab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#afe9631fca69de992a4454f534e3cc703">getAssociatedFile</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the file currently open by this object. <a href="#afe9631fca69de992a4454f534e3cc703"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#a66f2d454b39714542687149560b0ee37">~CConfigFile</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a66f2d454b39714542687149560b0ee37"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#a134598f52d24e5fb6f130dcb90207eae">getAllSections</a> (<a class="el" href="namespacemrpt.html#a4d04fc5241bf87fcaffec90f3b23b1ea">vector_string</a> &sections) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a list with all the section names. <a href="#a134598f52d24e5fb6f130dcb90207eae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#a091309dc02080d0c9b3f517108802f8e">getAllKeys</a> (const std::string section, <a class="el" href="namespacemrpt.html#a4d04fc5241bf87fcaffec90f3b23b1ea">vector_string</a> &keys) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returs a list with all the keys into a section. <a href="#a091309dc02080d0c9b3f517108802f8e"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#a94cc241cc6cb9121e9275e971ed1c33a">writeString</a> (const std::string &section, const std::string &name, const std::string &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A virtual method to write a generic string. <a href="#a94cc241cc6cb9121e9275e971ed1c33a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#a9bc2f3a2fe91fbd9207c07ae88c3bc65">readString</a> (const std::string &section, const std::string &name, const std::string &defaultStr, bool failIfNotFound=false) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A virtual method to read a generic string. <a href="#a9bc2f3a2fe91fbd9207c07ae88c3bc65"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#a9a6ae155df35151bdf14388af49d95ef">m_file</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the file. <a href="#a9a6ae155df35151bdf14388af49d95ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrpt_1_1utils_1_1non__copiable__ptr__basic.html">void_ptr_noncopy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#a54c8d27c171d05bd692ee0455fc2b35f">m_ini</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The interface to the <a href="file:">file:</a> <a href="#a54c8d27c171d05bd692ee0455fc2b35f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#abccf737438319124ffd9ed5e36bcdd3b">m_modified</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If modified since load. <a href="#abccf737438319124ffd9ed5e36bcdd3b"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="abf18b3a13f274c5e649202510845b727"></a><!-- doxytag: member="mrpt::utils::CConfigFile::CConfigFile" ref="abf18b3a13f274c5e649202510845b727" args="(const std::string &fileName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::CConfigFile::CConfigFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>fileName</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor that opens a configuration file. </p>
</div>
</div>
<a class="anchor" id="ad1d001b2971959053eae9b7c3a7ca670"></a><!-- doxytag: member="mrpt::utils::CConfigFile::CConfigFile" ref="ad1d001b2971959053eae9b7c3a7ca670" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::CConfigFile::CConfigFile </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor, does not open any file. </p>
<p>You should call "setFileName" before reading or writting or otherwise nothing will be read and write operations will be eventually lost. However, it's perfectly right to use this object without an associated file, in which case it will behave as an "in-memory" file. </p>
</div>
</div>
<a class="anchor" id="a66f2d454b39714542687149560b0ee37"></a><!-- doxytag: member="mrpt::utils::CConfigFile::~CConfigFile" ref="a66f2d454b39714542687149560b0ee37" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual mrpt::utils::CConfigFile::~CConfigFile </td>
<td>(</td>
<td class="paramname"> )</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a091309dc02080d0c9b3f517108802f8e"></a><!-- doxytag: member="mrpt::utils::CConfigFile::getAllKeys" ref="a091309dc02080d0c9b3f517108802f8e" args="(const std::string section, vector_string &keys) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mrpt::utils::CConfigFile::getAllKeys </td>
<td>(</td>
<td class="paramtype">const std::string </td>
<td class="paramname"> <em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemrpt.html#a4d04fc5241bf87fcaffec90f3b23b1ea">vector_string</a> & </td>
<td class="paramname"> <em>keys</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returs a list with all the keys into a section. </p>
<p>Implements <a class="el" href="classmrpt_1_1utils_1_1_c_config_file_base.html#a5e750617eddcdae650bf513138f19c5c">mrpt::utils::CConfigFileBase</a>.</p>
</div>
</div>
<a class="anchor" id="a134598f52d24e5fb6f130dcb90207eae"></a><!-- doxytag: member="mrpt::utils::CConfigFile::getAllSections" ref="a134598f52d24e5fb6f130dcb90207eae" args="(vector_string &sections) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void mrpt::utils::CConfigFile::getAllSections </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemrpt.html#a4d04fc5241bf87fcaffec90f3b23b1ea">vector_string</a> & </td>
<td class="paramname"> <em>sections</em> )</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a list with all the section names. </p>
<p>Implements <a class="el" href="classmrpt_1_1utils_1_1_c_config_file_base.html#afaa2b4f8a4c976a524953fa83f724244">mrpt::utils::CConfigFileBase</a>.</p>
</div>
</div>
<a class="anchor" id="afe9631fca69de992a4454f534e3cc703"></a><!-- doxytag: member="mrpt::utils::CConfigFile::getAssociatedFile" ref="afe9631fca69de992a4454f534e3cc703" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string mrpt::utils::CConfigFile::getAssociatedFile </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the file currently open by this object. </p>
<p>Definition at line <a class="el" href="_c_config_file_8h_source.html#l00094">94</a> of file <a class="el" href="_c_config_file_8h_source.html">CConfigFile.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9bc2f3a2fe91fbd9207c07ae88c3bc65"></a><!-- doxytag: member="mrpt::utils::CConfigFile::readString" ref="a9bc2f3a2fe91fbd9207c07ae88c3bc65" args="(const std::string &section, const std::string &name, const std::string &defaultStr, bool failIfNotFound=false) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string mrpt::utils::CConfigFile::readString </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>defaultStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>failIfNotFound</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A virtual method to read a generic string. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">std::exception</td><td>If the key name is not found and "failIfNotFound" is true. Otherwise the "defaultValue" is returned. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classmrpt_1_1utils_1_1_c_config_file_base.html#acd312c4eedaf9dc94fd5f4fda1783738">mrpt::utils::CConfigFileBase</a>.</p>
</div>
</div>
<a class="anchor" id="aafcefa07b09c2c41a18f75c2ae4df83e"></a><!-- doxytag: member="mrpt::utils::CConfigFile::setFileName" ref="aafcefa07b09c2c41a18f75c2ae4df83e" args="(const std::string &fil_path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CConfigFile::setFileName </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>fil_path</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Associate this object with the given file, so future read/write operations will be applied to that file (it's synchronized at destruction). </p>
</div>
</div>
<a class="anchor" id="afa330002e3a5e166f57441184301a5ab"></a><!-- doxytag: member="mrpt::utils::CConfigFile::writeNow" ref="afa330002e3a5e166f57441184301a5ab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CConfigFile::writeNow </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dumps the changes to the physical configuration file now, not waiting until destruction. </p>
</div>
</div>
<a class="anchor" id="a94cc241cc6cb9121e9275e971ed1c33a"></a><!-- doxytag: member="mrpt::utils::CConfigFile::writeString" ref="a94cc241cc6cb9121e9275e971ed1c33a" args="(const std::string &section, const std::string &name, const std::string &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CConfigFile::writeString </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>str</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A virtual method to write a generic string. </p>
<p>Implements <a class="el" href="classmrpt_1_1utils_1_1_c_config_file_base.html#a2875d663230ca4268f1f545a19799c1d">mrpt::utils::CConfigFileBase</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9a6ae155df35151bdf14388af49d95ef"></a><!-- doxytag: member="mrpt::utils::CConfigFile::m_file" ref="a9a6ae155df35151bdf14388af49d95ef" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#a9a6ae155df35151bdf14388af49d95ef">mrpt::utils::CConfigFile::m_file</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the file. </p>
<p>Definition at line <a class="el" href="_c_config_file_8h_source.html#l00052">52</a> of file <a class="el" href="_c_config_file_8h_source.html">CConfigFile.h</a>.</p>
</div>
</div>
<a class="anchor" id="a54c8d27c171d05bd692ee0455fc2b35f"></a><!-- doxytag: member="mrpt::utils::CConfigFile::m_ini" ref="a54c8d27c171d05bd692ee0455fc2b35f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmrpt_1_1utils_1_1non__copiable__ptr__basic.html">void_ptr_noncopy</a> <a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#a54c8d27c171d05bd692ee0455fc2b35f">mrpt::utils::CConfigFile::m_ini</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The interface to the <a href="file:">file:</a> </p>
<p>Definition at line <a class="el" href="_c_config_file_8h_source.html#l00056">56</a> of file <a class="el" href="_c_config_file_8h_source.html">CConfigFile.h</a>.</p>
</div>
</div>
<a class="anchor" id="abccf737438319124ffd9ed5e36bcdd3b"></a><!-- doxytag: member="mrpt::utils::CConfigFile::m_modified" ref="abccf737438319124ffd9ed5e36bcdd3b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmrpt_1_1utils_1_1_c_config_file.html#abccf737438319124ffd9ed5e36bcdd3b">mrpt::utils::CConfigFile::m_modified</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If modified since load. </p>
<p>Definition at line <a class="el" href="_c_config_file_8h_source.html#l00060">60</a> of file <a class="el" href="_c_config_file_8h_source.html">CConfigFile.h</a>.</p>
</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.2</a> for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
