mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-25 05:25:55 +00:00
566 lines
32 KiB
HTML
566 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.5"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::InnerObjectFormats 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.5 -->
|
|
<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_1InnerObjectFormats.html">InnerObjectFormats</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classripple_1_1InnerObjectFormats-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::InnerObjectFormats Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Manages the list of known inner object formats.
|
|
<a href="classripple_1_1InnerObjectFormats.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="InnerObjectFormats_8h_source.html">InnerObjectFormats.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::InnerObjectFormats:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1InnerObjectFormats__inherit__graph.png" border="0" usemap="#aripple_1_1InnerObjectFormats_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aripple_1_1InnerObjectFormats_inherit__map" id="aripple_1_1InnerObjectFormats_inherit__map">
|
|
<area shape="rect" title="Manages the list of known inner object formats." alt="" coords="11,93,205,119"/>
|
|
<area shape="rect" href="classripple_1_1KnownFormats.html" title=" " alt="" coords="5,5,211,45"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::InnerObjectFormats:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1InnerObjectFormats__coll__graph.png" border="0" usemap="#aripple_1_1InnerObjectFormats_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1InnerObjectFormats_coll__map" id="aripple_1_1InnerObjectFormats_coll__map">
|
|
<area shape="rect" title="Manages the list of known inner object formats." alt="" coords="282,696,477,721"/>
|
|
<area shape="rect" href="classripple_1_1KnownFormats.html" title=" " alt="" coords="277,607,482,647"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="389,299,476,324"/>
|
|
<area shape="rect" href="classripple_1_1KnownFormats_1_1Item.html" title="A known format." alt="" coords="199,387,402,427"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="363,196,502,236"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/forward_list.html" title=" " alt="" coords="230,489,398,544"/>
|
|
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="180,299,325,324"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="21,196,164,236"/>
|
|
<area shape="rect" href="classripple_1_1SOElement.html" title="An element in a SOTemplate." alt="" coords="23,108,162,133"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/functional/reference_wrapper.html" title=" " alt="" coords="5,5,180,45"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="189,203,327,229"/>
|
|
</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:a5d946acc2637ba9031007888980c3764"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SOTemplate.html">SOTemplate</a> const * </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InnerObjectFormats.html#a5d946acc2637ba9031007888980c3764">findSOTemplateBySField</a> (<a class="el" href="classripple_1_1SField.html">SField</a> const &sField) const</td></tr>
|
|
<tr class="separator:a5d946acc2637ba9031007888980c3764"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada9068218e1faea42c017e3e405243bf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#ada9068218e1faea42c017e3e405243bf">findTypeByName</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:ada9068218e1faea42c017e3e405243bf"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the type for a format specified by name. <a href="classripple_1_1KnownFormats.html#ada9068218e1faea42c017e3e405243bf">More...</a><br /></td></tr>
|
|
<tr class="separator:ada9068218e1faea42c017e3e405243bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02015efe39bd31cec110f748e50ec523"><td class="memItemLeft" align="right" valign="top">Item const * </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a02015efe39bd31cec110f748e50ec523">findByType</a> (int type) const</td></tr>
|
|
<tr class="memdesc:a02015efe39bd31cec110f748e50ec523"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a format based on its type. <a href="classripple_1_1KnownFormats.html#a02015efe39bd31cec110f748e50ec523">More...</a><br /></td></tr>
|
|
<tr class="separator:a02015efe39bd31cec110f748e50ec523"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f70e9a819b7a9e9e7429efb7b0b6279"><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>< Item ><a class="el" href="namespaceripple.html#aa2ccf44248af5be8a81db7091ad4d019">::const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a6f70e9a819b7a9e9e7429efb7b0b6279">begin</a> () const</td></tr>
|
|
<tr class="separator:a6f70e9a819b7a9e9e7429efb7b0b6279"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a5c9130b299ca5927f49e225ef1adcc"><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>< Item ><a class="el" href="namespaceripple.html#aa2ccf44248af5be8a81db7091ad4d019">::const_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a3a5c9130b299ca5927f49e225ef1adcc">end</a> () const</td></tr>
|
|
<tr class="separator:a3a5c9130b299ca5927f49e225ef1adcc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ac8a2a46e333d5db2ecaff032e3eacc2f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InnerObjectFormats.html#ac8a2a46e333d5db2ecaff032e3eacc2f">getInstance</a> ()</td></tr>
|
|
<tr class="separator:ac8a2a46e333d5db2ecaff032e3eacc2f"><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:a065668030ec80fe02abf8d0ddf249a9d"><td class="memItemLeft" align="right" valign="top">Item const * </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#a065668030ec80fe02abf8d0ddf249a9d">findByName</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:a065668030ec80fe02abf8d0ddf249a9d"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a format based on its name. <a href="classripple_1_1KnownFormats.html#a065668030ec80fe02abf8d0ddf249a9d">More...</a><br /></td></tr>
|
|
<tr class="separator:a065668030ec80fe02abf8d0ddf249a9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd5dcc92c71f2d6ff04cffbd666acadf"><td class="memItemLeft" align="right" valign="top">Item const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#afd5dcc92c71f2d6ff04cffbd666acadf">add</a> (char const *name, int type, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a>< <a class="el" href="classripple_1_1SOElement.html">SOElement</a> > uniqueFields, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</a>< <a class="el" href="classripple_1_1SOElement.html">SOElement</a> > commonFields={})</td></tr>
|
|
<tr class="memdesc:afd5dcc92c71f2d6ff04cffbd666acadf"><td class="mdescLeft"> </td><td class="mdescRight">Add a new format. <a href="classripple_1_1KnownFormats.html#afd5dcc92c71f2d6ff04cffbd666acadf">More...</a><br /></td></tr>
|
|
<tr class="separator:afd5dcc92c71f2d6ff04cffbd666acadf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a266521cb88032dda52a171334123a7b1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1InnerObjectFormats.html#a266521cb88032dda52a171334123a7b1">InnerObjectFormats</a> ()</td></tr>
|
|
<tr class="memdesc:a266521cb88032dda52a171334123a7b1"><td class="mdescLeft"> </td><td class="mdescRight">Create the object. <a href="classripple_1_1InnerObjectFormats.html#a266521cb88032dda52a171334123a7b1">More...</a><br /></td></tr>
|
|
<tr class="separator:a266521cb88032dda52a171334123a7b1"><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:a14d410347c0fb394583c85623b9e4db6"><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_1KnownFormats.html#a14d410347c0fb394583c85623b9e4db6">name_</a></td></tr>
|
|
<tr class="separator:a14d410347c0fb394583c85623b9e4db6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa4cce4b8fc4934a93a6482621885232"><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>< Item > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#aaa4cce4b8fc4934a93a6482621885232">formats_</a></td></tr>
|
|
<tr class="separator:aaa4cce4b8fc4934a93a6482621885232"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9e4bba4155bc0404a583b9a04b4193b"><td class="memItemLeft" align="right" valign="top">boost::container::flat_map< <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, Item const * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#ab9e4bba4155bc0404a583b9a04b4193b">names_</a></td></tr>
|
|
<tr class="separator:ab9e4bba4155bc0404a583b9a04b4193b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8af5a92ed877ac672e2c4cff1949141"><td class="memItemLeft" align="right" valign="top">boost::container::flat_map< int, Item const * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats.html#ad8af5a92ed877ac672e2c4cff1949141">types_</a></td></tr>
|
|
<tr class="separator:ad8af5a92ed877ac672e2c4cff1949141"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >Manages the list of known inner object formats. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="InnerObjectFormats_8h_source.html#l00029">29</a> of file <a class="el" href="InnerObjectFormats_8h_source.html">InnerObjectFormats.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a266521cb88032dda52a171334123a7b1" name="a266521cb88032dda52a171334123a7b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a266521cb88032dda52a171334123a7b1">◆ </a></span>InnerObjectFormats()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::InnerObjectFormats::InnerObjectFormats </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></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>Create the object. </p>
|
|
<p >This will load the object with all the known inner object formats. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="InnerObjectFormats_8cpp_source.html#l00026">26</a> of file <a class="el" href="InnerObjectFormats_8cpp_source.html">InnerObjectFormats.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ac8a2a46e333d5db2ecaff032e3eacc2f" name="ac8a2a46e333d5db2ecaff032e3eacc2f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac8a2a46e333d5db2ecaff032e3eacc2f">◆ </a></span>getInstance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> const & ripple::InnerObjectFormats::getInstance </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="InnerObjectFormats_8cpp_source.html#l00178">178</a> of file <a class="el" href="InnerObjectFormats_8cpp_source.html">InnerObjectFormats.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5d946acc2637ba9031007888980c3764" name="a5d946acc2637ba9031007888980c3764"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d946acc2637ba9031007888980c3764">◆ </a></span>findSOTemplateBySField()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1SOTemplate.html">SOTemplate</a> const * ripple::InnerObjectFormats::findSOTemplateBySField </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1SField.html">SField</a> const & </td>
|
|
<td class="paramname"><em>sField</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="InnerObjectFormats_8cpp_source.html#l00185">185</a> of file <a class="el" href="InnerObjectFormats_8cpp_source.html">InnerObjectFormats.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ada9068218e1faea42c017e3e405243bf" name="ada9068218e1faea42c017e3e405243bf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada9068218e1faea42c017e3e405243bf">◆ </a></span>findTypeByName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>< int , <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> >::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 & </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">inherited</span></span> </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#l00117">117</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a02015efe39bd31cec110f748e50ec523" name="a02015efe39bd31cec110f748e50ec523"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a02015efe39bd31cec110f748e50ec523">◆ </a></span>findByType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Item const * <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>< int , <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> >::findByType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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#l00129">129</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f70e9a819b7a9e9e7429efb7b0b6279" name="a6f70e9a819b7a9e9e7429efb7b0b6279"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f70e9a819b7a9e9e7429efb7b0b6279">◆ </a></span>begin()</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/forward_list.html">std::forward_list</a>< Item ><a class="el" href="namespaceripple.html#aa2ccf44248af5be8a81db7091ad4d019">::const_iterator</a> <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>< int , <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> >::begin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00139">139</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3a5c9130b299ca5927f49e225ef1adcc" name="a3a5c9130b299ca5927f49e225ef1adcc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3a5c9130b299ca5927f49e225ef1adcc">◆ </a></span>end()</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/forward_list.html">std::forward_list</a>< Item ><a class="el" href="namespaceripple.html#aa2ccf44248af5be8a81db7091ad4d019">::const_iterator</a> <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>< int , <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> >::end </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00145">145</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a065668030ec80fe02abf8d0ddf249a9d" name="a065668030ec80fe02abf8d0ddf249a9d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a065668030ec80fe02abf8d0ddf249a9d">◆ </a></span>findByName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Item const * <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>< int , <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> >::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 & </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 class="mlabel">inherited</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#l00154">154</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afd5dcc92c71f2d6ff04cffbd666acadf" name="afd5dcc92c71f2d6ff04cffbd666acadf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afd5dcc92c71f2d6ff04cffbd666acadf">◆ </a></span>add()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Item const & <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>< int , <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> >::add </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char const * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </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>< <a class="el" href="classripple_1_1SOElement.html">SOElement</a> > </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>< <a class="el" href="classripple_1_1SOElement.html">SOElement</a> > </td>
|
|
<td class="paramname"><em>commonFields</em> = <code>{}</code> </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 class="mlabel">inherited</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#l00172">172</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="a14d410347c0fb394583c85623b9e4db6" name="a14d410347c0fb394583c85623b9e4db6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a14d410347c0fb394583c85623b9e4db6">◆ </a></span>name_</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/string/basic_string.html">std::string</a> <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>< int , <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> >::name_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00194">194</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaa4cce4b8fc4934a93a6482621885232" name="aaa4cce4b8fc4934a93a6482621885232"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa4cce4b8fc4934a93a6482621885232">◆ </a></span>formats_</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/forward_list.html">std::forward_list</a><Item> <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>< int , <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> >::formats_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00199">199</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab9e4bba4155bc0404a583b9a04b4193b" name="ab9e4bba4155bc0404a583b9a04b4193b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9e4bba4155bc0404a583b9a04b4193b">◆ </a></span>names_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">boost::container::flat_map<<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>, Item const*> <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>< int , <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> >::names_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00201">201</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad8af5a92ed877ac672e2c4cff1949141" name="ad8af5a92ed877ac672e2c4cff1949141"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad8af5a92ed877ac672e2c4cff1949141">◆ </a></span>types_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">boost::container::flat_map<int , Item const*> <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>< int , <a class="el" href="classripple_1_1InnerObjectFormats.html">InnerObjectFormats</a> >::types_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00202">202</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 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|