ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/classripple_1_1KnownFormats_1_1Item.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

337 lines
21 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::KnownFormats&lt; KeyType, Derived &gt;::Item 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&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"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1KnownFormats.html">KnownFormats</a></li><li class="navelem"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html">Item</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1KnownFormats_1_1Item-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::KnownFormats&lt; KeyType, Derived &gt;::Item Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A known format.
<a href="classripple_1_1KnownFormats_1_1Item.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::KnownFormats&lt; KeyType, Derived &gt;::Item:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1KnownFormats_1_1Item__coll__graph.png" border="0" usemap="#aripple_1_1KnownFormats_3_01KeyType_00_01Derived_01_4_1_1Item_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1KnownFormats_3_01KeyType_00_01Derived_01_4_1_1Item_coll__map" id="aripple_1_1KnownFormats_3_01KeyType_00_01Derived_01_4_1_1Item_coll__map">
<area shape="rect" title="A known format." alt="" coords="226,387,429,427"/>
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="185,299,331,324"/>
<area shape="poly" title=" " alt="" coords="269,335,283,361,305,385,301,388,279,364,264,338"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="21,196,164,236"/>
<area shape="poly" title=" " alt="" coords="131,242,181,272,231,296,229,301,178,277,129,246"/>
<area shape="rect" href="classripple_1_1SOElement.html" title="An element in a SOTemplate." alt="" coords="23,108,162,133"/>
<area shape="poly" title=" " alt="" coords="95,147,95,196,90,196,90,147"/>
<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="poly" title=" " alt="" coords="95,59,95,108,90,108,90,59"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="189,203,327,229"/>
<area shape="poly" title=" " alt="" coords="261,242,261,299,255,299,255,242"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="365,299,452,324"/>
<area shape="poly" title=" " alt="" coords="393,337,369,364,347,388,344,385,365,361,389,333"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="351,196,490,236"/>
<area shape="poly" title=" " alt="" coords="419,250,413,299,408,298,414,249"/>
</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:a59624238d47579b0c3ac90135fdb72dd" id="r_a59624238d47579b0c3ac90135fdb72dd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html#a59624238d47579b0c3ac90135fdb72dd">Item</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="separator:a59624238d47579b0c3ac90135fdb72dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd86f0329e022a1d05e893efd4cfb1a1" id="r_afd86f0329e022a1d05e893efd4cfb1a1"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html#afd86f0329e022a1d05e893efd4cfb1a1">getName</a> () const</td></tr>
<tr class="memdesc:afd86f0329e022a1d05e893efd4cfb1a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the name of the format. <br /></td></tr>
<tr class="separator:afd86f0329e022a1d05e893efd4cfb1a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d2381641d180ca9879a2e4ee208818a" id="r_a3d2381641d180ca9879a2e4ee208818a"><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_1_1Item.html#a3d2381641d180ca9879a2e4ee208818a">getType</a> () const</td></tr>
<tr class="memdesc:a3d2381641d180ca9879a2e4ee208818a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the transaction type this format represents. <br /></td></tr>
<tr class="separator:a3d2381641d180ca9879a2e4ee208818a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d252bb9474bc77f99652cbee17da58b" id="r_a4d252bb9474bc77f99652cbee17da58b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SOTemplate.html">SOTemplate</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html#a4d252bb9474bc77f99652cbee17da58b">getSOTemplate</a> () const</td></tr>
<tr class="separator:a4d252bb9474bc77f99652cbee17da58b"><td class="memSeparator" colspan="2">&#160;</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:ad649c72198b624671020a5e7ad5c8baa" id="r_ad649c72198b624671020a5e7ad5c8baa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SOTemplate.html">SOTemplate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html#ad649c72198b624671020a5e7ad5c8baa">soTemplate_</a></td></tr>
<tr class="separator:ad649c72198b624671020a5e7ad5c8baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdc269f8697c0a46bf574eafe59e525e" id="r_afdc269f8697c0a46bf574eafe59e525e"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html#afdc269f8697c0a46bf574eafe59e525e">name_</a></td></tr>
<tr class="separator:afdc269f8697c0a46bf574eafe59e525e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cabd1134ba935f031f1336360ddd19a" id="r_a0cabd1134ba935f031f1336360ddd19a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html#a0cabd1134ba935f031f1336360ddd19a">type_</a></td></tr>
<tr class="separator:a0cabd1134ba935f031f1336360ddd19a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>, class Derived&gt;<br />
class ripple::KnownFormats&lt; KeyType, Derived &gt;::Item</div><p>A known format. </p>
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00047">47</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="a59624238d47579b0c3ac90135fdb72dd" name="a59624238d47579b0c3ac90135fdb72dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59624238d47579b0c3ac90135fdb72dd">&#9670;&#160;</a></span>Item()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> , class Derived &gt; </div>
<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>, Derived &gt;::Item::Item </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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00050">50</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afd86f0329e022a1d05e893efd4cfb1a1" name="afd86f0329e022a1d05e893efd4cfb1a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd86f0329e022a1d05e893efd4cfb1a1">&#9670;&#160;</a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> , class Derived &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp; <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>, Derived &gt;::Item::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the name of the format. </p>
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00067">67</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="a3d2381641d180ca9879a2e4ee208818a" name="a3d2381641d180ca9879a2e4ee208818a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d2381641d180ca9879a2e4ee208818a">&#9670;&#160;</a></span>getType()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> , class Derived &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>, Derived &gt;::Item::getType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the transaction type this format represents. </p>
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00075">75</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="a4d252bb9474bc77f99652cbee17da58b" name="a4d252bb9474bc77f99652cbee17da58b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d252bb9474bc77f99652cbee17da58b">&#9670;&#160;</a></span>getSOTemplate()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> , class Derived &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SOTemplate.html">SOTemplate</a> const &amp; <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>, Derived &gt;::Item::getSOTemplate </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="KnownFormats_8h_source.html#l00081">81</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="ad649c72198b624671020a5e7ad5c8baa" name="ad649c72198b624671020a5e7ad5c8baa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad649c72198b624671020a5e7ad5c8baa">&#9670;&#160;</a></span>soTemplate_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> , class Derived &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SOTemplate.html">SOTemplate</a> <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>, Derived &gt;::Item::soTemplate_</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#l00087">87</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="afdc269f8697c0a46bf574eafe59e525e" name="afdc269f8697c0a46bf574eafe59e525e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdc269f8697c0a46bf574eafe59e525e">&#9670;&#160;</a></span>name_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> , class Derived &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/string/basic_string.html">std::string</a> const <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>, Derived &gt;::Item::name_</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#l00088">88</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="a0cabd1134ba935f031f1336360ddd19a" name="a0cabd1134ba935f031f1336360ddd19a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cabd1134ba935f031f1336360ddd19a">&#9670;&#160;</a></span>type_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> , class Derived &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> const <a class="el" href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a>&lt; <a class="el" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a>, Derived &gt;::Item::type_</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#l00089">89</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="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>
Reference in New Issue View Git Blame Copy Permalink