mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 19:15:54 +00:00
529 lines
32 KiB
HTML
529 lines
32 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::BasicConfig 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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1BasicConfig.html">BasicConfig</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<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> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classripple_1_1BasicConfig-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::BasicConfig Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Holds unparsed configuration information.
|
|
<a href="classripple_1_1BasicConfig.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::BasicConfig:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1BasicConfig__inherit__graph.png" border="0" usemap="#aripple_1_1BasicConfig_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aripple_1_1BasicConfig_inherit__map" id="aripple_1_1BasicConfig_inherit__map">
|
|
<area shape="rect" title="Holds unparsed configuration information." alt="" coords="5,5,148,31"/>
|
|
<area shape="rect" href="classripple_1_1Config.html" title=" " alt="" coords="23,79,131,104"/>
|
|
<area shape="poly" title=" " alt="" coords="79,44,79,79,74,79,74,44"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::BasicConfig:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1BasicConfig__coll__graph.png" border="0" usemap="#aripple_1_1BasicConfig_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1BasicConfig_coll__map" id="aripple_1_1BasicConfig_coll__map">
|
|
<area shape="rect" title="Holds unparsed configuration information." alt="" coords="1152,20,1295,45"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="911,5,1063,60"/>
|
|
<area shape="poly" title=" " alt="" coords="1076,30,1152,30,1152,35,1076,35"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="193,72,280,97"/>
|
|
<area shape="poly" title=" " alt="" coords="274,64,303,54,381,39,447,29,561,25,675,29,821,30,911,29,911,35,821,35,675,34,561,30,447,35,382,44,305,59,276,69"/>
|
|
<area shape="rect" href="classripple_1_1Section.html" title="Holds a collection of configuration values." alt="" coords="683,69,797,95"/>
|
|
<area shape="poly" title=" " alt="" coords="294,76,304,75,481,71,659,75,682,76,682,81,659,81,481,76,304,81,294,81"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="411,108,563,163"/>
|
|
<area shape="poly" title=" " alt="" coords="285,99,305,105,411,124,410,129,303,110,284,104"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="393,187,580,212"/>
|
|
<area shape="poly" title=" " alt="" coords="263,105,305,137,366,165,427,184,425,189,364,170,303,142,260,109"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="5,65,144,105"/>
|
|
<area shape="poly" title=" " alt="" coords="157,82,193,82,193,87,157,87"/>
|
|
<area shape="poly" title=" " alt="" coords="811,65,910,45,911,50,812,70"/>
|
|
<area shape="poly" title=" " alt="" coords="576,114,682,91,683,97,577,119"/>
|
|
<area shape="poly" title=" " alt="" coords="560,181,609,165,657,142,694,117,723,93,727,97,697,122,660,147,611,170,562,186"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a09b31b8ed3c769b4c23b040c3d4798ed" id="r_a09b31b8ed3c769b4c23b040c3d4798ed"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a09b31b8ed3c769b4c23b040c3d4798ed">exists</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &name) const</td></tr>
|
|
<tr class="memdesc:a09b31b8ed3c769b4c23b040c3d4798ed"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if a section with the given name exists. <br /></td></tr>
|
|
<tr class="separator:a09b31b8ed3c769b4c23b040c3d4798ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9bc9bfdd56fde61573aae73511504c9" id="r_ac9bc9bfdd56fde61573aae73511504c9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#ac9bc9bfdd56fde61573aae73511504c9">overwrite</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &<a class="el" href="classripple_1_1BasicConfig.html#a60aca585d76b1121dd4f72b358729456">section</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &key, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &value)</td></tr>
|
|
<tr class="memdesc:ac9bc9bfdd56fde61573aae73511504c9"><td class="mdescLeft"> </td><td class="mdescRight">Overwrite a key/value pair with a command line argument If the section does not exist it is created. <br /></td></tr>
|
|
<tr class="separator:ac9bc9bfdd56fde61573aae73511504c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a556417c29df26f83f08f81c64f2375b8" id="r_a556417c29df26f83f08f81c64f2375b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a556417c29df26f83f08f81c64f2375b8">deprecatedClearSection</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &<a class="el" href="classripple_1_1BasicConfig.html#a60aca585d76b1121dd4f72b358729456">section</a>)</td></tr>
|
|
<tr class="memdesc:a556417c29df26f83f08f81c64f2375b8"><td class="mdescLeft"> </td><td class="mdescRight">Remove all the key/value pairs from the section. <br /></td></tr>
|
|
<tr class="separator:a556417c29df26f83f08f81c64f2375b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2c21d011e6424d4917db175ef9df301" id="r_ae2c21d011e6424d4917db175ef9df301"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#ae2c21d011e6424d4917db175ef9df301">legacy</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &<a class="el" href="classripple_1_1BasicConfig.html#a60aca585d76b1121dd4f72b358729456">section</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> value)</td></tr>
|
|
<tr class="memdesc:ae2c21d011e6424d4917db175ef9df301"><td class="mdescLeft"> </td><td class="mdescRight">Set a value that is not a key/value pair. <br /></td></tr>
|
|
<tr class="separator:ae2c21d011e6424d4917db175ef9df301"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad56c45fbeee36f3ee87a1f9411dfb49c" id="r_ad56c45fbeee36f3ee87a1f9411dfb49c"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#ad56c45fbeee36f3ee87a1f9411dfb49c">legacy</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &sectionName) const</td></tr>
|
|
<tr class="memdesc:ad56c45fbeee36f3ee87a1f9411dfb49c"><td class="mdescLeft"> </td><td class="mdescRight">Get the legacy value of a section. <br /></td></tr>
|
|
<tr class="separator:ad56c45fbeee36f3ee87a1f9411dfb49c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e4703f27a2669c445f7c1e22871e974" id="r_a3e4703f27a2669c445f7c1e22871e974"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a3e4703f27a2669c445f7c1e22871e974">had_trailing_comments</a> () const</td></tr>
|
|
<tr class="separator:a3e4703f27a2669c445f7c1e22871e974"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
|
|
<tr class="memitem:a60aca585d76b1121dd4f72b358729456" id="r_a60aca585d76b1121dd4f72b358729456"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Section.html">Section</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a60aca585d76b1121dd4f72b358729456">section</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &name)</td></tr>
|
|
<tr class="memdesc:a60aca585d76b1121dd4f72b358729456"><td class="mdescLeft"> </td><td class="mdescRight">Returns the section with the given name. <br /></td></tr>
|
|
<tr class="separator:a60aca585d76b1121dd4f72b358729456"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a69db08289110c1ef0d82f741f7951baa" id="r_a69db08289110c1ef0d82f741f7951baa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Section.html">Section</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a69db08289110c1ef0d82f741f7951baa">section</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &name) const</td></tr>
|
|
<tr class="separator:a69db08289110c1ef0d82f741f7951baa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45b176522b53f48d98a8bc7dc81d97e8" id="r_a45b176522b53f48d98a8bc7dc81d97e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Section.html">Section</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a45b176522b53f48d98a8bc7dc81d97e8">operator[]</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &name) const</td></tr>
|
|
<tr class="separator:a45b176522b53f48d98a8bc7dc81d97e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb4379bd97f22c862a7059bf0fe9f11a" id="r_adb4379bd97f22c862a7059bf0fe9f11a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Section.html">Section</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#adb4379bd97f22c862a7059bf0fe9f11a">operator[]</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &name)</td></tr>
|
|
<tr class="separator:adb4379bd97f22c862a7059bf0fe9f11a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:aa86db3273a1ea032a13c58220255d6e6" id="r_aa86db3273a1ea032a13c58220255d6e6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#aa86db3273a1ea032a13c58220255d6e6">build</a> (<a class="el" href="namespaceripple.html#ae2acf2a346dd759d84af97c8d5ccbc6f">IniFileSections</a> const &ifs)</td></tr>
|
|
<tr class="separator:aa86db3273a1ea032a13c58220255d6e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:ac1faf413a495d8095b0853d602052276" id="r_ac1faf413a495d8095b0853d602052276"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/unordered_map.html">std::unordered_map</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, <a class="el" href="classripple_1_1Section.html">Section</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#ac1faf413a495d8095b0853d602052276">map_</a></td></tr>
|
|
<tr class="separator:ac1faf413a495d8095b0853d602052276"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a00bcd58948af089ef2c28ac2b173585d" id="r_a00bcd58948af089ef2c28ac2b173585d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1BasicConfig.html#a00bcd58948af089ef2c28ac2b173585d">operator<<</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &ss, <a class="el" href="classripple_1_1BasicConfig.html">BasicConfig</a> const &c)</td></tr>
|
|
<tr class="separator:a00bcd58948af089ef2c28ac2b173585d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Holds unparsed configuration information. </p>
|
|
<p>The raw data sections are processed with intermediate parsers specific to each module instead of being all parsed in a central location. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8h_source.html#l00198">198</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a09b31b8ed3c769b4c23b040c3d4798ed" name="a09b31b8ed3c769b4c23b040c3d4798ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a09b31b8ed3c769b4c23b040c3d4798ed">◆ </a></span>exists()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::BasicConfig::exists </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns <code>true</code> if a section with the given name exists. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00111">111</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a60aca585d76b1121dd4f72b358729456" name="a60aca585d76b1121dd4f72b358729456"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60aca585d76b1121dd4f72b358729456">◆ </a></span>section() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Section.html">Section</a> & ripple::BasicConfig::section </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the section with the given name. </p>
|
|
<p>If the section does not exist, an empty section is returned. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00117">117</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a69db08289110c1ef0d82f741f7951baa" name="a69db08289110c1ef0d82f741f7951baa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a69db08289110c1ef0d82f741f7951baa">◆ </a></span>section() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Section.html">Section</a> const & ripple::BasicConfig::section </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00123">123</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a45b176522b53f48d98a8bc7dc81d97e8" name="a45b176522b53f48d98a8bc7dc81d97e8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a45b176522b53f48d98a8bc7dc81d97e8">◆ </a></span>operator[]() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Section.html">Section</a> const & ripple::BasicConfig::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8h_source.html#l00219">219</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adb4379bd97f22c862a7059bf0fe9f11a" name="adb4379bd97f22c862a7059bf0fe9f11a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adb4379bd97f22c862a7059bf0fe9f11a">◆ </a></span>operator[]() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1Section.html">Section</a> & ripple::BasicConfig::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8h_source.html#l00225">225</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9bc9bfdd56fde61573aae73511504c9" name="ac9bc9bfdd56fde61573aae73511504c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9bc9bfdd56fde61573aae73511504c9">◆ </a></span>overwrite()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::BasicConfig::overwrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>section</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overwrite a key/value pair with a command line argument If the section does not exist it is created. </p>
|
|
<p>The previous value, if any, is overwritten. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00133">133</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a556417c29df26f83f08f81c64f2375b8" name="a556417c29df26f83f08f81c64f2375b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a556417c29df26f83f08f81c64f2375b8">◆ </a></span>deprecatedClearSection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::BasicConfig::deprecatedClearSection </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>section</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove all the key/value pairs from the section. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00146">146</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2c21d011e6424d4917db175ef9df301" name="ae2c21d011e6424d4917db175ef9df301"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2c21d011e6424d4917db175ef9df301">◆ </a></span>legacy() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::BasicConfig::legacy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>section</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a value that is not a key/value pair. </p>
|
|
<p>The value is stored as the section's first value and may be retrieved through section::legacy.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">section</td><td>Name of the section to modify. </td></tr>
|
|
<tr><td class="paramname">value</td><td>Contents of the legacy value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00154">154</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad56c45fbeee36f3ee87a1f9411dfb49c" name="ad56c45fbeee36f3ee87a1f9411dfb49c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad56c45fbeee36f3ee87a1f9411dfb49c">◆ </a></span>legacy() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::BasicConfig::legacy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>sectionName</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the legacy value of a section. </p>
|
|
<p>A section with a single-line value may be retrieved as a legacy value.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sectionName</td><td>Retrieve the contents of this section's legacy value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Contents of the legacy value. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00160">160</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3e4703f27a2669c445f7c1e22871e974" name="a3e4703f27a2669c445f7c1e22871e974"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e4703f27a2669c445f7c1e22871e974">◆ </a></span>had_trailing_comments()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::BasicConfig::had_trailing_comments </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8h_source.html#l00275">275</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa86db3273a1ea032a13c58220255d6e6" name="aa86db3273a1ea032a13c58220255d6e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa86db3273a1ea032a13c58220255d6e6">◆ </a></span>build()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::BasicConfig::build </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#ae2acf2a346dd759d84af97c8d5ccbc6f">IniFileSections</a> const & </td>
|
|
<td class="paramname"><em>ifs</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00166">166</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
|
<a id="a00bcd58948af089ef2c28ac2b173585d" name="a00bcd58948af089ef2c28ac2b173585d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a00bcd58948af089ef2c28ac2b173585d">◆ </a></span>operator<<</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> & operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> & </td>
|
|
<td class="paramname"><em>ss</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1BasicConfig.html">BasicConfig</a> const & </td>
|
|
<td class="paramname"><em>c</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8cpp_source.html#l00178">178</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="ac1faf413a495d8095b0853d602052276" name="ac1faf413a495d8095b0853d602052276"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1faf413a495d8095b0853d602052276">◆ </a></span>map_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/unordered_map.html">std::unordered_map</a><<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, <a class="el" href="classripple_1_1Section.html">Section</a>> ripple::BasicConfig::map_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="BasicConfig_8h_source.html#l00201">201</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|