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
gh-pages
rippled/classripple_1_1SOElement.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

369 lines
21 KiB
HTML
Raw Permalink 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::SOElement 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_1SOElement.html">SOElement</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1SOElement-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::SOElement Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>An element in a <a class="el" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject.">SOTemplate</a>.
<a href="classripple_1_1SOElement.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="SOTemplate_8h_source.html">SOTemplate.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::SOElement:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1SOElement__coll__graph.png" border="0" usemap="#aripple_1_1SOElement_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1SOElement_coll__map" id="aripple_1_1SOElement_coll__map">
<area shape="rect" 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="poly" title=" " alt="" coords="95,59,95,108,90,108,90,59"/>
</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:ad19eb5976f63845d0a12433a6d7be11c" id="r_ad19eb5976f63845d0a12433a6d7be11c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SOElement.html#ad19eb5976f63845d0a12433a6d7be11c">SOElement</a> (<a class="el" href="classripple_1_1SField.html">SField</a> const &amp;fieldName, <a class="el" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042">SOEStyle</a> <a class="el" href="classripple_1_1SOElement.html#ad60594cde407fdca3319db93a129afa1">style</a>)</td></tr>
<tr class="separator:ad19eb5976f63845d0a12433a6d7be11c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f142926de72d4adec895a0109831d3e" id="r_a8f142926de72d4adec895a0109831d3e"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; <br />
requires (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a>&lt;T, <a class="el" href="classripple_1_1STAmount.html">STAmount</a>&gt; || <a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a>&lt;T, <a class="el" href="classripple_1_1STIssue.html">STIssue</a>&gt;)</td></tr>
<tr class="memitem:a8f142926de72d4adec895a0109831d3e"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1SOElement.html#a8f142926de72d4adec895a0109831d3e">SOElement</a> (<a class="el" href="structripple_1_1TypedField.html">TypedField</a>&lt; T &gt; const &amp;fieldName, <a class="el" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042">SOEStyle</a> <a class="el" href="classripple_1_1SOElement.html#ad60594cde407fdca3319db93a129afa1">style</a>, <a class="el" href="namespaceripple.html#abd329a8849fd0c4cb884992c5963523d">SOETxMPTIssue</a> supportMpt=<a class="el" href="namespaceripple.html#abd329a8849fd0c4cb884992c5963523dae2050423628dda0de67fea879e2368a7">soeMPTNotSupported</a>)</td></tr>
<tr class="separator:a8f142926de72d4adec895a0109831d3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bce76b353732ed3be37084abbd4413d" id="r_a8bce76b353732ed3be37084abbd4413d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SField.html">SField</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SOElement.html#a8bce76b353732ed3be37084abbd4413d">sField</a> () const</td></tr>
<tr class="separator:a8bce76b353732ed3be37084abbd4413d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad60594cde407fdca3319db93a129afa1" id="r_ad60594cde407fdca3319db93a129afa1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042">SOEStyle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SOElement.html#ad60594cde407fdca3319db93a129afa1">style</a> () const</td></tr>
<tr class="separator:ad60594cde407fdca3319db93a129afa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4ad3868b616a576bb3fbf3410d6b12f" id="r_ab4ad3868b616a576bb3fbf3410d6b12f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#abd329a8849fd0c4cb884992c5963523d">SOETxMPTIssue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SOElement.html#ab4ad3868b616a576bb3fbf3410d6b12f">supportMPT</a> () const</td></tr>
<tr class="separator:ab4ad3868b616a576bb3fbf3410d6b12f"><td class="memSeparator" colspan="2">&#160;</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:a8b18170529972123d230eeb93babe1c8" id="r_a8b18170529972123d230eeb93babe1c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SOElement.html#a8b18170529972123d230eeb93babe1c8">init</a> (<a class="el" href="classripple_1_1SField.html">SField</a> const &amp;fieldName) const</td></tr>
<tr class="separator:a8b18170529972123d230eeb93babe1c8"><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:a05dae7e22963eedb87b8f512f60b4478" id="r_a05dae7e22963eedb87b8f512f60b4478"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/reference_wrapper.html">std::reference_wrapper</a>&lt; <a class="el" href="classripple_1_1SField.html">SField</a> const &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SOElement.html#a05dae7e22963eedb87b8f512f60b4478">sField_</a></td></tr>
<tr class="separator:a05dae7e22963eedb87b8f512f60b4478"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a094af02f701ea80b89bf7c2f401c2f82" id="r_a094af02f701ea80b89bf7c2f401c2f82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042">SOEStyle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SOElement.html#a094af02f701ea80b89bf7c2f401c2f82">style_</a></td></tr>
<tr class="separator:a094af02f701ea80b89bf7c2f401c2f82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14c2b1d0c1202824a237f08fa256fec6" id="r_a14c2b1d0c1202824a237f08fa256fec6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#abd329a8849fd0c4cb884992c5963523d">SOETxMPTIssue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1SOElement.html#a14c2b1d0c1202824a237f08fa256fec6">supportMpt_</a> = <a class="el" href="namespaceripple.html#abd329a8849fd0c4cb884992c5963523da29a7e1961373724abdb178392cb5fe68">soeMPTNone</a></td></tr>
<tr class="separator:a14c2b1d0c1202824a237f08fa256fec6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An element in a <a class="el" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject.">SOTemplate</a>. </p>
<p class="definition">Definition at line <a class="el" href="SOTemplate_8h_source.html#l00029">29</a> of file <a class="el" href="SOTemplate_8h_source.html">SOTemplate.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad19eb5976f63845d0a12433a6d7be11c" name="ad19eb5976f63845d0a12433a6d7be11c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad19eb5976f63845d0a12433a6d7be11c">&#9670;&#160;</a></span>SOElement() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::SOElement::SOElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1SField.html">SField</a> const &amp;&#160;</td>
<td class="paramname"><em>fieldName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042">SOEStyle</a>&#160;</td>
<td class="paramname"><em>style</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="SOTemplate_8h_source.html#l00051">51</a> of file <a class="el" href="SOTemplate_8h_source.html">SOTemplate.h</a>.</p>
</div>
</div>
<a id="a8f142926de72d4adec895a0109831d3e" name="a8f142926de72d4adec895a0109831d3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f142926de72d4adec895a0109831d3e">&#9670;&#160;</a></span>SOElement() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; <br />
requires (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a>&lt;T, <a class="el" href="classripple_1_1STAmount.html">STAmount</a>&gt; || <a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a>&lt;T, <a class="el" href="classripple_1_1STIssue.html">STIssue</a>&gt;)</div>
<table class="memname">
<tr>
<td class="memname">ripple::SOElement::SOElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1TypedField.html">TypedField</a>&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>fieldName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042">SOEStyle</a>&#160;</td>
<td class="paramname"><em>style</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#abd329a8849fd0c4cb884992c5963523d">SOETxMPTIssue</a>&#160;</td>
<td class="paramname"><em>supportMpt</em> = <code><a class="el" href="namespaceripple.html#abd329a8849fd0c4cb884992c5963523dae2050423628dda0de67fea879e2368a7">soeMPTNotSupported</a></code>&#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="SOTemplate_8h_source.html#l00059">59</a> of file <a class="el" href="SOTemplate_8h_source.html">SOTemplate.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8b18170529972123d230eeb93babe1c8" name="a8b18170529972123d230eeb93babe1c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b18170529972123d230eeb93babe1c8">&#9670;&#160;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::SOElement::init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1SField.html">SField</a> const &amp;&#160;</td>
<td class="paramname"><em>fieldName</em></td><td>)</td>
<td> const</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="SOTemplate_8h_source.html#l00038">38</a> of file <a class="el" href="SOTemplate_8h_source.html">SOTemplate.h</a>.</p>
</div>
</div>
<a id="a8bce76b353732ed3be37084abbd4413d" name="a8bce76b353732ed3be37084abbd4413d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bce76b353732ed3be37084abbd4413d">&#9670;&#160;</a></span>sField()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SField.html">SField</a> const &amp; ripple::SOElement::sField </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="SOTemplate_8h_source.html#l00069">69</a> of file <a class="el" href="SOTemplate_8h_source.html">SOTemplate.h</a>.</p>
</div>
</div>
<a id="ad60594cde407fdca3319db93a129afa1" name="ad60594cde407fdca3319db93a129afa1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad60594cde407fdca3319db93a129afa1">&#9670;&#160;</a></span>style()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042">SOEStyle</a> ripple::SOElement::style </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="SOTemplate_8h_source.html#l00075">75</a> of file <a class="el" href="SOTemplate_8h_source.html">SOTemplate.h</a>.</p>
</div>
</div>
<a id="ab4ad3868b616a576bb3fbf3410d6b12f" name="ab4ad3868b616a576bb3fbf3410d6b12f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4ad3868b616a576bb3fbf3410d6b12f">&#9670;&#160;</a></span>supportMPT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#abd329a8849fd0c4cb884992c5963523d">SOETxMPTIssue</a> ripple::SOElement::supportMPT </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="SOTemplate_8h_source.html#l00081">81</a> of file <a class="el" href="SOTemplate_8h_source.html">SOTemplate.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a05dae7e22963eedb87b8f512f60b4478" name="a05dae7e22963eedb87b8f512f60b4478"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05dae7e22963eedb87b8f512f60b4478">&#9670;&#160;</a></span>sField_</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/utility/functional/reference_wrapper.html">std::reference_wrapper</a>&lt;<a class="el" href="classripple_1_1SField.html">SField</a> const&gt; ripple::SOElement::sField_</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="SOTemplate_8h_source.html#l00032">32</a> of file <a class="el" href="SOTemplate_8h_source.html">SOTemplate.h</a>.</p>
</div>
</div>
<a id="a094af02f701ea80b89bf7c2f401c2f82" name="a094af02f701ea80b89bf7c2f401c2f82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a094af02f701ea80b89bf7c2f401c2f82">&#9670;&#160;</a></span>style_</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="namespaceripple.html#ad905dc8b70717f4492bebb6b7e189042">SOEStyle</a> ripple::SOElement::style_</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="SOTemplate_8h_source.html#l00033">33</a> of file <a class="el" href="SOTemplate_8h_source.html">SOTemplate.h</a>.</p>
</div>
</div>
<a id="a14c2b1d0c1202824a237f08fa256fec6" name="a14c2b1d0c1202824a237f08fa256fec6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14c2b1d0c1202824a237f08fa256fec6">&#9670;&#160;</a></span>supportMpt_</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="namespaceripple.html#abd329a8849fd0c4cb884992c5963523d">SOETxMPTIssue</a> ripple::SOElement::supportMpt_ = <a class="el" href="namespaceripple.html#abd329a8849fd0c4cb884992c5963523da29a7e1961373724abdb178392cb5fe68">soeMPTNone</a></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="SOTemplate_8h_source.html#l00034">34</a> of file <a class="el" href="SOTemplate_8h_source.html">SOTemplate.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