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
2406a770b3a44e5f6be65be67f9d965f93ec614f
rippled/classripple_1_1TxConsequences.html
seelabs c9e2a2ca61 deploy: e718378bdb
2024-02-26 11:31:34 +00:00

731 lines
42 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::TxConsequences 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_1TxConsequences.html">TxConsequences</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1TxConsequences-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::TxConsequences Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class describing the consequences to the account of applying a transaction if the transaction consumes the maximum XRP allowed.
<a href="classripple_1_1TxConsequences.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::TxConsequences:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1TxConsequences__coll__graph.png" border="0" usemap="#ripple_1_1TxConsequences_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1TxConsequences_coll__map" id="ripple_1_1TxConsequences_coll__map">
<area shape="rect" title="Class describing the consequences to the account of applying a transaction if the transaction consume..." alt="" coords="633,63,811,89"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="67,5,169,32"/>
<area shape="rect" href="classripple_1_1SeqProxy.html" title="A type that represents either a sequence value or a ticket value." alt="" coords="337,63,465,89"/>
<area shape="rect" href="classripple_1_1XRPAmount.html" title=" " alt="" coords="330,135,473,161"/>
<area shape="rect" title=" " alt="" coords="35,61,201,102"/>
<area shape="rect" title=" " alt="" coords="5,127,231,153"/>
<area shape="rect" title=" " alt="" coords="13,178,223,219"/>
<area shape="rect" title=" " alt="" coords="11,243,225,285"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="71,309,165,336"/>
</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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:af40159818c89963a904c9c4c0848cae9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#af40159818c89963a904c9c4c0848cae9">Category</a> { <a class="el" href="classripple_1_1TxConsequences.html#af40159818c89963a904c9c4c0848cae9aa2a44ea84ff1c735a8d9ac6edf7f43a1">normal</a> = 0,
<a class="el" href="classripple_1_1TxConsequences.html#af40159818c89963a904c9c4c0848cae9aea7777d0faf53e7b154d9239bb1ee1c8">blocker</a>
}</td></tr>
<tr class="memdesc:af40159818c89963a904c9c4c0848cae9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describes how the transaction affects subsequent transactions. <a href="classripple_1_1TxConsequences.html#af40159818c89963a904c9c4c0848cae9">More...</a><br /></td></tr>
<tr class="separator:af40159818c89963a904c9c4c0848cae9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a34c5c5482638c3017af0e2f0be017ebe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a34c5c5482638c3017af0e2f0be017ebe">TxConsequences</a> (<a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> pfresult)</td></tr>
<tr class="separator:a34c5c5482638c3017af0e2f0be017ebe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec29d4ddbb16470c1dfcb0956b42e253"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#aec29d4ddbb16470c1dfcb0956b42e253">TxConsequences</a> (<a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;tx)</td></tr>
<tr class="memdesc:aec29d4ddbb16470c1dfcb0956b42e253"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor if the <a class="el" href="classripple_1_1STTx.html">STTx</a> has no notable consequences for the <a class="el" href="classripple_1_1TxQ.html" title="Transaction Queue.">TxQ</a>. <a href="classripple_1_1TxConsequences.html#aec29d4ddbb16470c1dfcb0956b42e253">More...</a><br /></td></tr>
<tr class="separator:aec29d4ddbb16470c1dfcb0956b42e253"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23bdb1eae1a640c53c8aaaf72900f7e7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a23bdb1eae1a640c53c8aaaf72900f7e7">TxConsequences</a> (<a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;tx, <a class="el" href="classripple_1_1TxConsequences.html#af40159818c89963a904c9c4c0848cae9">Category</a> category)</td></tr>
<tr class="memdesc:a23bdb1eae1a640c53c8aaaf72900f7e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for a blocker. <a href="classripple_1_1TxConsequences.html#a23bdb1eae1a640c53c8aaaf72900f7e7">More...</a><br /></td></tr>
<tr class="separator:a23bdb1eae1a640c53c8aaaf72900f7e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35249ac484b096d0e7e7658658937b74"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a35249ac484b096d0e7e7658658937b74">TxConsequences</a> (<a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;tx, <a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> <a class="el" href="classripple_1_1TxConsequences.html#ae5bc93daf9b1487d9d613b05b71c8b24">potentialSpend</a>)</td></tr>
<tr class="memdesc:a35249ac484b096d0e7e7658658937b74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for an <a class="el" href="classripple_1_1STTx.html">STTx</a> that may consume more XRP than the fee. <a href="classripple_1_1TxConsequences.html#a35249ac484b096d0e7e7658658937b74">More...</a><br /></td></tr>
<tr class="separator:a35249ac484b096d0e7e7658658937b74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a063d0a4d07d5b12625f48584330b6ceb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a063d0a4d07d5b12625f48584330b6ceb">TxConsequences</a> (<a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;tx, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <a class="el" href="classripple_1_1TxConsequences.html#a20abd112d02ea0d5cad5e6a3eba53c84">sequencesConsumed</a>)</td></tr>
<tr class="memdesc:a063d0a4d07d5b12625f48584330b6ceb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for an <a class="el" href="classripple_1_1STTx.html">STTx</a> that consumes more than the usual sequences. <a href="classripple_1_1TxConsequences.html#a063d0a4d07d5b12625f48584330b6ceb">More...</a><br /></td></tr>
<tr class="separator:a063d0a4d07d5b12625f48584330b6ceb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b48d06ba95ca7310800050ab92c33bb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a5b48d06ba95ca7310800050ab92c33bb">TxConsequences</a> (<a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</a> const &amp;)=default</td></tr>
<tr class="memdesc:a5b48d06ba95ca7310800050ab92c33bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="classripple_1_1TxConsequences.html#a5b48d06ba95ca7310800050ab92c33bb">More...</a><br /></td></tr>
<tr class="separator:a5b48d06ba95ca7310800050ab92c33bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fb77d6877f19ba4de5ac3167be1d0d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a5fb77d6877f19ba4de5ac3167be1d0d7">operator=</a> (<a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</a> const &amp;)=default</td></tr>
<tr class="memdesc:a5fb77d6877f19ba4de5ac3167be1d0d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy assignment operator. <a href="classripple_1_1TxConsequences.html#a5fb77d6877f19ba4de5ac3167be1d0d7">More...</a><br /></td></tr>
<tr class="separator:a5fb77d6877f19ba4de5ac3167be1d0d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36fa0d891e4ff72381b2eb9c4b8287d2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a36fa0d891e4ff72381b2eb9c4b8287d2">TxConsequences</a> (<a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a36fa0d891e4ff72381b2eb9c4b8287d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <a href="classripple_1_1TxConsequences.html#a36fa0d891e4ff72381b2eb9c4b8287d2">More...</a><br /></td></tr>
<tr class="separator:a36fa0d891e4ff72381b2eb9c4b8287d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20478dbe1deb95debc3cca9328a84a49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a20478dbe1deb95debc3cca9328a84a49">operator=</a> (<a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a20478dbe1deb95debc3cca9328a84a49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment operator. <a href="classripple_1_1TxConsequences.html#a20478dbe1deb95debc3cca9328a84a49">More...</a><br /></td></tr>
<tr class="separator:a20478dbe1deb95debc3cca9328a84a49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad51b7e201b2c1607411acd4290b95a43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#ad51b7e201b2c1607411acd4290b95a43">fee</a> () const</td></tr>
<tr class="memdesc:ad51b7e201b2c1607411acd4290b95a43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fee. <a href="classripple_1_1TxConsequences.html#ad51b7e201b2c1607411acd4290b95a43">More...</a><br /></td></tr>
<tr class="separator:ad51b7e201b2c1607411acd4290b95a43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5bc93daf9b1487d9d613b05b71c8b24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#ae5bc93daf9b1487d9d613b05b71c8b24">potentialSpend</a> () const</td></tr>
<tr class="memdesc:ae5bc93daf9b1487d9d613b05b71c8b24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Potential Spend. <a href="classripple_1_1TxConsequences.html#ae5bc93daf9b1487d9d613b05b71c8b24">More...</a><br /></td></tr>
<tr class="separator:ae5bc93daf9b1487d9d613b05b71c8b24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7c60a361b7d3d4c147cbd96998a24bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SeqProxy.html">SeqProxy</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#ac7c60a361b7d3d4c147cbd96998a24bb">seqProxy</a> () const</td></tr>
<tr class="memdesc:ac7c60a361b7d3d4c147cbd96998a24bb"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1SeqProxy.html" title="A type that represents either a sequence value or a ticket value.">SeqProxy</a>. <a href="classripple_1_1TxConsequences.html#ac7c60a361b7d3d4c147cbd96998a24bb">More...</a><br /></td></tr>
<tr class="separator:ac7c60a361b7d3d4c147cbd96998a24bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20abd112d02ea0d5cad5e6a3eba53c84"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a20abd112d02ea0d5cad5e6a3eba53c84">sequencesConsumed</a> () const</td></tr>
<tr class="memdesc:a20abd112d02ea0d5cad5e6a3eba53c84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sequences consumed. <a href="classripple_1_1TxConsequences.html#a20abd112d02ea0d5cad5e6a3eba53c84">More...</a><br /></td></tr>
<tr class="separator:a20abd112d02ea0d5cad5e6a3eba53c84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2e970e51e09e621d31f48f9e2a1a159"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#af2e970e51e09e621d31f48f9e2a1a159">isBlocker</a> () const</td></tr>
<tr class="memdesc:af2e970e51e09e621d31f48f9e2a1a159"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the transaction is a blocker. <a href="classripple_1_1TxConsequences.html#af2e970e51e09e621d31f48f9e2a1a159">More...</a><br /></td></tr>
<tr class="separator:af2e970e51e09e621d31f48f9e2a1a159"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89d865a7cce008d607994d90296463b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SeqProxy.html">SeqProxy</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a89d865a7cce008d607994d90296463b3">followingSeq</a> () const</td></tr>
<tr class="separator:a89d865a7cce008d607994d90296463b3"><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:ae13e442b1fc639ee586f82427e96fcb4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#ae13e442b1fc639ee586f82427e96fcb4">isBlocker_</a></td></tr>
<tr class="memdesc:ae13e442b1fc639ee586f82427e96fcb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describes how the transaction affects subsequent transactions. <a href="classripple_1_1TxConsequences.html#ae13e442b1fc639ee586f82427e96fcb4">More...</a><br /></td></tr>
<tr class="separator:ae13e442b1fc639ee586f82427e96fcb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0aebae70b0032cf1389d347d28015f5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a0aebae70b0032cf1389d347d28015f5f">fee_</a></td></tr>
<tr class="memdesc:a0aebae70b0032cf1389d347d28015f5f"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Transaction.html">Transaction</a> fee. <a href="classripple_1_1TxConsequences.html#a0aebae70b0032cf1389d347d28015f5f">More...</a><br /></td></tr>
<tr class="separator:a0aebae70b0032cf1389d347d28015f5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af451d615f5153a98a6fa0556c3bd35d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#af451d615f5153a98a6fa0556c3bd35d2">potentialSpend_</a></td></tr>
<tr class="memdesc:af451d615f5153a98a6fa0556c3bd35d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Does NOT include the fee. <a href="classripple_1_1TxConsequences.html#af451d615f5153a98a6fa0556c3bd35d2">More...</a><br /></td></tr>
<tr class="separator:af451d615f5153a98a6fa0556c3bd35d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4f30bf73a25ce166aca26cd1a6086d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1SeqProxy.html">SeqProxy</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#af4f30bf73a25ce166aca26cd1a6086d4">seqProx_</a></td></tr>
<tr class="memdesc:af4f30bf73a25ce166aca26cd1a6086d4"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1SeqProxy.html" title="A type that represents either a sequence value or a ticket value.">SeqProxy</a> of transaction. <a href="classripple_1_1TxConsequences.html#af4f30bf73a25ce166aca26cd1a6086d4">More...</a><br /></td></tr>
<tr class="separator:af4f30bf73a25ce166aca26cd1a6086d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f768216f33e97c5c5acbc23b7ecb4e0"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxConsequences.html#a8f768216f33e97c5c5acbc23b7ecb4e0">sequencesConsumed_</a></td></tr>
<tr class="memdesc:a8f768216f33e97c5c5acbc23b7ecb4e0"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Number.html">Number</a> of sequences consumed. <a href="classripple_1_1TxConsequences.html#a8f768216f33e97c5c5acbc23b7ecb4e0">More...</a><br /></td></tr>
<tr class="separator:a8f768216f33e97c5c5acbc23b7ecb4e0"><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>Class describing the consequences to the account of applying a transaction if the transaction consumes the maximum XRP allowed. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00045">45</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="af40159818c89963a904c9c4c0848cae9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af40159818c89963a904c9c4c0848cae9">&#9670;&nbsp;</a></span>Category</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classripple_1_1TxConsequences.html#af40159818c89963a904c9c4c0848cae9">ripple::TxConsequences::Category</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Describes how the transaction affects subsequent transactions. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af40159818c89963a904c9c4c0848cae9aa2a44ea84ff1c735a8d9ac6edf7f43a1"></a>normal&#160;</td><td class="fielddoc"><p>Moves currency around, creates offers, etc. </p>
</td></tr>
<tr><td class="fieldname"><a id="af40159818c89963a904c9c4c0848cae9aea7777d0faf53e7b154d9239bb1ee1c8"></a>blocker&#160;</td><td class="fielddoc"><p>Affects the ability of subsequent transactions to claim a fee. </p>
<p>Eg. <code><a class="el" href="classripple_1_1SetRegularKey.html">SetRegularKey</a></code> </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00050">50</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a34c5c5482638c3017af0e2f0be017ebe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34c5c5482638c3017af0e2f0be017ebe">&#9670;&nbsp;</a></span>TxConsequences() <span class="overload">[1/7]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::TxConsequences::TxConsequences </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a>&#160;</td>
<td class="paramname"><em>pfresult</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="applySteps_8cpp_source.html#l00301">301</a> of file <a class="el" href="applySteps_8cpp_source.html">applySteps.cpp</a>.</p>
</div>
</div>
<a id="aec29d4ddbb16470c1dfcb0956b42e253"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec29d4ddbb16470c1dfcb0956b42e253">&#9670;&nbsp;</a></span>TxConsequences() <span class="overload">[2/7]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::TxConsequences::TxConsequences </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;&#160;</td>
<td class="paramname"><em>tx</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor if the <a class="el" href="classripple_1_1STTx.html">STTx</a> has no notable consequences for the <a class="el" href="classripple_1_1TxQ.html" title="Transaction Queue.">TxQ</a>. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8cpp_source.html#l00311">311</a> of file <a class="el" href="applySteps_8cpp_source.html">applySteps.cpp</a>.</p>
</div>
</div>
<a id="a23bdb1eae1a640c53c8aaaf72900f7e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23bdb1eae1a640c53c8aaaf72900f7e7">&#9670;&nbsp;</a></span>TxConsequences() <span class="overload">[3/7]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::TxConsequences::TxConsequences </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;&#160;</td>
<td class="paramname"><em>tx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1TxConsequences.html#af40159818c89963a904c9c4c0848cae9">Category</a>&#160;</td>
<td class="paramname"><em>category</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for a blocker. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8cpp_source.html#l00322">322</a> of file <a class="el" href="applySteps_8cpp_source.html">applySteps.cpp</a>.</p>
</div>
</div>
<a id="a35249ac484b096d0e7e7658658937b74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35249ac484b096d0e7e7658658937b74">&#9670;&nbsp;</a></span>TxConsequences() <span class="overload">[4/7]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::TxConsequences::TxConsequences </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;&#160;</td>
<td class="paramname"><em>tx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a>&#160;</td>
<td class="paramname"><em>potentialSpend</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for an <a class="el" href="classripple_1_1STTx.html">STTx</a> that may consume more XRP than the fee. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8cpp_source.html#l00328">328</a> of file <a class="el" href="applySteps_8cpp_source.html">applySteps.cpp</a>.</p>
</div>
</div>
<a id="a063d0a4d07d5b12625f48584330b6ceb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a063d0a4d07d5b12625f48584330b6ceb">&#9670;&nbsp;</a></span>TxConsequences() <span class="overload">[5/7]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::TxConsequences::TxConsequences </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;&#160;</td>
<td class="paramname"><em>tx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td>
<td class="paramname"><em>sequencesConsumed</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for an <a class="el" href="classripple_1_1STTx.html">STTx</a> that consumes more than the usual sequences. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8cpp_source.html#l00334">334</a> of file <a class="el" href="applySteps_8cpp_source.html">applySteps.cpp</a>.</p>
</div>
</div>
<a id="a5b48d06ba95ca7310800050ab92c33bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b48d06ba95ca7310800050ab92c33bb">&#9670;&nbsp;</a></span>TxConsequences() <span class="overload">[6/7]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::TxConsequences::TxConsequences </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</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">
<p>Copy constructor. </p>
</div>
</div>
<a id="a36fa0d891e4ff72381b2eb9c4b8287d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36fa0d891e4ff72381b2eb9c4b8287d2">&#9670;&nbsp;</a></span>TxConsequences() <span class="overload">[7/7]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::TxConsequences::TxConsequences </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</a> &amp;&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">
<p>Move constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5fb77d6877f19ba4de5ac3167be1d0d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fb77d6877f19ba4de5ac3167be1d0d7">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></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="classripple_1_1TxConsequences.html">TxConsequences</a>&amp; ripple::TxConsequences::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</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">
<p>Copy assignment operator. </p>
</div>
</div>
<a id="a20478dbe1deb95debc3cca9328a84a49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20478dbe1deb95debc3cca9328a84a49">&#9670;&nbsp;</a></span>operator=() <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"><a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</a>&amp; ripple::TxConsequences::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1TxConsequences.html">TxConsequences</a> &amp;&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">
<p>Move assignment operator. </p>
</div>
</div>
<a id="ad51b7e201b2c1607411acd4290b95a43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad51b7e201b2c1607411acd4290b95a43">&#9670;&nbsp;</a></span>fee()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::TxConsequences::fee </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fee. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00101">101</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="ae5bc93daf9b1487d9d613b05b71c8b24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5bc93daf9b1487d9d613b05b71c8b24">&#9670;&nbsp;</a></span>potentialSpend()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> const&amp; ripple::TxConsequences::potentialSpend </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Potential Spend. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00108">108</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="ac7c60a361b7d3d4c147cbd96998a24bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7c60a361b7d3d4c147cbd96998a24bb">&#9670;&nbsp;</a></span>seqProxy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SeqProxy.html">SeqProxy</a> ripple::TxConsequences::seqProxy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1SeqProxy.html" title="A type that represents either a sequence value or a ticket value.">SeqProxy</a>. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00115">115</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a20abd112d02ea0d5cad5e6a3eba53c84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20abd112d02ea0d5cad5e6a3eba53c84">&#9670;&nbsp;</a></span>sequencesConsumed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::TxConsequences::sequencesConsumed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sequences consumed. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00122">122</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="af2e970e51e09e621d31f48f9e2a1a159"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2e970e51e09e621d31f48f9e2a1a159">&#9670;&nbsp;</a></span>isBlocker()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::TxConsequences::isBlocker </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the transaction is a blocker. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00129">129</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a89d865a7cce008d607994d90296463b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89d865a7cce008d607994d90296463b3">&#9670;&nbsp;</a></span>followingSeq()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1SeqProxy.html">SeqProxy</a> ripple::TxConsequences::followingSeq </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="applySteps_8h_source.html#l00136">136</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae13e442b1fc639ee586f82427e96fcb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae13e442b1fc639ee586f82427e96fcb4">&#9670;&nbsp;</a></span>isBlocker_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::TxConsequences::isBlocker_</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>Describes how the transaction affects subsequent transactions. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00061">61</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a0aebae70b0032cf1389d347d28015f5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0aebae70b0032cf1389d347d28015f5f">&#9670;&nbsp;</a></span>fee_</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="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::TxConsequences::fee_</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><a class="el" href="classripple_1_1Transaction.html">Transaction</a> fee. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00063">63</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="af451d615f5153a98a6fa0556c3bd35d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af451d615f5153a98a6fa0556c3bd35d2">&#9670;&nbsp;</a></span>potentialSpend_</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="classripple_1_1XRPAmount.html">XRPAmount</a> ripple::TxConsequences::potentialSpend_</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>Does NOT include the fee. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00065">65</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="af4f30bf73a25ce166aca26cd1a6086d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4f30bf73a25ce166aca26cd1a6086d4">&#9670;&nbsp;</a></span>seqProx_</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="classripple_1_1SeqProxy.html">SeqProxy</a> ripple::TxConsequences::seqProx_</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><a class="el" href="classripple_1_1SeqProxy.html" title="A type that represents either a sequence value or a ticket value.">SeqProxy</a> of transaction. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00067">67</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a8f768216f33e97c5c5acbc23b7ecb4e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f768216f33e97c5c5acbc23b7ecb4e0">&#9670;&nbsp;</a></span>sequencesConsumed_</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/types/integer.html">std::uint32_t</a> ripple::TxConsequences::sequencesConsumed_</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><a class="el" href="classripple_1_1Number.html">Number</a> of sequences consumed. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00069">69</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="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