ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4ad595bf180bbc8de37e3e4918f5d3183e8aae8c
rippled/classripple_1_1KnownFormats.html
nbougalis 4ad595bf18 deploy: 020b285808
2020-04-15 21:15:02 +00:00

513 lines
30 KiB
HTML
Raw Blame History

<!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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::KnownFormats&lt; KeyType &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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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_1KnownFormats.html">KnownFormats</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-methods">Protected Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1KnownFormats-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::KnownFormats&lt; KeyType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Manages a list of known formats.
<a href="classripple_1_1KnownFormats.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::KnownFormats&lt; KeyType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1KnownFormats__coll__graph.png" border="0" usemap="#ripple_1_1KnownFormats_3_01KeyType_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1KnownFormats_3_01KeyType_01_4_coll__map" id="ripple_1_1KnownFormats_3_01KeyType_01_4_coll__map">
<area shape="rect" title="Manages a list of known formats." alt="" coords="107,615,271,656"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/forward_list.html" title=" " alt="" coords="105,496,273,552"/>
<area shape="rect" href="classripple_1_1KnownFormats_1_1Item.html" title="A known format." alt="" coords="107,392,271,433"/>
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="46,303,191,329"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="5,206,144,233"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="169,199,311,240"/>
<area shape="rect" href="classripple_1_1SOElement.html" title="An element in a SOTemplate." alt="" coords="171,109,309,136"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/functional/reference_wrapper.html" title=" " alt="" coords="153,5,327,47"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="215,303,302,329"/>
</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 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="classripple_1_1KnownFormats_1_1Item.html">Item</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A known format. <a href="classripple_1_1KnownFormats_1_1Item.html#details">More...</a><br /></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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a61870a3c657db7800ccf911166294a48"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a61870a3c657db7800ccf911166294a48">KnownFormats</a> ()=default</td></tr>
<tr class="memdesc:a61870a3c657db7800ccf911166294a48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the known formats object. <a href="classripple_1_1KnownFormats.html#a61870a3c657db7800ccf911166294a48">More...</a><br /></td></tr>
<tr class="separator:a61870a3c657db7800ccf911166294a48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69662755c4d487308e7a4a79811349e3"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a69662755c4d487308e7a4a79811349e3">~KnownFormats</a> ()=default</td></tr>
<tr class="memdesc:a69662755c4d487308e7a4a79811349e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy the known formats object. <a href="classripple_1_1KnownFormats.html#a69662755c4d487308e7a4a79811349e3">More...</a><br /></td></tr>
<tr class="separator:a69662755c4d487308e7a4a79811349e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dd9fb6ab3d01e7421970727cac4e2d5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a9dd9fb6ab3d01e7421970727cac4e2d5">KnownFormats</a> (<a class="el" href="classripple_1_1KnownFormats.html">KnownFormats</a> const &amp;)=delete</td></tr>
<tr class="separator:a9dd9fb6ab3d01e7421970727cac4e2d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc7de39aaa3558f967a3ece1bda382a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1KnownFormats.html">KnownFormats</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#acc7de39aaa3558f967a3ece1bda382a0">operator=</a> (<a class="el" href="classripple_1_1KnownFormats.html">KnownFormats</a> const &amp;)=delete</td></tr>
<tr class="separator:acc7de39aaa3558f967a3ece1bda382a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4acde7284e1f5aaa5489e12adca82deb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a4acde7284e1f5aaa5489e12adca82deb">findTypeByName</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;name) const</td></tr>
<tr class="memdesc:a4acde7284e1f5aaa5489e12adca82deb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the type for a format specified by name. <a href="classripple_1_1KnownFormats.html#a4acde7284e1f5aaa5489e12adca82deb">More...</a><br /></td></tr>
<tr class="separator:a4acde7284e1f5aaa5489e12adca82deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3a38712296e0e75e394baaa8a1b3211"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#ab3a38712296e0e75e394baaa8a1b3211">findByType</a> (<a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> type) const</td></tr>
<tr class="memdesc:ab3a38712296e0e75e394baaa8a1b3211"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a format based on its type. <a href="classripple_1_1KnownFormats.html#ab3a38712296e0e75e394baaa8a1b3211">More...</a><br /></td></tr>
<tr class="separator:ab3a38712296e0e75e394baaa8a1b3211"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a30bdc49492ab65e9fb73306d16e593f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a30bdc49492ab65e9fb73306d16e593f1">findByName</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;name) const</td></tr>
<tr class="memdesc:a30bdc49492ab65e9fb73306d16e593f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a format based on its name. <a href="classripple_1_1KnownFormats.html#a30bdc49492ab65e9fb73306d16e593f1">More...</a><br /></td></tr>
<tr class="separator:a30bdc49492ab65e9fb73306d16e593f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a4136f7e69948157f5e2bdf5aa6cb60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a6a4136f7e69948157f5e2bdf5aa6cb60">add</a> (char const *name, <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> type, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a>&lt; <a class="el" href="classripple_1_1SOElement.html">SOElement</a> &gt; uniqueFields, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a>&lt; <a class="el" href="classripple_1_1SOElement.html">SOElement</a> &gt; commonFields={})</td></tr>
<tr class="memdesc:a6a4136f7e69948157f5e2bdf5aa6cb60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new format. <a href="classripple_1_1KnownFormats.html#a6a4136f7e69948157f5e2bdf5aa6cb60">More...</a><br /></td></tr>
<tr class="separator:a6a4136f7e69948157f5e2bdf5aa6cb60"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a534d1a44ed43326b856f8ffe357a33d3"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/forward_list.html">std::forward_list</a>&lt; <a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a534d1a44ed43326b856f8ffe357a33d3">formats_</a></td></tr>
<tr class="separator:a534d1a44ed43326b856f8ffe357a33d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1d7ab9877aec91f1765922566d9b477"><td class="memItemLeft" align="right" valign="top">boost::container::flat_map&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, <a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> const * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#af1d7ab9877aec91f1765922566d9b477">names_</a></td></tr>
<tr class="separator:af1d7ab9877aec91f1765922566d9b477"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa292c93d9151dfcf55c963c30afa132d"><td class="memItemLeft" align="right" valign="top">boost::container::flat_map&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>, <a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> const * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#aa292c93d9151dfcf55c963c30afa132d">types_</a></td></tr>
<tr class="separator:aa292c93d9151dfcf55c963c30afa132d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class KeyType&gt;<br />
class ripple::KnownFormats&lt; KeyType &gt;</h3>
<p>Manages a list of known formats. </p>
<p>Each format has a name, an associated KeyType (typically an enumeration), and a predefined <a class="el" href="classripple_1_1SOElement.html">SOElement</a>.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">KeyType</td><td>The type of key identifying the format. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00039">39</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a61870a3c657db7800ccf911166294a48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61870a3c657db7800ccf911166294a48">&#9670;&nbsp;</a></span>KnownFormats() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::<a class="el" href="classripple_1_1KnownFormats.html">KnownFormats</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create the known formats object. </p>
<p>Derived classes will load the object with all the known formats. </p>
</div>
</div>
<a id="a69662755c4d487308e7a4a79811349e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69662755c4d487308e7a4a79811349e3">&#9670;&nbsp;</a></span>~KnownFormats()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::~<a class="el" href="classripple_1_1KnownFormats.html">KnownFormats</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the known formats object. </p>
<p>The defined formats are deleted. </p>
</div>
</div>
<a id="a9dd9fb6ab3d01e7421970727cac4e2d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9dd9fb6ab3d01e7421970727cac4e2d5">&#9670;&nbsp;</a></span>KnownFormats() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::<a class="el" href="classripple_1_1KnownFormats.html">KnownFormats</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1KnownFormats.html">KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt; const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acc7de39aaa3558f967a3ece1bda382a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc7de39aaa3558f967a3ece1bda382a0">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1KnownFormats.html">KnownFormats</a>&amp; <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1KnownFormats.html">KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt; const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4acde7284e1f5aaa5489e12adca82deb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4acde7284e1f5aaa5489e12adca82deb">&#9670;&nbsp;</a></span>findTypeByName()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::findTypeByName </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the type for a format specified by name. </p>
<p>If the format name is unknown, an exception is thrown.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The type. </dd></dl>
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00108">108</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="ab3a38712296e0e75e394baaa8a1b3211"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3a38712296e0e75e394baaa8a1b3211">&#9670;&nbsp;</a></span>findByType()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> const* <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::findByType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a format based on its type. </p>
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00120">120</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="a30bdc49492ab65e9fb73306d16e593f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30bdc49492ab65e9fb73306d16e593f1">&#9670;&nbsp;</a></span>findByName()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> const* <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::findByName </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</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>Retrieve a format based on its name. </p>
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00131">131</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="a6a4136f7e69948157f5e2bdf5aa6cb60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a4136f7e69948157f5e2bdf5aa6cb60">&#9670;&nbsp;</a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> const&amp; <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::add </td>
<td>(</td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a>&lt; <a class="el" href="classripple_1_1SOElement.html">SOElement</a> &gt;&#160;</td>
<td class="paramname"><em>uniqueFields</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a>&lt; <a class="el" href="classripple_1_1SOElement.html">SOElement</a> &gt;&#160;</td>
<td class="paramname"><em>commonFields</em> = <code>{}</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Add a new format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of this format. </td></tr>
<tr><td class="paramname">type</td><td>The type of this format. </td></tr>
<tr><td class="paramname">uniqueFields</td><td>An <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a> of unique fields </td></tr>
<tr><td class="paramname">commonFields</td><td>An <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a> of common fields</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The created format. </dd></dl>
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00148">148</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a534d1a44ed43326b856f8ffe357a33d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a534d1a44ed43326b856f8ffe357a33d3">&#9670;&nbsp;</a></span>formats_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<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/forward_list.html">std::forward_list</a>&lt;<a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a>&gt; <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::formats_</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="KnownFormats_8h_source.html#l00165">165</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="af1d7ab9877aec91f1765922566d9b477"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1d7ab9877aec91f1765922566d9b477">&#9670;&nbsp;</a></span>names_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::container::flat_map&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, <a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> const*&gt; <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::names_</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="KnownFormats_8h_source.html#l00167">167</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="aa292c93d9151dfcf55c963c30afa132d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa292c93d9151dfcf55c963c30afa132d">&#9670;&nbsp;</a></span>types_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::container::flat_map&lt;<a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>, <a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a> const*&gt; <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> &gt;::types_</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="KnownFormats_8h_source.html#l00168">168</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink