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/structripple_1_1PreclaimResult.html
ximinez e1dae4fb62 deploy: 3cbdf818a7
2025-09-18 10:58:55 -07:00

441 lines
30 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::PreclaimResult Struct 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="structripple_1_1PreclaimResult.html">PreclaimResult</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1PreclaimResult-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::PreclaimResult Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Describes the results of the <code>preclaim</code> check.
<a href="structripple_1_1PreclaimResult.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="applySteps_8h_source.html">applySteps.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::PreclaimResult:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1PreclaimResult__coll__graph.png" border="0" usemap="#aripple_1_1PreclaimResult_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1PreclaimResult_coll__map" id="aripple_1_1PreclaimResult_coll__map">
<area shape="rect" title="Describes the results of the preclaim check." alt="" coords="2279,127,2444,153"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="1981,330,2113,355"/>
<area shape="poly" title=" " alt="" coords="2070,318,2105,288,2147,258,2173,244,2195,235,2243,215,2297,181,2341,151,2344,155,2300,186,2245,220,2197,240,2175,249,2149,262,2108,292,2073,322"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="2268,323,2455,363"/>
<area shape="poly" title=" " alt="" coords="2127,340,2268,340,2268,345,2127,345"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="2273,449,2450,489"/>
<area shape="poly" title=" " alt="" coords="2069,365,2104,401,2126,418,2149,432,2210,453,2273,464,2272,469,2209,459,2147,437,2123,423,2100,405,2065,369"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="2504,287,2705,313"/>
<area shape="poly" title=" " alt="" coords="2490,305,2479,305,2313,309,2241,314,2148,325,2107,333,2106,327,2148,320,2240,308,2313,303,2479,300,2490,300"/>
<area shape="poly" title=" " alt="" coords="2467,321,2531,310,2532,315,2468,327"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="2507,405,2702,430"/>
<area shape="poly" title=" " alt="" coords="2493,414,2384,406,2268,392,2178,376,2098,358,2099,353,2179,370,2268,387,2384,400,2494,409"/>
<area shape="poly" title=" " alt="" coords="2463,445,2544,427,2545,433,2464,450"/>
<area shape="rect" href="classripple_1_1STTx.html" title=" " alt="" coords="1997,213,2096,238"/>
<area shape="poly" title=" " alt="" coords="2107,207,2313,150,2314,155,2108,212"/>
<area shape="rect" href="classripple_1_1STObject.html" title=" " alt="" coords="1725,402,1851,427"/>
<area shape="poly" title=" " alt="" coords="1822,393,1880,357,1944,313,1992,272,2031,236,2034,240,1996,276,1947,317,1883,361,1825,397"/>
<area shape="rect" href="classripple_1_1STBase.html" title="A type which can be exported to a well known binary format." alt="" coords="827,507,941,533"/>
<area shape="poly" title=" " alt="" coords="955,522,1064,527,1203,528,1359,523,1516,508,1600,492,1682,463,1763,425,1765,430,1684,468,1602,497,1516,513,1360,528,1203,533,1063,532,955,527"/>
<area shape="rect" href="classripple_1_1detail_1_1STVar.html" title=" " alt="" coords="1083,455,1232,481"/>
<area shape="poly" title=" " alt="" coords="954,504,1089,478,1090,483,955,509"/>
<area shape="rect" href="classripple_1_1SField.html" title="Identifies fields." alt="" coords="479,571,586,597"/>
<area shape="poly" title=" " alt="" coords="599,569,826,528,827,533,600,575"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="808,654,960,709"/>
<area shape="poly" title=" " alt="" coords="565,602,602,624,645,643,728,664,808,674,808,680,727,669,643,648,600,629,562,607"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="808,557,960,611"/>
<area shape="poly" title=" " alt="" coords="600,581,807,581,807,587,600,587"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="216,507,303,533"/>
<area shape="poly" title=" " alt="" coords="317,531,480,569,479,574,316,536"/>
<area shape="poly" title=" " alt="" coords="316,504,407,487,524,477,588,478,653,484,716,497,777,518,791,530,802,543,819,554,816,559,798,547,787,533,775,522,715,502,652,489,588,483,524,483,408,493,316,509"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="5,500,144,540"/>
<area shape="poly" title=" " alt="" coords="158,517,216,517,216,523,158,523"/>
<area shape="rect" href="classJson_1_1StaticString.html" title="Lightweight wrapper to tag static string." alt="" coords="193,571,325,597"/>
<area shape="poly" title=" " alt="" coords="339,581,479,581,479,587,339,587"/>
<area shape="poly" title=" " alt="" coords="799,715,761,723,721,726,681,723,643,712,606,688,576,656,553,624,538,598,543,595,557,621,580,653,609,683,645,707,682,718,721,721,761,717,798,710"/>
<area shape="poly" title=" " alt="" coords="796,617,776,621,710,628,644,621,602,612,565,599,566,594,603,607,644,616,710,623,776,616,795,612"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1353,395,1516,435"/>
<area shape="poly" title=" " alt="" coords="1529,412,1725,412,1725,417,1529,417"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1363,459,1506,499"/>
<area shape="poly" title=" " alt="" coords="1519,461,1682,432,1725,424,1726,429,1683,437,1520,467"/>
<area shape="poly" title=" " alt="" coords="1246,469,1363,473,1363,479,1246,474"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="840,261,928,286"/>
<area shape="poly" title=" " alt="" coords="942,278,1042,288,1156,293,1789,293,1854,287,1918,272,1974,253,2017,236,2019,241,1976,258,1919,277,1855,292,1789,299,1156,299,1041,294,942,283"/>
<area shape="poly" title=" " alt="" coords="922,290,993,327,1029,338,1045,345,1061,358,1072,380,1073,400,1074,419,1085,438,1106,453,1103,457,1081,442,1069,421,1068,400,1067,381,1057,362,1042,349,1027,343,991,332,920,295"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="1087,163,1228,203"/>
<area shape="poly" title=" " alt="" coords="941,270,999,264,1058,248,1098,226,1132,201,1135,205,1101,231,1060,253,1000,269,942,275"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="1087,99,1228,139"/>
<area shape="poly" title=" " alt="" coords="923,252,991,219,1026,206,1041,199,1057,187,1064,178,1068,169,1072,159,1081,149,1098,137,1101,141,1084,153,1077,162,1073,171,1069,181,1061,191,1043,204,1028,211,993,224,925,257"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/aligned_storage.html" title=" " alt="" coords="807,427,961,467"/>
<area shape="poly" title=" " alt="" coords="975,451,1083,460,1082,465,975,456"/>
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="1362,345,1507,370"/>
<area shape="poly" title=" " alt="" coords="1522,368,1683,393,1726,401,1725,406,1682,399,1521,373"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1086,337,1229,377"/>
<area shape="poly" title=" " alt="" coords="1242,355,1362,355,1362,360,1242,360"/>
<area shape="rect" href="classripple_1_1SOElement.html" title="An element in a SOTemplate." alt="" coords="815,363,953,389"/>
<area shape="poly" title=" " alt="" coords="967,376,1058,372,1085,369,1086,374,1059,377,967,381"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/functional/reference_wrapper.html" title=" " alt="" coords="445,356,620,396"/>
<area shape="poly" title=" " alt="" coords="634,373,814,373,814,379,634,379"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1088,402,1227,427"/>
<area shape="poly" title=" " alt="" coords="1232,397,1372,367,1373,373,1233,402"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1707,219,1869,259"/>
<area shape="poly" title=" " alt="" coords="1883,231,1997,225,1997,231,1883,236"/>
<area shape="poly" title=" " alt="" coords="1242,181,1520,188,1870,204,1998,216,1997,222,1869,209,1520,194,1242,187"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="800,89,968,129"/>
<area shape="poly" title=" " alt="" coords="973,130,1087,161,1086,166,972,136"/>
<area shape="poly" title=" " alt="" coords="982,110,1087,114,1086,119,982,115"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="481,97,584,122"/>
<area shape="poly" title=" " alt="" coords="598,107,800,107,800,112,598,112"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1540,99,1683,139"/>
<area shape="poly" title=" " alt="" coords="1696,117,1816,129,1882,141,1946,160,1994,184,2031,210,2028,215,1991,189,1944,165,1881,147,1816,134,1696,123"/>
<area shape="poly" title=" " alt="" coords="1242,116,1540,116,1540,121,1242,121"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="1969,5,2124,45"/>
<area shape="poly" title=" " alt="" coords="2138,44,2245,78,2297,101,2340,125,2337,129,2294,106,2243,82,2137,49"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1991,70,2102,95"/>
<area shape="poly" title=" " alt="" coords="2116,92,2291,125,2291,130,2115,98"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1715,55,1861,81"/>
<area shape="poly" title=" " alt="" coords="1876,70,1991,77,1991,82,1875,76"/>
<area shape="rect" href="classripple_1_1TERSubset.html" title=" " alt="" coords="1973,120,2120,160"/>
<area shape="poly" title=" " alt="" coords="2134,137,2278,137,2278,143,2134,143"/>
</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:a688765112e9c16f80afdb9d2ce3282a7" id="r_a688765112e9c16f80afdb9d2ce3282a7"><td class="memTemplParams" colspan="2">template&lt;class Context &gt; </td></tr>
<tr class="memitem:a688765112e9c16f80afdb9d2ce3282a7"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimResult.html#a688765112e9c16f80afdb9d2ce3282a7">PreclaimResult</a> (Context const &amp;ctx_, <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ter_)</td></tr>
<tr class="memdesc:a688765112e9c16f80afdb9d2ce3282a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a688765112e9c16f80afdb9d2ce3282a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa32c66a6e91edf2da6d3c6966811ac9e" id="r_aa32c66a6e91edf2da6d3c6966811ac9e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimResult.html#aa32c66a6e91edf2da6d3c6966811ac9e">PreclaimResult</a> (<a class="el" href="structripple_1_1PreclaimResult.html">PreclaimResult</a> const &amp;)=default</td></tr>
<tr class="separator:aa32c66a6e91edf2da6d3c6966811ac9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1029463e10b63e5ba7166ae3af44ac9f" id="r_a1029463e10b63e5ba7166ae3af44ac9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1PreclaimResult.html">PreclaimResult</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimResult.html#a1029463e10b63e5ba7166ae3af44ac9f">operator=</a> (<a class="el" href="structripple_1_1PreclaimResult.html">PreclaimResult</a> const &amp;)=delete</td></tr>
<tr class="memdesc:a1029463e10b63e5ba7166ae3af44ac9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleted copy assignment operator. <br /></td></tr>
<tr class="separator:a1029463e10b63e5ba7166ae3af44ac9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a63d5e4fce0f093dcd45b3355827c6638" id="r_a63d5e4fce0f093dcd45b3355827c6638"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimResult.html#a63d5e4fce0f093dcd45b3355827c6638">view</a></td></tr>
<tr class="memdesc:a63d5e4fce0f093dcd45b3355827c6638"><td class="mdescLeft">&#160;</td><td class="mdescRight">From the input - the ledger view. <br /></td></tr>
<tr class="separator:a63d5e4fce0f093dcd45b3355827c6638"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfb8e7aade8a1246d72082e31d531f42" id="r_adfb8e7aade8a1246d72082e31d531f42"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimResult.html#adfb8e7aade8a1246d72082e31d531f42">tx</a></td></tr>
<tr class="memdesc:adfb8e7aade8a1246d72082e31d531f42"><td class="mdescLeft">&#160;</td><td class="mdescRight">From the input - the transaction. <br /></td></tr>
<tr class="separator:adfb8e7aade8a1246d72082e31d531f42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7179d26a270dd945385f8d5c12cbd7a" id="r_aa7179d26a270dd945385f8d5c12cbd7a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &gt; const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimResult.html#aa7179d26a270dd945385f8d5c12cbd7a">parentBatchId</a></td></tr>
<tr class="memdesc:aa7179d26a270dd945385f8d5c12cbd7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">From the input - the batch identifier, if part of a batch. <br /></td></tr>
<tr class="separator:aa7179d26a270dd945385f8d5c12cbd7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d7f0b2d9c0e3c80d0ae6cae31299b7e" id="r_a0d7f0b2d9c0e3c80d0ae6cae31299b7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimResult.html#a0d7f0b2d9c0e3c80d0ae6cae31299b7e">flags</a></td></tr>
<tr class="memdesc:a0d7f0b2d9c0e3c80d0ae6cae31299b7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">From the input - the flags. <br /></td></tr>
<tr class="separator:a0d7f0b2d9c0e3c80d0ae6cae31299b7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d91f7dd0065709224c21c106b668f20" id="r_a7d91f7dd0065709224c21c106b668f20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimResult.html#a7d91f7dd0065709224c21c106b668f20">j</a></td></tr>
<tr class="memdesc:a7d91f7dd0065709224c21c106b668f20"><td class="mdescLeft">&#160;</td><td class="mdescRight">From the input - the journal. <br /></td></tr>
<tr class="separator:a7d91f7dd0065709224c21c106b668f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0eecc4df582c0971758cd81573241a89" id="r_a0eecc4df582c0971758cd81573241a89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimResult.html#a0eecc4df582c0971758cd81573241a89">ter</a></td></tr>
<tr class="memdesc:a0eecc4df582c0971758cd81573241a89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Intermediate transaction result. <br /></td></tr>
<tr class="separator:a0eecc4df582c0971758cd81573241a89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4150bfa8b73347c6e6a3225638d777fc" id="r_a4150bfa8b73347c6e6a3225638d777fc"><td class="memItemLeft" align="right" valign="top">bool const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimResult.html#a4150bfa8b73347c6e6a3225638d777fc">likelyToClaimFee</a></td></tr>
<tr class="memdesc:a4150bfa8b73347c6e6a3225638d777fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Success flag - whether the transaction is likely to claim a fee. <br /></td></tr>
<tr class="separator:a4150bfa8b73347c6e6a3225638d777fc"><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>Describes the results of the <code>preclaim</code> check. </p>
<dl class="section note"><dt>Note</dt><dd>All members are const to make it more difficult to "fake" a result without calling <code>preclaim</code>. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceripple.html#a24280b80536d1afd09e24a75f4596922" title="Gate a transaction based on static information.">preflight</a>, <a class="el" href="namespaceripple.html#a5027a5209e954b9478fab70357963466" title="Gate a transaction based on static ledger information.">preclaim</a>, <a class="el" href="namespaceripple.html#a2b59523126e4050b583017ce8465f3b6" title="Apply a prechecked transaction to an OpenView.">doApply</a>, <a class="el" href="namespaceripple.html#ab5570a1f8263efb3c9d80b34a92c895a" title="Apply a transaction to an OpenView.">apply</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00208">208</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a688765112e9c16f80afdb9d2ce3282a7" name="a688765112e9c16f80afdb9d2ce3282a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a688765112e9c16f80afdb9d2ce3282a7">&#9670;&#160;</a></span>PreclaimResult() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Context &gt; </div>
<table class="memname">
<tr>
<td class="memname">ripple::PreclaimResult::PreclaimResult </td>
<td>(</td>
<td class="paramtype">Context const &amp;&#160;</td>
<td class="paramname"><em>ctx_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>&#160;</td>
<td class="paramname"><em>ter_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00231">231</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="aa32c66a6e91edf2da6d3c6966811ac9e" name="aa32c66a6e91edf2da6d3c6966811ac9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa32c66a6e91edf2da6d3c6966811ac9e">&#9670;&#160;</a></span>PreclaimResult() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::PreclaimResult::PreclaimResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1PreclaimResult.html">PreclaimResult</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1029463e10b63e5ba7166ae3af44ac9f" name="a1029463e10b63e5ba7166ae3af44ac9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1029463e10b63e5ba7166ae3af44ac9f">&#9670;&#160;</a></span>operator=()</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="structripple_1_1PreclaimResult.html">PreclaimResult</a> &amp; ripple::PreclaimResult::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1PreclaimResult.html">PreclaimResult</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deleted copy assignment operator. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a63d5e4fce0f093dcd45b3355827c6638" name="a63d5e4fce0f093dcd45b3355827c6638"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63d5e4fce0f093dcd45b3355827c6638">&#9670;&#160;</a></span>view</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const&amp; ripple::PreclaimResult::view</td>
</tr>
</table>
</div><div class="memdoc">
<p>From the input - the ledger view. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00212">212</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="adfb8e7aade8a1246d72082e31d531f42" name="adfb8e7aade8a1246d72082e31d531f42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfb8e7aade8a1246d72082e31d531f42">&#9670;&#160;</a></span>tx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1STTx.html">STTx</a> const&amp; ripple::PreclaimResult::tx</td>
</tr>
</table>
</div><div class="memdoc">
<p>From the input - the transaction. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00214">214</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="aa7179d26a270dd945385f8d5c12cbd7a" name="aa7179d26a270dd945385f8d5c12cbd7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7179d26a270dd945385f8d5c12cbd7a">&#9670;&#160;</a></span>parentBatchId</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const&gt; const ripple::PreclaimResult::parentBatchId</td>
</tr>
</table>
</div><div class="memdoc">
<p>From the input - the batch identifier, if part of a batch. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00216">216</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a0d7f0b2d9c0e3c80d0ae6cae31299b7e" name="a0d7f0b2d9c0e3c80d0ae6cae31299b7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d7f0b2d9c0e3c80d0ae6cae31299b7e">&#9670;&#160;</a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> const ripple::PreclaimResult::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>From the input - the flags. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00218">218</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a7d91f7dd0065709224c21c106b668f20" name="a7d91f7dd0065709224c21c106b668f20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d91f7dd0065709224c21c106b668f20">&#9670;&#160;</a></span>j</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const ripple::PreclaimResult::j</td>
</tr>
</table>
</div><div class="memdoc">
<p>From the input - the journal. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00220">220</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a0eecc4df582c0971758cd81573241a89" name="a0eecc4df582c0971758cd81573241a89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0eecc4df582c0971758cd81573241a89">&#9670;&#160;</a></span>ter</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> const ripple::PreclaimResult::ter</td>
</tr>
</table>
</div><div class="memdoc">
<p>Intermediate transaction result. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00223">223</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a4150bfa8b73347c6e6a3225638d777fc" name="a4150bfa8b73347c6e6a3225638d777fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4150bfa8b73347c6e6a3225638d777fc">&#9670;&#160;</a></span>likelyToClaimFee</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool const ripple::PreclaimResult::likelyToClaimFee</td>
</tr>
</table>
</div><div class="memdoc">
<p>Success flag - whether the transaction is likely to claim a fee. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00227">227</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.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