279 lines
38 KiB
HTML
279 lines
38 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>PIP: PIConfig Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">PIP
|
|
 <span id="projectnumber">1.0.0_rc3</span>
|
|
</div>
|
|
<div id="projectbrief">Platform-Independent Primitives</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('class_p_i_config.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_p_i_config-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PIConfig Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Configuration file.
|
|
<a href="class_p_i_config.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config_1_1_branch.html">Branch</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Branch is a list of entries of configuration file <a href="class_p_i_config_1_1_branch.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config_1_1_entry.html">Entry</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Entry of configuration file <a href="class_p_i_config_1_1_entry.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a283394a8822215eaf98a828df32ae72d"><td class="memItemLeft" align="right" valign="top"><a id="a283394a8822215eaf98a828df32ae72d"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a283394a8822215eaf98a828df32ae72d">PIConfig</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &path, <a class="el" href="class_p_i_i_o_device.html#a546a024c6ff4a1dca9350b520e73b595">PIIODevice::DeviceMode</a> mode=<a class="el" href="class_p_i_i_o_device.html#a546a024c6ff4a1dca9350b520e73b595a9a3dfb78656b018b51ce48d95f39234a">PIIODevice::ReadWrite</a>)</td></tr>
|
|
<tr class="memdesc:a283394a8822215eaf98a828df32ae72d"><td class="mdescLeft"> </td><td class="mdescRight">Contructs and read configuration file at path "path" in mode "mode". <br /></td></tr>
|
|
<tr class="separator:a283394a8822215eaf98a828df32ae72d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a174c55efaeafe569618cc7bec43cb877"><td class="memItemLeft" align="right" valign="top"><a id="a174c55efaeafe569618cc7bec43cb877"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a174c55efaeafe569618cc7bec43cb877">PIConfig</a> (<a class="el" href="class_p_i_string.html">PIString</a> *string, <a class="el" href="class_p_i_i_o_device.html#a546a024c6ff4a1dca9350b520e73b595">PIIODevice::DeviceMode</a> mode=<a class="el" href="class_p_i_i_o_device.html#a546a024c6ff4a1dca9350b520e73b595a9a3dfb78656b018b51ce48d95f39234a">PIIODevice::ReadWrite</a>)</td></tr>
|
|
<tr class="memdesc:a174c55efaeafe569618cc7bec43cb877"><td class="mdescLeft"> </td><td class="mdescRight">Contructs and read configuration string "string" in mode "mode". <br /></td></tr>
|
|
<tr class="separator:a174c55efaeafe569618cc7bec43cb877"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0c9218acf5aa9b6ed419ef705260c0e"><td class="memItemLeft" align="right" valign="top"><a id="ac0c9218acf5aa9b6ed419ef705260c0e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ac0c9218acf5aa9b6ed419ef705260c0e">PIConfig</a> (<a class="el" href="class_p_i_i_o_device.html">PIIODevice</a> *device=0, <a class="el" href="class_p_i_i_o_device.html#a546a024c6ff4a1dca9350b520e73b595">PIIODevice::DeviceMode</a> mode=<a class="el" href="class_p_i_i_o_device.html#a546a024c6ff4a1dca9350b520e73b595a9a3dfb78656b018b51ce48d95f39234a">PIIODevice::ReadWrite</a>)</td></tr>
|
|
<tr class="memdesc:ac0c9218acf5aa9b6ed419ef705260c0e"><td class="mdescLeft"> </td><td class="mdescRight">Contructs and read configuration from custom device "device" in mode "mode". <br /></td></tr>
|
|
<tr class="separator:ac0c9218acf5aa9b6ed419ef705260c0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0312e03a9c2293e8efdb2766e8286ed9"><td class="memItemLeft" align="right" valign="top"><a id="a0312e03a9c2293e8efdb2766e8286ed9"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a0312e03a9c2293e8efdb2766e8286ed9">open</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &path, <a class="el" href="class_p_i_i_o_device.html#a546a024c6ff4a1dca9350b520e73b595">PIIODevice::DeviceMode</a> mode=<a class="el" href="class_p_i_i_o_device.html#a546a024c6ff4a1dca9350b520e73b595a9a3dfb78656b018b51ce48d95f39234a">PIIODevice::ReadWrite</a>)</td></tr>
|
|
<tr class="memdesc:a0312e03a9c2293e8efdb2766e8286ed9"><td class="mdescLeft"> </td><td class="mdescRight">Read configuration file at path "path" in mode "mode". <br /></td></tr>
|
|
<tr class="separator:a0312e03a9c2293e8efdb2766e8286ed9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5c4db345838b07e122878168193304d"><td class="memItemLeft" align="right" valign="top"><a id="ac5c4db345838b07e122878168193304d"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ac5c4db345838b07e122878168193304d">open</a> (<a class="el" href="class_p_i_string.html">PIString</a> *string, <a class="el" href="class_p_i_i_o_device.html#a546a024c6ff4a1dca9350b520e73b595">PIIODevice::DeviceMode</a> mode=<a class="el" href="class_p_i_i_o_device.html#a546a024c6ff4a1dca9350b520e73b595a9a3dfb78656b018b51ce48d95f39234a">PIIODevice::ReadWrite</a>)</td></tr>
|
|
<tr class="memdesc:ac5c4db345838b07e122878168193304d"><td class="mdescLeft"> </td><td class="mdescRight">Read configuration string "string" in mode "mode". <br /></td></tr>
|
|
<tr class="separator:ac5c4db345838b07e122878168193304d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa9ff95ee07a0426a06196cdb0674bb1"><td class="memItemLeft" align="right" valign="top"><a id="afa9ff95ee07a0426a06196cdb0674bb1"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#afa9ff95ee07a0426a06196cdb0674bb1">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const <a class="el" href="class_p_i_string.html">PIString</a> &def=<a class="el" href="class_p_i_string.html">PIString</a>(), bool *exists=0)</td></tr>
|
|
<tr class="memdesc:afa9ff95ee07a0426a06196cdb0674bb1"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname", if doesn`t exists return entry with value "def" and set *exist to false. <br /></td></tr>
|
|
<tr class="separator:afa9ff95ee07a0426a06196cdb0674bb1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa58ad8481d1f0280a3bd4c92f47f516f"><td class="memItemLeft" align="right" valign="top"><a id="aa58ad8481d1f0280a3bd4c92f47f516f"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#aa58ad8481d1f0280a3bd4c92f47f516f">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const char *def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:aa58ad8481d1f0280a3bd4c92f47f516f"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:aa58ad8481d1f0280a3bd4c92f47f516f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59ee8d190f4a82e2fbe4e0320877e0a7"><td class="memItemLeft" align="right" valign="top"><a id="a59ee8d190f4a82e2fbe4e0320877e0a7"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a59ee8d190f4a82e2fbe4e0320877e0a7">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const <a class="el" href="class_p_i_string_list.html">PIStringList</a> &def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:a59ee8d190f4a82e2fbe4e0320877e0a7"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:a59ee8d190f4a82e2fbe4e0320877e0a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f44b199f4679ee58df0b7e1db44b4f1"><td class="memItemLeft" align="right" valign="top"><a id="a5f44b199f4679ee58df0b7e1db44b4f1"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a5f44b199f4679ee58df0b7e1db44b4f1">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const bool def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:a5f44b199f4679ee58df0b7e1db44b4f1"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:a5f44b199f4679ee58df0b7e1db44b4f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2fa98010be70e9d7fda3baa56804ad0"><td class="memItemLeft" align="right" valign="top"><a id="ac2fa98010be70e9d7fda3baa56804ad0"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ac2fa98010be70e9d7fda3baa56804ad0">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const short def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:ac2fa98010be70e9d7fda3baa56804ad0"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:ac2fa98010be70e9d7fda3baa56804ad0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7750ea22e6d133d80070f9ff9328bd7"><td class="memItemLeft" align="right" valign="top"><a id="aa7750ea22e6d133d80070f9ff9328bd7"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#aa7750ea22e6d133d80070f9ff9328bd7">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const int def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:aa7750ea22e6d133d80070f9ff9328bd7"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:aa7750ea22e6d133d80070f9ff9328bd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a073bd20b948c3f68b7eb846f4d080006"><td class="memItemLeft" align="right" valign="top"><a id="a073bd20b948c3f68b7eb846f4d080006"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a073bd20b948c3f68b7eb846f4d080006">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const long def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:a073bd20b948c3f68b7eb846f4d080006"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:a073bd20b948c3f68b7eb846f4d080006"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04ff1fa7aea07e52f1f9b743a7236e0c"><td class="memItemLeft" align="right" valign="top"><a id="a04ff1fa7aea07e52f1f9b743a7236e0c"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a04ff1fa7aea07e52f1f9b743a7236e0c">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const uchar def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:a04ff1fa7aea07e52f1f9b743a7236e0c"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:a04ff1fa7aea07e52f1f9b743a7236e0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae359d44525852377fe944f34f3a3aadf"><td class="memItemLeft" align="right" valign="top"><a id="ae359d44525852377fe944f34f3a3aadf"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ae359d44525852377fe944f34f3a3aadf">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const ushort def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:ae359d44525852377fe944f34f3a3aadf"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:ae359d44525852377fe944f34f3a3aadf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab37b341b3468d25beae61112ec0da134"><td class="memItemLeft" align="right" valign="top"><a id="ab37b341b3468d25beae61112ec0da134"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ab37b341b3468d25beae61112ec0da134">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const uint def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:ab37b341b3468d25beae61112ec0da134"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:ab37b341b3468d25beae61112ec0da134"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a081565174316b60dc5a6f27ffb0c3118"><td class="memItemLeft" align="right" valign="top"><a id="a081565174316b60dc5a6f27ffb0c3118"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a081565174316b60dc5a6f27ffb0c3118">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const ulong def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:a081565174316b60dc5a6f27ffb0c3118"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:a081565174316b60dc5a6f27ffb0c3118"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9fc2514ae2881bd0cace552b179e58f7"><td class="memItemLeft" align="right" valign="top"><a id="a9fc2514ae2881bd0cace552b179e58f7"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a9fc2514ae2881bd0cace552b179e58f7">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const float def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:a9fc2514ae2881bd0cace552b179e58f7"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:a9fc2514ae2881bd0cace552b179e58f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81a5f8e644ef77db5b85b3d0a1169940"><td class="memItemLeft" align="right" valign="top"><a id="a81a5f8e644ef77db5b85b3d0a1169940"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a81a5f8e644ef77db5b85b3d0a1169940">getValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname, const double def, bool *exists=0)</td></tr>
|
|
<tr class="memdesc:a81a5f8e644ef77db5b85b3d0a1169940"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entry with name "vname" and default value "def". <br /></td></tr>
|
|
<tr class="separator:a81a5f8e644ef77db5b85b3d0a1169940"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56e9e758d994f2bd5bb0ddbf93b187e0"><td class="memItemLeft" align="right" valign="top"><a id="a56e9e758d994f2bd5bb0ddbf93b187e0"></a>
|
|
<a class="el" href="class_p_i_config_1_1_branch.html">Branch</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a56e9e758d994f2bd5bb0ddbf93b187e0">getValues</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &vname)</td></tr>
|
|
<tr class="memdesc:a56e9e758d994f2bd5bb0ddbf93b187e0"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entries with names with substrings "vname". <br /></td></tr>
|
|
<tr class="separator:a56e9e758d994f2bd5bb0ddbf93b187e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21a16d4652c57e310f9e4eb4e40dea39"><td class="memItemLeft" align="right" valign="top"><a id="a21a16d4652c57e310f9e4eb4e40dea39"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a21a16d4652c57e310f9e4eb4e40dea39">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const <a class="el" href="class_p_i_string.html">PIString</a> &value, const <a class="el" href="class_p_i_string.html">PIString</a> &type="s", bool write=true)</td></tr>
|
|
<tr class="memdesc:a21a16d4652c57e310f9e4eb4e40dea39"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "type" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:a21a16d4652c57e310f9e4eb4e40dea39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0fd0d0f7932d805655908447dddf4ea"><td class="memItemLeft" align="right" valign="top"><a id="ab0fd0d0f7932d805655908447dddf4ea"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ab0fd0d0f7932d805655908447dddf4ea">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const <a class="el" href="class_p_i_string_list.html">PIStringList</a> &value, bool write=true)</td></tr>
|
|
<tr class="memdesc:ab0fd0d0f7932d805655908447dddf4ea"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "l" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:ab0fd0d0f7932d805655908447dddf4ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab321f10c0a70bb1e357a09879431b08c"><td class="memItemLeft" align="right" valign="top"><a id="ab321f10c0a70bb1e357a09879431b08c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ab321f10c0a70bb1e357a09879431b08c">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const char *value, bool write=true)</td></tr>
|
|
<tr class="memdesc:ab321f10c0a70bb1e357a09879431b08c"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "s" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:ab321f10c0a70bb1e357a09879431b08c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47fd7b93880a60ceabaa95401fc006c9"><td class="memItemLeft" align="right" valign="top"><a id="a47fd7b93880a60ceabaa95401fc006c9"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a47fd7b93880a60ceabaa95401fc006c9">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const bool value, bool write=true)</td></tr>
|
|
<tr class="memdesc:a47fd7b93880a60ceabaa95401fc006c9"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "b" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:a47fd7b93880a60ceabaa95401fc006c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a05152c400b1bcc94154ce54050dfbdd8"><td class="memItemLeft" align="right" valign="top"><a id="a05152c400b1bcc94154ce54050dfbdd8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a05152c400b1bcc94154ce54050dfbdd8">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const short value, bool write=true)</td></tr>
|
|
<tr class="memdesc:a05152c400b1bcc94154ce54050dfbdd8"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:a05152c400b1bcc94154ce54050dfbdd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11affac002d95972f7023bb02a580d2c"><td class="memItemLeft" align="right" valign="top"><a id="a11affac002d95972f7023bb02a580d2c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a11affac002d95972f7023bb02a580d2c">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const int value, bool write=true)</td></tr>
|
|
<tr class="memdesc:a11affac002d95972f7023bb02a580d2c"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:a11affac002d95972f7023bb02a580d2c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acdac45e85e5a9e48301bb66f5e596237"><td class="memItemLeft" align="right" valign="top"><a id="acdac45e85e5a9e48301bb66f5e596237"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#acdac45e85e5a9e48301bb66f5e596237">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const long value, bool write=true)</td></tr>
|
|
<tr class="memdesc:acdac45e85e5a9e48301bb66f5e596237"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:acdac45e85e5a9e48301bb66f5e596237"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa92620b2af384471e86ed5095643d10a"><td class="memItemLeft" align="right" valign="top"><a id="aa92620b2af384471e86ed5095643d10a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#aa92620b2af384471e86ed5095643d10a">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const uchar value, bool write=true)</td></tr>
|
|
<tr class="memdesc:aa92620b2af384471e86ed5095643d10a"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:aa92620b2af384471e86ed5095643d10a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2252cdecef6f23dd22f68482ad2f3aa8"><td class="memItemLeft" align="right" valign="top"><a id="a2252cdecef6f23dd22f68482ad2f3aa8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a2252cdecef6f23dd22f68482ad2f3aa8">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const ushort value, bool write=true)</td></tr>
|
|
<tr class="memdesc:a2252cdecef6f23dd22f68482ad2f3aa8"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:a2252cdecef6f23dd22f68482ad2f3aa8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a727a3a4efbd6d4bd10592acb2e94b35c"><td class="memItemLeft" align="right" valign="top"><a id="a727a3a4efbd6d4bd10592acb2e94b35c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a727a3a4efbd6d4bd10592acb2e94b35c">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const uint value, bool write=true)</td></tr>
|
|
<tr class="memdesc:a727a3a4efbd6d4bd10592acb2e94b35c"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:a727a3a4efbd6d4bd10592acb2e94b35c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad94dcedcb0e7e08e68729cba293342ff"><td class="memItemLeft" align="right" valign="top"><a id="ad94dcedcb0e7e08e68729cba293342ff"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ad94dcedcb0e7e08e68729cba293342ff">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const ulong value, bool write=true)</td></tr>
|
|
<tr class="memdesc:ad94dcedcb0e7e08e68729cba293342ff"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:ad94dcedcb0e7e08e68729cba293342ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac99bcbe1e6656c15481d2b4e7a6aacae"><td class="memItemLeft" align="right" valign="top"><a id="ac99bcbe1e6656c15481d2b4e7a6aacae"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ac99bcbe1e6656c15481d2b4e7a6aacae">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const float value, bool write=true)</td></tr>
|
|
<tr class="memdesc:ac99bcbe1e6656c15481d2b4e7a6aacae"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "f" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:ac99bcbe1e6656c15481d2b4e7a6aacae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa45477274950fc3b50f5e6ece6299c7a"><td class="memItemLeft" align="right" valign="top"><a id="aa45477274950fc3b50f5e6ece6299c7a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#aa45477274950fc3b50f5e6ece6299c7a">setValue</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name, const double value, bool write=true)</td></tr>
|
|
<tr class="memdesc:aa45477274950fc3b50f5e6ece6299c7a"><td class="mdescLeft"> </td><td class="mdescRight">Set top-level entry with name "name" value to "value", type to "f" and if "write" immediate write to file. Add new entry if there is no suitable exists. <br /></td></tr>
|
|
<tr class="separator:aa45477274950fc3b50f5e6ece6299c7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3b501c744eec9526b06509e14e868ec"><td class="memItemLeft" align="right" valign="top"><a id="ab3b501c744eec9526b06509e14e868ec"></a>
|
|
<a class="el" href="class_p_i_config_1_1_entry.html">Entry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ab3b501c744eec9526b06509e14e868ec">rootEntry</a> ()</td></tr>
|
|
<tr class="memdesc:ab3b501c744eec9526b06509e14e868ec"><td class="mdescLeft"> </td><td class="mdescRight">Returns root entry. <br /></td></tr>
|
|
<tr class="separator:ab3b501c744eec9526b06509e14e868ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3b3acbc89aef7d5091e71e4bd4f29a60"><td class="memItemLeft" align="right" valign="top"><a id="a3b3acbc89aef7d5091e71e4bd4f29a60"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a3b3acbc89aef7d5091e71e4bd4f29a60">entriesCount</a> () const</td></tr>
|
|
<tr class="memdesc:a3b3acbc89aef7d5091e71e4bd4f29a60"><td class="mdescLeft"> </td><td class="mdescRight">Returns top-level entries count. <br /></td></tr>
|
|
<tr class="separator:a3b3acbc89aef7d5091e71e4bd4f29a60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a659a76abf492295fef7dc8850ad86f1c"><td class="memItemLeft" align="right" valign="top"><a id="a659a76abf492295fef7dc8850ad86f1c"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a659a76abf492295fef7dc8850ad86f1c">isEntryExists</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &name) const</td></tr>
|
|
<tr class="memdesc:a659a76abf492295fef7dc8850ad86f1c"><td class="mdescLeft"> </td><td class="mdescRight">Returns if top-level entry with name "name" exists. <br /></td></tr>
|
|
<tr class="separator:a659a76abf492295fef7dc8850ad86f1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16f81586debe78f0ad886aac2c5d20f0"><td class="memItemLeft" align="right" valign="top"><a id="a16f81586debe78f0ad886aac2c5d20f0"></a>
|
|
<a class="el" href="class_p_i_config_1_1_branch.html">Branch</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a16f81586debe78f0ad886aac2c5d20f0">allTree</a> ()</td></tr>
|
|
<tr class="memdesc:a16f81586debe78f0ad886aac2c5d20f0"><td class="mdescLeft"> </td><td class="mdescRight">Returns all top-level entries. <br /></td></tr>
|
|
<tr class="separator:a16f81586debe78f0ad886aac2c5d20f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52ba17ebcb28248b1ec4fcedd9deba4b"><td class="memItemLeft" align="right" valign="top"><a id="a52ba17ebcb28248b1ec4fcedd9deba4b"></a>
|
|
<a class="el" href="class_p_i_config_1_1_branch.html">Branch</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a52ba17ebcb28248b1ec4fcedd9deba4b">allLeaves</a> ()</td></tr>
|
|
<tr class="memdesc:a52ba17ebcb28248b1ec4fcedd9deba4b"><td class="mdescLeft"> </td><td class="mdescRight">Returns all entries without children. <br /></td></tr>
|
|
<tr class="separator:a52ba17ebcb28248b1ec4fcedd9deba4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5183a5859cd1006d4e93bf007b28fd2b"><td class="memItemLeft" align="right" valign="top"><a id="a5183a5859cd1006d4e93bf007b28fd2b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a5183a5859cd1006d4e93bf007b28fd2b">clear</a> ()</td></tr>
|
|
<tr class="memdesc:a5183a5859cd1006d4e93bf007b28fd2b"><td class="mdescLeft"> </td><td class="mdescRight">Remove all tree and device content. <br /></td></tr>
|
|
<tr class="separator:a5183a5859cd1006d4e93bf007b28fd2b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2bb45897ec17ef66c729dfe7d43a135"><td class="memItemLeft" align="right" valign="top"><a id="ab2bb45897ec17ef66c729dfe7d43a135"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ab2bb45897ec17ef66c729dfe7d43a135">readAll</a> ()</td></tr>
|
|
<tr class="memdesc:ab2bb45897ec17ef66c729dfe7d43a135"><td class="mdescLeft"> </td><td class="mdescRight">Parse device and build internal tree. <br /></td></tr>
|
|
<tr class="separator:ab2bb45897ec17ef66c729dfe7d43a135"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d228b9feed1e5a301da526ea4cd4d01"><td class="memItemLeft" align="right" valign="top"><a id="a7d228b9feed1e5a301da526ea4cd4d01"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a7d228b9feed1e5a301da526ea4cd4d01">writeAll</a> ()</td></tr>
|
|
<tr class="memdesc:a7d228b9feed1e5a301da526ea4cd4d01"><td class="mdescLeft"> </td><td class="mdescRight">Write all internal tree to device. <br /></td></tr>
|
|
<tr class="separator:a7d228b9feed1e5a301da526ea4cd4d01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75d09b6268c97c8a865b04c9276fb851"><td class="memItemLeft" align="right" valign="top"><a id="a75d09b6268c97c8a865b04c9276fb851"></a>
|
|
const <a class="el" href="class_p_i_string.html">PIString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#a75d09b6268c97c8a865b04c9276fb851">delimiter</a> () const</td></tr>
|
|
<tr class="memdesc:a75d09b6268c97c8a865b04c9276fb851"><td class="mdescLeft"> </td><td class="mdescRight">Returns current tree delimiter, default ".". <br /></td></tr>
|
|
<tr class="separator:a75d09b6268c97c8a865b04c9276fb851"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae196cc6e271aa930c7c0849150df868c"><td class="memItemLeft" align="right" valign="top"><a id="ae196cc6e271aa930c7c0849150df868c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_config.html#ae196cc6e271aa930c7c0849150df868c">setDelimiter</a> (const <a class="el" href="class_p_i_string.html">PIString</a> &d)</td></tr>
|
|
<tr class="memdesc:ae196cc6e271aa930c7c0849150df868c"><td class="mdescLeft"> </td><td class="mdescRight">Set current tree delimiter. <br /></td></tr>
|
|
<tr class="separator:ae196cc6e271aa930c7c0849150df868c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Configuration file. </p>
|
|
<p>This class provide handle access to configuration file.</p>
|
|
<h1><a class="anchor" id="PIConfig_sec0"></a>
|
|
Synopsis</h1>
|
|
<p><a class="el" href="class_p_i_config.html" title="Configuration file. ">PIConfig</a> reads configuration file and create internal dendritic representation of all entries of this file. You can easily read some values and write new. </p><div class="image">
|
|
<img src="piconfig.png" alt="piconfig.png"/>
|
|
</div>
|
|
<p>PIConfig supports also INI-style files with sections "[section]". In this case line with section name interpret as prefix to the next lines. For example, these configs are equal: </p><div class="fragment"><div class="line">ser.device = /dev/ttyS0</div><div class="line">ser.speed = 115200</div><div class="line">debug = <span class="keyword">true</span></div></div><!-- fragment --> <div class="fragment"><div class="line">[ser]</div><div class="line">device = /dev/ttyS0</div><div class="line">speed = 115200</div><div class="line">[]</div><div class="line">debug = <span class="keyword">true</span></div></div><!-- fragment --><h1><a class="anchor" id="PIConfig_sec1"></a>
|
|
Concepts</h1>
|
|
<p>Each node of internal tree has type <a class="el" href="class_p_i_config_1_1_entry.html" title="Entry of configuration file ">PIConfig::Entry</a>. PIConfig has one root element <em><a class="el" href="class_p_i_config.html#ab3b501c744eec9526b06509e14e868ec" title="Returns root entry. ">rootEntry()</a></em>. Any entry of configuration file is a child of this element. </p>
|
|
</div></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_p_i_config.html">PIConfig</a></li>
|
|
<li class="footer">Generated on Tue May 23 2017 11:20:44 for PIP by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|