mirror of
https://github.com/XRPLF/rippled.git
synced 2026-02-06 23:15:32 +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: xrpl::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="namespacexrpl.html">xrpl</a></li><li class="navelem"><a class="el" href="classxrpl_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="classxrpl_1_1BasicConfig-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">xrpl::BasicConfig Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Holds unparsed configuration information.
|
|
<a href="classxrpl_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 xrpl::BasicConfig:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classxrpl_1_1BasicConfig__inherit__graph.png" border="0" usemap="#axrpl_1_1BasicConfig_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="axrpl_1_1BasicConfig_inherit__map" id="axrpl_1_1BasicConfig_inherit__map">
|
|
<area shape="rect" title="Holds unparsed configuration information." alt="" coords="5,5,136,31"/>
|
|
<area shape="rect" href="classxrpl_1_1Config.html" title=" " alt="" coords="23,79,119,104"/>
|
|
<area shape="poly" title=" " alt="" coords="73,44,73,79,68,79,68,44"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for xrpl::BasicConfig:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classxrpl_1_1BasicConfig__coll__graph.png" border="0" usemap="#axrpl_1_1BasicConfig_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="axrpl_1_1BasicConfig_coll__map" id="axrpl_1_1BasicConfig_coll__map">
|
|
<area shape="rect" title="Holds unparsed configuration information." alt="" coords="1140,20,1271,45"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="899,5,1051,60"/>
|
|
<area shape="poly" title=" " alt="" coords="1065,30,1140,30,1140,35,1065,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,379,39,444,30,555,26,666,30,809,31,899,30,899,35,809,37,666,36,555,32,444,36,380,44,305,59,276,69"/>
|
|
<area shape="rect" href="classxrpl_1_1Section.html" title="Holds a collection of configuration values." alt="" coords="683,69,785,95"/>
|
|
<area shape="poly" title=" " alt="" coords="294,76,304,75,481,71,659,75,683,76,682,82,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="798,66,898,46,899,51,799,71"/>
|
|
<area shape="poly" title=" " alt="" coords="576,114,682,90,683,96,577,119"/>
|
|
<area shape="poly" title=" " alt="" coords="560,180,609,164,657,141,691,117,718,93,721,97,694,121,660,146,612,169,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:a7974ffcf682ba14848fcee8ecdf34337" id="r_a7974ffcf682ba14848fcee8ecdf34337"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#a7974ffcf682ba14848fcee8ecdf34337">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:a7974ffcf682ba14848fcee8ecdf34337"><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:a7974ffcf682ba14848fcee8ecdf34337"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c31a3df3d4001f66c6c1d3263d0637a" id="r_a4c31a3df3d4001f66c6c1d3263d0637a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#a4c31a3df3d4001f66c6c1d3263d0637a">overwrite</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &<a class="el" href="classxrpl_1_1BasicConfig.html#af4adcb2a916d5c27cf360f0cbb0dc991">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:a4c31a3df3d4001f66c6c1d3263d0637a"><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:a4c31a3df3d4001f66c6c1d3263d0637a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d19868e1c55c653bc2eddb55a1d7439" id="r_a1d19868e1c55c653bc2eddb55a1d7439"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#a1d19868e1c55c653bc2eddb55a1d7439">deprecatedClearSection</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &<a class="el" href="classxrpl_1_1BasicConfig.html#af4adcb2a916d5c27cf360f0cbb0dc991">section</a>)</td></tr>
|
|
<tr class="memdesc:a1d19868e1c55c653bc2eddb55a1d7439"><td class="mdescLeft"> </td><td class="mdescRight">Remove all the key/value pairs from the section. <br /></td></tr>
|
|
<tr class="separator:a1d19868e1c55c653bc2eddb55a1d7439"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af378452eb5a101f09de3dfbbeda15fb2" id="r_af378452eb5a101f09de3dfbbeda15fb2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#af378452eb5a101f09de3dfbbeda15fb2">legacy</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &<a class="el" href="classxrpl_1_1BasicConfig.html#af4adcb2a916d5c27cf360f0cbb0dc991">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:af378452eb5a101f09de3dfbbeda15fb2"><td class="mdescLeft"> </td><td class="mdescRight">Set a value that is not a key/value pair. <br /></td></tr>
|
|
<tr class="separator:af378452eb5a101f09de3dfbbeda15fb2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad07db1694533d4b402cd33a345269129" id="r_ad07db1694533d4b402cd33a345269129"><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="classxrpl_1_1BasicConfig.html#ad07db1694533d4b402cd33a345269129">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:ad07db1694533d4b402cd33a345269129"><td class="mdescLeft"> </td><td class="mdescRight">Get the legacy value of a section. <br /></td></tr>
|
|
<tr class="separator:ad07db1694533d4b402cd33a345269129"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa904acabbc4764c3b3b926fd92a2f8ac" id="r_aa904acabbc4764c3b3b926fd92a2f8ac"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#aa904acabbc4764c3b3b926fd92a2f8ac">had_trailing_comments</a> () const</td></tr>
|
|
<tr class="separator:aa904acabbc4764c3b3b926fd92a2f8ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
|
|
<tr class="memitem:af4adcb2a916d5c27cf360f0cbb0dc991" id="r_af4adcb2a916d5c27cf360f0cbb0dc991"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classxrpl_1_1Section.html">Section</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#af4adcb2a916d5c27cf360f0cbb0dc991">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:af4adcb2a916d5c27cf360f0cbb0dc991"><td class="mdescLeft"> </td><td class="mdescRight">Returns the section with the given name. <br /></td></tr>
|
|
<tr class="separator:af4adcb2a916d5c27cf360f0cbb0dc991"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7665c744f78688005080c9f583971eab" id="r_a7665c744f78688005080c9f583971eab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classxrpl_1_1Section.html">Section</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#a7665c744f78688005080c9f583971eab">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:a7665c744f78688005080c9f583971eab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03cb74dcdc39fdde94b5bc1694ab7596" id="r_a03cb74dcdc39fdde94b5bc1694ab7596"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classxrpl_1_1Section.html">Section</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#a03cb74dcdc39fdde94b5bc1694ab7596">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:a03cb74dcdc39fdde94b5bc1694ab7596"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a93c79afe888ca69f9b85c6372c12a920" id="r_a93c79afe888ca69f9b85c6372c12a920"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classxrpl_1_1Section.html">Section</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#a93c79afe888ca69f9b85c6372c12a920">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:a93c79afe888ca69f9b85c6372c12a920"><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:a3e458dc187d8c5d082c329e73d7edb3a" id="r_a3e458dc187d8c5d082c329e73d7edb3a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#a3e458dc187d8c5d082c329e73d7edb3a">build</a> (<a class="el" href="namespacexrpl.html#a804b8fe629c768d93d55d64f4e648206">IniFileSections</a> const &ifs)</td></tr>
|
|
<tr class="separator:a3e458dc187d8c5d082c329e73d7edb3a"><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:a5d57890383640547bc67e95e50270665" id="r_a5d57890383640547bc67e95e50270665"><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="classxrpl_1_1Section.html">Section</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1BasicConfig.html#a5d57890383640547bc67e95e50270665">map_</a></td></tr>
|
|
<tr class="separator:a5d57890383640547bc67e95e50270665"><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="classxrpl_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="classxrpl_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#l00195">195</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="a7974ffcf682ba14848fcee8ecdf34337" name="a7974ffcf682ba14848fcee8ecdf34337"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7974ffcf682ba14848fcee8ecdf34337">◆ </a></span>exists()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool xrpl::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="af4adcb2a916d5c27cf360f0cbb0dc991" name="af4adcb2a916d5c27cf360f0cbb0dc991"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af4adcb2a916d5c27cf360f0cbb0dc991">◆ </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="classxrpl_1_1Section.html">Section</a> & xrpl::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="a7665c744f78688005080c9f583971eab" name="a7665c744f78688005080c9f583971eab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7665c744f78688005080c9f583971eab">◆ </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="classxrpl_1_1Section.html">Section</a> const & xrpl::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="a03cb74dcdc39fdde94b5bc1694ab7596" name="a03cb74dcdc39fdde94b5bc1694ab7596"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03cb74dcdc39fdde94b5bc1694ab7596">◆ </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="classxrpl_1_1Section.html">Section</a> const & xrpl::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#l00216">216</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a93c79afe888ca69f9b85c6372c12a920" name="a93c79afe888ca69f9b85c6372c12a920"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a93c79afe888ca69f9b85c6372c12a920">◆ </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="classxrpl_1_1Section.html">Section</a> & xrpl::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#l00222">222</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c31a3df3d4001f66c6c1d3263d0637a" name="a4c31a3df3d4001f66c6c1d3263d0637a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c31a3df3d4001f66c6c1d3263d0637a">◆ </a></span>overwrite()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void xrpl::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="a1d19868e1c55c653bc2eddb55a1d7439" name="a1d19868e1c55c653bc2eddb55a1d7439"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d19868e1c55c653bc2eddb55a1d7439">◆ </a></span>deprecatedClearSection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void xrpl::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#l00140">140</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af378452eb5a101f09de3dfbbeda15fb2" name="af378452eb5a101f09de3dfbbeda15fb2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af378452eb5a101f09de3dfbbeda15fb2">◆ </a></span>legacy() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void xrpl::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#l00148">148</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad07db1694533d4b402cd33a345269129" name="ad07db1694533d4b402cd33a345269129"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad07db1694533d4b402cd33a345269129">◆ </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> xrpl::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#l00154">154</a> of file <a class="el" href="BasicConfig_8cpp_source.html">BasicConfig.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa904acabbc4764c3b3b926fd92a2f8ac" name="aa904acabbc4764c3b3b926fd92a2f8ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa904acabbc4764c3b3b926fd92a2f8ac">◆ </a></span>had_trailing_comments()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool xrpl::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#l00269">269</a> of file <a class="el" href="BasicConfig_8h_source.html">BasicConfig.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3e458dc187d8c5d082c329e73d7edb3a" name="a3e458dc187d8c5d082c329e73d7edb3a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e458dc187d8c5d082c329e73d7edb3a">◆ </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 xrpl::BasicConfig::build </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespacexrpl.html#a804b8fe629c768d93d55d64f4e648206">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#l00160">160</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="classxrpl_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#l00170">170</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="a5d57890383640547bc67e95e50270665" name="a5d57890383640547bc67e95e50270665"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d57890383640547bc67e95e50270665">◆ </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="classxrpl_1_1Section.html">Section</a>> xrpl::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#l00198">198</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>
|