blob: 74f4ebb9a297a06c9653cd385b23d7429cd53d42 [file] [log] [blame]
<!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>iceberg-cpp: iceberg::ConfigBase&lt; ConcreteConfig &gt; Class Template 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">iceberg-cpp
</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&amp;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&amp;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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1ConfigBase.html">ConfigBase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classiceberg_1_1ConfigBase-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::ConfigBase&lt; ConcreteConfig &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ConfigBase_1_1Entry.html">Entry</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a3c626ca9dd5adf5a1f2e72d3f751059c" id="r_a3c626ca9dd5adf5a1f2e72d3f751059c"><td class="memTemplParams" colspan="2"><a id="a3c626ca9dd5adf5a1f2e72d3f751059c" name="a3c626ca9dd5adf5a1f2e72d3f751059c"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a3c626ca9dd5adf5a1f2e72d3f751059c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classiceberg_1_1ConfigBase.html">ConfigBase</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Set</b> (const <a class="el" href="classiceberg_1_1ConfigBase_1_1Entry.html">Entry</a>&lt; T &gt; &amp;entry, const T &amp;val)</td></tr>
<tr class="separator:a3c626ca9dd5adf5a1f2e72d3f751059c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fe814df79a9ed72e34fa9d7e6e8d443" id="r_a1fe814df79a9ed72e34fa9d7e6e8d443"><td class="memTemplParams" colspan="2"><a id="a1fe814df79a9ed72e34fa9d7e6e8d443" name="a1fe814df79a9ed72e34fa9d7e6e8d443"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a1fe814df79a9ed72e34fa9d7e6e8d443"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classiceberg_1_1ConfigBase.html">ConfigBase</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Unset</b> (const <a class="el" href="classiceberg_1_1ConfigBase_1_1Entry.html">Entry</a>&lt; T &gt; &amp;entry)</td></tr>
<tr class="separator:a1fe814df79a9ed72e34fa9d7e6e8d443"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95b58a9275880fc2437210f42e8946f2" id="r_a95b58a9275880fc2437210f42e8946f2"><td class="memItemLeft" align="right" valign="top"><a id="a95b58a9275880fc2437210f42e8946f2" name="a95b58a9275880fc2437210f42e8946f2"></a>
<a class="el" href="classiceberg_1_1ConfigBase.html">ConfigBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Reset</b> ()</td></tr>
<tr class="separator:a95b58a9275880fc2437210f42e8946f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a793c5c7e230dac7b87c16200f8263db6" id="r_a793c5c7e230dac7b87c16200f8263db6"><td class="memTemplParams" colspan="2"><a id="a793c5c7e230dac7b87c16200f8263db6" name="a793c5c7e230dac7b87c16200f8263db6"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a793c5c7e230dac7b87c16200f8263db6"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Get</b> (const <a class="el" href="classiceberg_1_1ConfigBase_1_1Entry.html">Entry</a>&lt; T &gt; &amp;entry) const</td></tr>
<tr class="separator:a793c5c7e230dac7b87c16200f8263db6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a464281576df4a683611d8319e578257c" id="r_a464281576df4a683611d8319e578257c"><td class="memItemLeft" align="right" valign="top"><a id="a464281576df4a683611d8319e578257c" name="a464281576df4a683611d8319e578257c"></a>
const std::unordered_map&lt; std::string, std::string &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>configs</b> () const</td></tr>
<tr class="separator:a464281576df4a683611d8319e578257c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75f09e1cd2bb55b4df854298ed678313" id="r_a75f09e1cd2bb55b4df854298ed678313"><td class="memItemLeft" align="right" valign="top"><a id="a75f09e1cd2bb55b4df854298ed678313" name="a75f09e1cd2bb55b4df854298ed678313"></a>
std::unordered_map&lt; std::string, std::string &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>mutable_configs</b> ()</td></tr>
<tr class="separator:a75f09e1cd2bb55b4df854298ed678313"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78dc1c7d65af1e096a19fc77d2c9ed39" id="r_a78dc1c7d65af1e096a19fc77d2c9ed39"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ConfigBase.html#a78dc1c7d65af1e096a19fc77d2c9ed39">Extract</a> (std::string_view prefix) const</td></tr>
<tr class="memdesc:a78dc1c7d65af1e096a19fc77d2c9ed39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts the prefix from the configuration. <br /></td></tr>
<tr class="separator:a78dc1c7d65af1e096a19fc77d2c9ed39"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a5988dbb52a6ce914c88ef10c66e5bba7" id="r_a5988dbb52a6ce914c88ef10c66e5bba7"><td class="memItemLeft" align="right" valign="top"><a id="a5988dbb52a6ce914c88ef10c66e5bba7" name="a5988dbb52a6ce914c88ef10c66e5bba7"></a>
std::unordered_map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>configs_</b></td></tr>
<tr class="separator:a5988dbb52a6ce914c88ef10c66e5bba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a78dc1c7d65af1e096a19fc77d2c9ed39" name="a78dc1c7d65af1e096a19fc77d2c9ed39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78dc1c7d65af1e096a19fc77d2c9ed39">&#9670;&#160;</a></span>Extract()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ConcreteConfig &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt; std::string, std::string &gt; <a class="el" href="classiceberg_1_1ConfigBase.html">iceberg::ConfigBase</a>&lt; ConcreteConfig &gt;::Extract </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>prefix</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the prefix from the configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">prefix</td><td>The prefix to extract. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A map of entries that match the prefix with prefix removed. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/util/<a class="el" href="config_8h_source.html">config.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>