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
f42ca4239534b42d7f4542459b491656b71e9c6c
rippled/classripple_1_1KnownFormats_1_1Item.html
nbougalis 062c9e2641 deploy: 8a25f32824
2021-09-14 16:34:03 +00:00

324 lines
18 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, 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 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><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>
<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="#ripple_1_1KnownFormats_3_01KeyType_00_01Derived_01_4_1_1Item_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1KnownFormats_3_01KeyType_00_01Derived_01_4_1_1Item_coll__map" id="ripple_1_1KnownFormats_3_01KeyType_00_01Derived_01_4_1_1Item_coll__map">
<area shape="rect" title="A known format." alt="" coords="88,392,291,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="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem: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:a2d96a7bad63dc11b0289669873c033a7"><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#a2d96a7bad63dc11b0289669873c033a7">getName</a> () const</td></tr>
<tr class="memdesc:a2d96a7bad63dc11b0289669873c033a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the name of the format. <a href="classripple_1_1KnownFormats_1_1Item.html#a2d96a7bad63dc11b0289669873c033a7">More...</a><br /></td></tr>
<tr class="separator:a2d96a7bad63dc11b0289669873c033a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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. <a href="classripple_1_1KnownFormats_1_1Item.html#a3d2381641d180ca9879a2e4ee208818a">More...</a><br /></td></tr>
<tr class="separator:a3d2381641d180ca9879a2e4ee208818a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a330b2a9b371d72bf7c6b7d351107a432"><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#a330b2a9b371d72bf7c6b7d351107a432">getSOTemplate</a> () const</td></tr>
<tr class="separator:a330b2a9b371d72bf7c6b7d351107a432"><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: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:ae9ff69c1aed9993b6f37af069aee15a4"><td class="memItemLeft" align="right" valign="top">const <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1KnownFormats_1_1Item.html#ae9ff69c1aed9993b6f37af069aee15a4">name_</a></td></tr>
<tr class="separator:ae9ff69c1aed9993b6f37af069aee15a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefb958f0055e62d6bf192ab478a67bfa"><td class="memItemLeft" align="right" valign="top">const <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#aefb958f0055e62d6bf192ab478a67bfa">type_</a></td></tr>
<tr class="separator:aefb958f0055e62d6bf192ab478a67bfa"><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, class Derived&gt;<br />
class ripple::KnownFormats&lt; KeyType, Derived &gt;::Item</h3>
<p>A known format. </p>
<p class="definition">Definition at line <a class="el" href="KnownFormats_8h_source.html#l00045">45</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59624238d47579b0c3ac90135fdb72dd">&#9670;&nbsp;</a></span>Item()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType , 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#l00048">48</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="a2d96a7bad63dc11b0289669873c033a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d96a7bad63dc11b0289669873c033a7">&#9670;&nbsp;</a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType , 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#l00065">65</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="a3d2381641d180ca9879a2e4ee208818a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d2381641d180ca9879a2e4ee208818a">&#9670;&nbsp;</a></span>getType()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType , 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#l00073">73</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="a330b2a9b371d72bf7c6b7d351107a432"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a330b2a9b371d72bf7c6b7d351107a432">&#9670;&nbsp;</a></span>getSOTemplate()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType , 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#l00079">79</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad649c72198b624671020a5e7ad5c8baa">&#9670;&nbsp;</a></span>soTemplate_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType , 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#l00085">85</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="ae9ff69c1aed9993b6f37af069aee15a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9ff69c1aed9993b6f37af069aee15a4">&#9670;&nbsp;</a></span>name_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType , class Derived &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <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>&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#l00086">86</a> of file <a class="el" href="KnownFormats_8h_source.html">KnownFormats.h</a>.</p>
</div>
</div>
<a id="aefb958f0055e62d6bf192ab478a67bfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefb958f0055e62d6bf192ab478a67bfa">&#9670;&nbsp;</a></span>type_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class KeyType , class Derived &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <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::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#l00087">87</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