ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-02-04 05:55:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/STTakesAsset_8cpp_source.html
bthomee 9368c0d563 deploy: 5f638f5553
2026-01-28 10:13:01 -08:00

149 lines
16 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: STTakesAsset.cpp Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_90ffdbabf412cfdffe6b2193e0ce938a.html">libxrpl</a></li><li class="navelem"><a class="el" href="dir_4cb643486f27a568a0d40f174f670f35.html">protocol</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">STTakesAsset.cpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &lt;xrpl/protocol/STTakesAsset.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Do not remove. Force STTakesAsset.h first</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpl/protocol/STLedgerEntry.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00008" data-start="{" data-end="}">
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="namespacexrpl.html#abdb51c4b406596cb642dc17e1ad5ae09"> 8</a></span><a class="code hl_function" href="namespacexrpl.html#adf6a712b96f28b3109e43464dc2e22d7">associateAsset</a>(<a class="code hl_class" href="classxrpl_1_1STLedgerEntry.html">SLE</a>&amp; sle, <a class="code hl_class" href="classxrpl_1_1Asset.html">Asset</a> <span class="keyword">const</span>&amp; asset)</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span>{</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// Iterating by offset is the only way to get non-const references</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; sle.<a class="code hl_function" href="classxrpl_1_1STObject.html#a81daec7b13c817bca5cf46b2a483740c">getCount</a>(); ++i)</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <a class="code hl_class" href="classxrpl_1_1STBase.html">STBase</a>&amp; entry = sle.<a class="code hl_function" href="classxrpl_1_1STObject.html#acc4bae0418b10df868ea8e321429754e">getIndex</a>(i);</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <a class="code hl_class" href="classxrpl_1_1SField.html">SField</a> <span class="keyword">const</span>&amp; field = entry.getFName();</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordflow">if</span> (field.shouldMeta(<a class="code hl_enumvalue" href="classxrpl_1_1SField.html#a1adce4853839b9550840b37a4d5f96d8adba819e79787d5f50b81d01b58fbebf9">SField::sMD_NeedsAsset</a>))</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">auto</span> <span class="keyword">const</span> type = entry.getSType();</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// If the field is not set or present, skip it.</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordflow">if</span> (type == STI_NOTPRESENT)</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordflow">continue</span>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// If the type doesn&#39;t downcast, then the flag shouldn&#39;t be on the</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// SField</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">auto</span>&amp; ta = entry.downcast&lt;<a class="code hl_class" href="classxrpl_1_1STTakesAsset.html">STTakesAsset</a>&gt;();</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">auto</span> <span class="keyword">const</span> style = sle.<a class="code hl_function" href="classxrpl_1_1STObject.html#a708c3d7c6c02c770cd4710816047117d">getStyle</a>(ta.getFName());</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> XRPL_ASSERT_PARTS(style != <a class="code hl_enumvalue" href="namespacexrpl.html#a39cef704bc54911c99acb6be435d552fa342c80d14724ca3cd5ed27e4a502d532">soeINVALID</a>, <span class="stringliteral">&quot;xrpl::associateAsset&quot;</span>, <span class="stringliteral">&quot;valid template element style&quot;</span>);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> XRPL_ASSERT_PARTS(style != <a class="code hl_enumvalue" href="namespacexrpl.html#a39cef704bc54911c99acb6be435d552fa8e02e8902937e2f8af697cb085074472">soeDEFAULT</a> || !ta.<a class="code hl_function" href="classxrpl_1_1STBase.html#a9b5b32a9418a6f44a2678bb096f6d5b8">isDefault</a>(), <span class="stringliteral">&quot;xrpl::associateAsset&quot;</span>, <span class="stringliteral">&quot;non-default value&quot;</span>);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> ta.associateAsset(asset);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// associateAsset in derived classes may change the underlying</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// value, but it won&#39;t know anything about how the value relates to</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// the SLE. If the template element is soeDEFAULT, and the value</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// changed to the default value, remove the field.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">if</span> (style == <a class="code hl_enumvalue" href="namespacexrpl.html#a39cef704bc54911c99acb6be435d552fa8e02e8902937e2f8af697cb085074472">soeDEFAULT</a> &amp;&amp; ta.<a class="code hl_function" href="classxrpl_1_1STBase.html#a9b5b32a9418a6f44a2678bb096f6d5b8">isDefault</a>())</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> sle.<a class="code hl_function" href="classxrpl_1_1STObject.html#aee115825b364e88967d6734f1594c11b">makeFieldAbsent</a>(field);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> }</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>}</div>
</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>} <span class="comment">// namespace xrpl</span></div>
<div class="ttc" id="aclassxrpl_1_1Asset_html"><div class="ttname"><a href="classxrpl_1_1Asset.html">xrpl::Asset</a></div><div class="ttdef"><b>Definition</b> <a href="Asset_8h_source.html#l00026">Asset.h:27</a></div></div>
<div class="ttc" id="aclassxrpl_1_1SField_html"><div class="ttname"><a href="classxrpl_1_1SField.html">xrpl::SField</a></div><div class="ttdoc">Identifies fields.</div><div class="ttdef"><b>Definition</b> <a href="SField_8h_source.html#l00126">SField.h:127</a></div></div>
<div class="ttc" id="aclassxrpl_1_1SField_html_a1adce4853839b9550840b37a4d5f96d8adba819e79787d5f50b81d01b58fbebf9"><div class="ttname"><a href="classxrpl_1_1SField.html#a1adce4853839b9550840b37a4d5f96d8adba819e79787d5f50b81d01b58fbebf9">xrpl::SField::sMD_NeedsAsset</a></div><div class="ttdeci">@ sMD_NeedsAsset</div><div class="ttdef"><b>Definition</b> <a href="SField_8h_source.html#l00139">SField.h:139</a></div></div>
<div class="ttc" id="aclassxrpl_1_1STBase_html"><div class="ttname"><a href="classxrpl_1_1STBase.html">xrpl::STBase</a></div><div class="ttdoc">A type which can be exported to a well known binary format.</div><div class="ttdef"><b>Definition</b> <a href="STBase_8h_source.html#l00115">STBase.h:116</a></div></div>
<div class="ttc" id="aclassxrpl_1_1STBase_html_a9b5b32a9418a6f44a2678bb096f6d5b8"><div class="ttname"><a href="classxrpl_1_1STBase.html#a9b5b32a9418a6f44a2678bb096f6d5b8">xrpl::STBase::isDefault</a></div><div class="ttdeci">virtual bool isDefault() const</div><div class="ttdef"><b>Definition</b> <a href="STBase_8cpp_source.html#l00109">STBase.cpp:109</a></div></div>
<div class="ttc" id="aclassxrpl_1_1STLedgerEntry_html"><div class="ttname"><a href="classxrpl_1_1STLedgerEntry.html">xrpl::STLedgerEntry</a></div><div class="ttdef"><b>Definition</b> <a href="STLedgerEntry_8h_source.html#l00014">STLedgerEntry.h:15</a></div></div>
<div class="ttc" id="aclassxrpl_1_1STObject_html_a708c3d7c6c02c770cd4710816047117d"><div class="ttname"><a href="classxrpl_1_1STObject.html#a708c3d7c6c02c770cd4710816047117d">xrpl::STObject::getStyle</a></div><div class="ttdeci">SOEStyle getStyle(SField const &amp;field) const</div><div class="ttdef"><b>Definition</b> <a href="STObject_8cpp_source.html#l00558">STObject.cpp:558</a></div></div>
<div class="ttc" id="aclassxrpl_1_1STObject_html_a81daec7b13c817bca5cf46b2a483740c"><div class="ttname"><a href="classxrpl_1_1STObject.html#a81daec7b13c817bca5cf46b2a483740c">xrpl::STObject::getCount</a></div><div class="ttdeci">int getCount() const</div><div class="ttdef"><b>Definition</b> <a href="STObject_8h_source.html#l00983">STObject.h:983</a></div></div>
<div class="ttc" id="aclassxrpl_1_1STObject_html_acc4bae0418b10df868ea8e321429754e"><div class="ttname"><a href="classxrpl_1_1STObject.html#acc4bae0418b10df868ea8e321429754e">xrpl::STObject::getIndex</a></div><div class="ttdeci">STBase &amp; getIndex(int offset)</div><div class="ttdef"><b>Definition</b> <a href="STObject_8h_source.html#l00995">STObject.h:995</a></div></div>
<div class="ttc" id="aclassxrpl_1_1STObject_html_aee115825b364e88967d6734f1594c11b"><div class="ttname"><a href="classxrpl_1_1STObject.html#aee115825b364e88967d6734f1594c11b">xrpl::STObject::makeFieldAbsent</a></div><div class="ttdeci">void makeFieldAbsent(SField const &amp;field)</div><div class="ttdef"><b>Definition</b> <a href="STObject_8cpp_source.html#l00525">STObject.cpp:525</a></div></div>
<div class="ttc" id="aclassxrpl_1_1STTakesAsset_html"><div class="ttname"><a href="classxrpl_1_1STTakesAsset.html">xrpl::STTakesAsset</a></div><div class="ttdoc">Intermediate class for any STBase-derived class to store an Asset.</div><div class="ttdef"><b>Definition</b> <a href="STTakesAsset_8h_source.html#l00022">STTakesAsset.h:23</a></div></div>
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a39cef704bc54911c99acb6be435d552fa342c80d14724ca3cd5ed27e4a502d532"><div class="ttname"><a href="namespacexrpl.html#a39cef704bc54911c99acb6be435d552fa342c80d14724ca3cd5ed27e4a502d532">xrpl::soeINVALID</a></div><div class="ttdeci">@ soeINVALID</div><div class="ttdef"><b>Definition</b> <a href="SOTemplate_8h_source.html#l00015">SOTemplate.h:15</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a39cef704bc54911c99acb6be435d552fa8e02e8902937e2f8af697cb085074472"><div class="ttname"><a href="namespacexrpl.html#a39cef704bc54911c99acb6be435d552fa8e02e8902937e2f8af697cb085074472">xrpl::soeDEFAULT</a></div><div class="ttdeci">@ soeDEFAULT</div><div class="ttdef"><b>Definition</b> <a href="SOTemplate_8h_source.html#l00018">SOTemplate.h:18</a></div></div>
<div class="ttc" id="anamespacexrpl_html_adf6a712b96f28b3109e43464dc2e22d7"><div class="ttname"><a href="namespacexrpl.html#adf6a712b96f28b3109e43464dc2e22d7">xrpl::associateAsset</a></div><div class="ttdeci">void associateAsset(STLedgerEntry &amp;sle, Asset const &amp;asset)</div><div class="ttdoc">Associate an Asset with all sMD_NeedsAsset fields in a ledger entry.</div></div>
</div><!-- fragment --></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