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

296 lines
18 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::path::RippleCalc::Output 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="namespaceripple_1_1path.html">path</a></li><li class="navelem"><a class="el" href="classripple_1_1path_1_1RippleCalc.html">RippleCalc</a></li><li class="navelem"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Output.html">Output</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="#pri-attribs">Private Attributes</a> &#124;
<a href="structripple_1_1path_1_1RippleCalc_1_1Output-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::path::RippleCalc::Output Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="RippleCalc_8h_source.html">RippleCalc.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::path::RippleCalc::Output:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1path_1_1RippleCalc_1_1Output__coll__graph.png" border="0" usemap="#aripple_1_1path_1_1RippleCalc_1_1Output_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1path_1_1RippleCalc_1_1Output_coll__map" id="aripple_1_1path_1_1RippleCalc_1_1Output_coll__map">
<area shape="rect" title=" " alt="" coords="1416,295,1589,335"/>
<area shape="rect" href="classripple_1_1STAmount.html" title=" " alt="" coords="1104,267,1237,293"/>
<area shape="poly" title=" " alt="" coords="1251,286,1416,303,1416,308,1251,291"/>
<area shape="rect" href="classripple_1_1STBase.html" title="A type which can be exported to a well known binary format." alt="" coords="799,114,913,139"/>
<area shape="poly" title=" " alt="" coords="920,141,938,148,1001,178,1061,210,1151,265,1148,269,1058,215,999,182,936,153,918,146"/>
<area shape="rect" href="classripple_1_1SField.html" title="Identifies fields." alt="" coords="467,103,573,129"/>
<area shape="poly" title=" " alt="" coords="588,120,619,123,798,125,798,130,619,128,587,126"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="780,163,932,218"/>
<area shape="poly" title=" " alt="" coords="568,131,619,147,702,165,780,178,779,183,701,170,618,152,566,136"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="780,9,932,63"/>
<area shape="poly" title=" " alt="" coords="587,109,666,99,750,80,800,61,802,66,751,85,667,104,588,114"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="216,29,303,54"/>
<area shape="poly" title=" " alt="" coords="317,55,475,101,474,106,315,60"/>
<area shape="poly" title=" " alt="" coords="317,33,509,19,630,17,751,20,780,23,780,28,751,25,630,22,509,25,317,38"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="5,21,144,61"/>
<area shape="poly" title=" " alt="" coords="158,39,216,39,216,44,158,44"/>
<area shape="rect" href="classJson_1_1StaticString.html" title="Lightweight wrapper to tag static string." alt="" coords="193,103,325,129"/>
<area shape="poly" title=" " alt="" coords="339,113,467,113,467,119,339,119"/>
<area shape="poly" title=" " alt="" coords="767,223,731,229,693,232,654,229,618,218,587,200,561,176,527,131,531,127,565,172,590,196,620,214,655,224,693,227,730,224,766,218"/>
<area shape="poly" title=" " alt="" coords="767,42,694,51,619,68,577,86,542,105,540,101,575,81,618,63,693,46,766,37"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="775,243,937,283"/>
<area shape="poly" title=" " alt="" coords="951,265,1104,274,1104,279,951,271"/>
<area shape="rect" href="classripple_1_1Asset.html" title=" " alt="" coords="805,307,907,333"/>
<area shape="poly" title=" " alt="" coords="921,310,1073,292,1103,288,1104,293,1074,297,921,316"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/variant.html" title=" " alt="" coords="445,300,595,340"/>
<area shape="poly" title=" " alt="" coords="608,317,805,317,805,323,608,323"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="805,477,907,502"/>
<area shape="poly" title=" " alt="" coords="922,502,960,505,1000,504,1038,494,1072,473,1086,454,1091,434,1090,414,1086,393,1078,349,1082,326,1095,304,1111,291,1114,295,1099,307,1087,328,1084,349,1091,392,1095,413,1096,435,1091,456,1075,477,1041,498,1001,509,960,511,921,507"/>
<area shape="rect" href="classripple_1_1TERSubset.html" title=" " alt="" coords="1097,317,1244,357"/>
<area shape="poly" title=" " alt="" coords="1258,334,1392,328,1415,326,1416,331,1392,333,1258,340"/>
</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:a3225ab1eaadd5816c9d4a7d3908219e7" id="r_a3225ab1eaadd5816c9d4a7d3908219e7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a3225ab1eaadd5816c9d4a7d3908219e7">Output</a> ()=default</td></tr>
<tr class="separator:a3225ab1eaadd5816c9d4a7d3908219e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94945b6df065d61d3463e87281900fce" id="r_a94945b6df065d61d3463e87281900fce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a94945b6df065d61d3463e87281900fce">result</a> () const</td></tr>
<tr class="separator:a94945b6df065d61d3463e87281900fce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfb54432dd167403ef7211b513af1e82" id="r_abfb54432dd167403ef7211b513af1e82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#abfb54432dd167403ef7211b513af1e82">setResult</a> (<a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> const value)</td></tr>
<tr class="separator:abfb54432dd167403ef7211b513af1e82"><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:aa0308a8f67f3c3eb723803459b46d1e6" id="r_aa0308a8f67f3c3eb723803459b46d1e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1STAmount.html">STAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#aa0308a8f67f3c3eb723803459b46d1e6">actualAmountIn</a></td></tr>
<tr class="separator:aa0308a8f67f3c3eb723803459b46d1e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bb53c6084caa799ffbd574c13d13ed8" id="r_a4bb53c6084caa799ffbd574c13d13ed8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1STAmount.html">STAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a4bb53c6084caa799ffbd574c13d13ed8">actualAmountOut</a></td></tr>
<tr class="separator:a4bb53c6084caa799ffbd574c13d13ed8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7910c82102d9b9ecd4d345f7579278d1" id="r_a7910c82102d9b9ecd4d345f7579278d1"><td class="memItemLeft" align="right" valign="top">boost::container::flat_set&lt; <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a7910c82102d9b9ecd4d345f7579278d1">removableOffers</a></td></tr>
<tr class="separator:a7910c82102d9b9ecd4d345f7579278d1"><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:a1497da2426690d3e28266ffad4fa6d8c" id="r_a1497da2426690d3e28266ffad4fa6d8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a1497da2426690d3e28266ffad4fa6d8c">calculationResult_</a> = <a class="el" href="namespaceripple.html#afe21c8454670d46fb93751a5edffed46a1dad6e2d630423dd67f4a540305f8b3c">temUNKNOWN</a></td></tr>
<tr class="separator:a1497da2426690d3e28266ffad4fa6d8c"><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="definition">Definition at line <a class="el" href="RippleCalc_8h_source.html#l00036">36</a> of file <a class="el" href="RippleCalc_8h_source.html">RippleCalc.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3225ab1eaadd5816c9d4a7d3908219e7" name="a3225ab1eaadd5816c9d4a7d3908219e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3225ab1eaadd5816c9d4a7d3908219e7">&#9670;&#160;</a></span>Output()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::path::RippleCalc::Output::Output </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a94945b6df065d61d3463e87281900fce" name="a94945b6df065d61d3463e87281900fce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94945b6df065d61d3463e87281900fce">&#9670;&#160;</a></span>result()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ripple::path::RippleCalc::Output::result </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="RippleCalc_8h_source.html#l00058">58</a> of file <a class="el" href="RippleCalc_8h_source.html">RippleCalc.h</a>.</p>
</div>
</div>
<a id="abfb54432dd167403ef7211b513af1e82" name="abfb54432dd167403ef7211b513af1e82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfb54432dd167403ef7211b513af1e82">&#9670;&#160;</a></span>setResult()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::path::RippleCalc::Output::setResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> const&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RippleCalc_8h_source.html#l00063">63</a> of file <a class="el" href="RippleCalc_8h_source.html">RippleCalc.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa0308a8f67f3c3eb723803459b46d1e6" name="aa0308a8f67f3c3eb723803459b46d1e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0308a8f67f3c3eb723803459b46d1e6">&#9670;&#160;</a></span>actualAmountIn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> ripple::path::RippleCalc::Output::actualAmountIn</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RippleCalc_8h_source.html#l00041">41</a> of file <a class="el" href="RippleCalc_8h_source.html">RippleCalc.h</a>.</p>
</div>
</div>
<a id="a4bb53c6084caa799ffbd574c13d13ed8" name="a4bb53c6084caa799ffbd574c13d13ed8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bb53c6084caa799ffbd574c13d13ed8">&#9670;&#160;</a></span>actualAmountOut</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> ripple::path::RippleCalc::Output::actualAmountOut</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RippleCalc_8h_source.html#l00044">44</a> of file <a class="el" href="RippleCalc_8h_source.html">RippleCalc.h</a>.</p>
</div>
</div>
<a id="a7910c82102d9b9ecd4d345f7579278d1" name="a7910c82102d9b9ecd4d345f7579278d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7910c82102d9b9ecd4d345f7579278d1">&#9670;&#160;</a></span>removableOffers</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::container::flat_set&lt;<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>&gt; ripple::path::RippleCalc::Output::removableOffers</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RippleCalc_8h_source.html#l00051">51</a> of file <a class="el" href="RippleCalc_8h_source.html">RippleCalc.h</a>.</p>
</div>
</div>
<a id="a1497da2426690d3e28266ffad4fa6d8c" name="a1497da2426690d3e28266ffad4fa6d8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1497da2426690d3e28266ffad4fa6d8c">&#9670;&#160;</a></span>calculationResult_</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#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ripple::path::RippleCalc::Output::calculationResult_ = <a class="el" href="namespaceripple.html#afe21c8454670d46fb93751a5edffed46a1dad6e2d630423dd67f4a540305f8b3c">temUNKNOWN</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="RippleCalc_8h_source.html#l00054">54</a> of file <a class="el" href="RippleCalc_8h_source.html">RippleCalc.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