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_1AMMOffer.html
intelliot 2cd625785d deploy: 3c9db4b69e
2023-07-12 17:57:19 +00:00

707 lines
38 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::AMMOffer&lt; TIn, TOut &gt; Class Template 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_1AMMOffer.html">AMMOffer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1AMMOffer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::AMMOffer&lt; TIn, TOut &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents synthetic AMM offer in <a class="el" href="classripple_1_1BookStep.html">BookStep</a>.
<a href="classripple_1_1AMMOffer.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::AMMOffer&lt; TIn, TOut &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1AMMOffer__coll__graph.png" border="0" usemap="#ripple_1_1AMMOffer_3_01TIn_00_01TOut_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1AMMOffer_3_01TIn_00_01TOut_01_4_coll__map" id="ripple_1_1AMMOffer_3_01TIn_00_01TOut_01_4_coll__map">
<area shape="rect" title="Represents synthetic AMM offer in BookStep." alt="" coords="12,109,181,151"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="5,5,188,47"/>
</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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2135c82cf3cb7183eeff9fe0df5d9057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a2135c82cf3cb7183eeff9fe0df5d9057">AMMOffer</a> (<a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a>&lt; TIn, TOut &gt; const &amp;ammLiquidity, TAmounts&lt; TIn, TOut &gt; const &amp;amounts, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; TAmounts&lt; TIn, TOut &gt;&gt; const &amp;balances, Quality const &amp;<a class="el" href="classripple_1_1AMMOffer.html#a486876093ae0534c3b2f6e0de734822f">quality</a>)</td></tr>
<tr class="separator:a2135c82cf3cb7183eeff9fe0df5d9057"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a486876093ae0534c3b2f6e0de734822f"><td class="memItemLeft" align="right" valign="top">Quality&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a486876093ae0534c3b2f6e0de734822f">quality</a> () const noexcept</td></tr>
<tr class="separator:a486876093ae0534c3b2f6e0de734822f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6eff87d977b5a80f1a07660b455a6db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#ad6eff87d977b5a80f1a07660b455a6db">issueIn</a> () const</td></tr>
<tr class="separator:ad6eff87d977b5a80f1a07660b455a6db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c599cad195a93f56c24975eab9728cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a1c599cad195a93f56c24975eab9728cc">issueOut</a> () const</td></tr>
<tr class="separator:a1c599cad195a93f56c24975eab9728cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c97fe4fa25accdb68dc5d76a110acce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a2c97fe4fa25accdb68dc5d76a110acce">owner</a> () const</td></tr>
<tr class="separator:a2c97fe4fa25accdb68dc5d76a110acce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88753961f835cc4e516bed3598be5dc3"><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> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a88753961f835cc4e516bed3598be5dc3">key</a> () const</td></tr>
<tr class="separator:a88753961f835cc4e516bed3598be5dc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae00679ef074c1566c961189dbe3c6768"><td class="memItemLeft" align="right" valign="top">TAmounts&lt; TIn, TOut &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#ae00679ef074c1566c961189dbe3c6768">amount</a> () const</td></tr>
<tr class="separator:ae00679ef074c1566c961189dbe3c6768"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8856f999ea2ba636a2c74e642d4bb329"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a8856f999ea2ba636a2c74e642d4bb329">consume</a> (<a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;view, TAmounts&lt; TIn, TOut &gt; const &amp;consumed)</td></tr>
<tr class="separator:a8856f999ea2ba636a2c74e642d4bb329"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2eba1069935d7ca545125141fe44d3a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#ad2eba1069935d7ca545125141fe44d3a">fully_consumed</a> () const</td></tr>
<tr class="separator:ad2eba1069935d7ca545125141fe44d3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3757f92066ba7fa0fcf4b8964b00dfa4"><td class="memItemLeft" align="right" valign="top">TAmounts&lt; TIn, TOut &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a3757f92066ba7fa0fcf4b8964b00dfa4">limitOut</a> (TAmounts&lt; TIn, TOut &gt; const &amp;offrAmt, TOut const &amp;limit, bool fixReducedOffers, bool roundUp) const</td></tr>
<tr class="memdesc:a3757f92066ba7fa0fcf4b8964b00dfa4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Limit out of the provided offer. <a href="classripple_1_1AMMOffer.html#a3757f92066ba7fa0fcf4b8964b00dfa4">More...</a><br /></td></tr>
<tr class="separator:a3757f92066ba7fa0fcf4b8964b00dfa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47c9d8c0e8d74d833a2591b303b02c3e"><td class="memItemLeft" align="right" valign="top">TAmounts&lt; TIn, TOut &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a47c9d8c0e8d74d833a2591b303b02c3e">limitIn</a> (TAmounts&lt; TIn, TOut &gt; const &amp;offrAmt, TIn const &amp;limit) const</td></tr>
<tr class="memdesc:a47c9d8c0e8d74d833a2591b303b02c3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Limit in of the provided offer. <a href="classripple_1_1AMMOffer.html#a47c9d8c0e8d74d833a2591b303b02c3e">More...</a><br /></td></tr>
<tr class="separator:a47c9d8c0e8d74d833a2591b303b02c3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedb2204df9f80970d1356c8e1997ca35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1QualityFunction.html">QualityFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#aedb2204df9f80970d1356c8e1997ca35">getQualityFunc</a> () const</td></tr>
<tr class="separator:aedb2204df9f80970d1356c8e1997ca35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15fd33ac7f16cc9180854d0fd1c5d6ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a15fd33ac7f16cc9180854d0fd1c5d6ef">isFunded</a> () const</td></tr>
<tr class="separator:a15fd33ac7f16cc9180854d0fd1c5d6ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a1e5bdbacd99624d69a544b22fc3b9973"><td class="memTemplParams" colspan="2">template&lt;typename... Args&gt; </td></tr>
<tr class="memitem:a1e5bdbacd99624d69a544b22fc3b9973"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a1e5bdbacd99624d69a544b22fc3b9973">send</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:a1e5bdbacd99624d69a544b22fc3b9973"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send funds without incurring the transfer fee. <a href="classripple_1_1AMMOffer.html#a1e5bdbacd99624d69a544b22fc3b9973">More...</a><br /></td></tr>
<tr class="separator:a1e5bdbacd99624d69a544b22fc3b9973"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27aaec299811ff36f123aec975db230d"><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a27aaec299811ff36f123aec975db230d">adjustRates</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ofrInRate, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ofrOutRate)</td></tr>
<tr class="separator:a27aaec299811ff36f123aec975db230d"><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:a463950305358ecea6335e1556448024b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a>&lt; TIn, TOut &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a463950305358ecea6335e1556448024b">ammLiquidity_</a></td></tr>
<tr class="separator:a463950305358ecea6335e1556448024b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa846ce37b8941fb26fac2db78655f609"><td class="memItemLeft" align="right" valign="top">const TAmounts&lt; TIn, TOut &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#aa846ce37b8941fb26fac2db78655f609">amounts_</a></td></tr>
<tr class="separator:aa846ce37b8941fb26fac2db78655f609"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75ffe2ba285ffe0238927a12c41aef8c"><td class="memItemLeft" align="right" valign="top">const <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; TAmounts&lt; TIn, TOut &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a75ffe2ba285ffe0238927a12c41aef8c">balances_</a></td></tr>
<tr class="separator:a75ffe2ba285ffe0238927a12c41aef8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05edc64a26adef208eeeaf2c48279bfc"><td class="memItemLeft" align="right" valign="top">const Quality&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a05edc64a26adef208eeeaf2c48279bfc">quality_</a></td></tr>
<tr class="separator:a05edc64a26adef208eeeaf2c48279bfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85677b5d46747caaf83f5d97d6122d22"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMOffer.html#a85677b5d46747caaf83f5d97d6122d22">consumed_</a></td></tr>
<tr class="separator:a85677b5d46747caaf83f5d97d6122d22"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename TIn, typename TOut&gt;<br />
class ripple::AMMOffer&lt; TIn, TOut &gt;</h3>
<p>Represents synthetic AMM offer in <a class="el" href="classripple_1_1BookStep.html">BookStep</a>. </p>
<p><a class="el" href="classripple_1_1AMMOffer.html" title="Represents synthetic AMM offer in BookStep.">AMMOffer</a> mirrors <a class="el" href="classripple_1_1TOffer.html">TOffer</a> methods for use in generic <a class="el" href="classripple_1_1BookStep.html">BookStep</a> methods. <a class="el" href="classripple_1_1AMMOffer.html" title="Represents synthetic AMM offer in BookStep.">AMMOffer</a> amounts are changed indirectly in <a class="el" href="classripple_1_1BookStep.html">BookStep</a> limiting steps. </p>
<p class="definition">Definition at line <a class="el" href="AMMLiquidity_8h_source.html#l00035">35</a> of file <a class="el" href="AMMLiquidity_8h_source.html">AMMLiquidity.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2135c82cf3cb7183eeff9fe0df5d9057"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2135c82cf3cb7183eeff9fe0df5d9057">&#9670;&nbsp;</a></span>AMMOffer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::<a class="el" href="classripple_1_1AMMOffer.html">AMMOffer</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a>&lt; TIn, TOut &gt; const &amp;&#160;</td>
<td class="paramname"><em>ammLiquidity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TAmounts&lt; TIn, TOut &gt; const &amp;&#160;</td>
<td class="paramname"><em>amounts</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; TAmounts&lt; TIn, TOut &gt;&gt; const &amp;&#160;</td>
<td class="paramname"><em>balances</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Quality const &amp;&#160;</td>
<td class="paramname"><em>quality</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMOffer_8cpp_source.html#l00027">27</a> of file <a class="el" href="AMMOffer_8cpp_source.html">AMMOffer.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a486876093ae0534c3b2f6e0de734822f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a486876093ae0534c3b2f6e0de734822f">&#9670;&nbsp;</a></span>quality()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Quality <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::quality </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMOffer_8h_source.html#l00070">70</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.h</a>.</p>
</div>
</div>
<a id="ad6eff87d977b5a80f1a07660b455a6db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6eff87d977b5a80f1a07660b455a6db">&#9670;&nbsp;</a></span>issueIn()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::issueIn</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMOffer_8cpp_source.html#l00042">42</a> of file <a class="el" href="AMMOffer_8cpp_source.html">AMMOffer.cpp</a>.</p>
</div>
</div>
<a id="a1c599cad195a93f56c24975eab9728cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c599cad195a93f56c24975eab9728cc">&#9670;&nbsp;</a></span>issueOut()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::issueOut</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMOffer_8cpp_source.html#l00049">49</a> of file <a class="el" href="AMMOffer_8cpp_source.html">AMMOffer.cpp</a>.</p>
</div>
</div>
<a id="a2c97fe4fa25accdb68dc5d76a110acce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c97fe4fa25accdb68dc5d76a110acce">&#9670;&nbsp;</a></span>owner()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::owner</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMOffer_8cpp_source.html#l00056">56</a> of file <a class="el" href="AMMOffer_8cpp_source.html">AMMOffer.cpp</a>.</p>
</div>
</div>
<a id="a88753961f835cc4e516bed3598be5dc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88753961f835cc4e516bed3598be5dc3">&#9670;&nbsp;</a></span>key()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<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>&gt; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::key </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="AMMOffer_8h_source.html#l00085">85</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.h</a>.</p>
</div>
</div>
<a id="ae00679ef074c1566c961189dbe3c6768"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae00679ef074c1566c961189dbe3c6768">&#9670;&nbsp;</a></span>amount()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname">TAmounts&lt; TIn, TOut &gt; const &amp; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::amount</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMOffer_8cpp_source.html#l00063">63</a> of file <a class="el" href="AMMOffer_8cpp_source.html">AMMOffer.cpp</a>.</p>
</div>
</div>
<a id="a8856f999ea2ba636a2c74e642d4bb329"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8856f999ea2ba636a2c74e642d4bb329">&#9670;&nbsp;</a></span>consume()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::consume </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;&#160;</td>
<td class="paramname"><em>view</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TAmounts&lt; TIn, TOut &gt; const &amp;&#160;</td>
<td class="paramname"><em>consumed</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMOffer_8cpp_source.html#l00070">70</a> of file <a class="el" href="AMMOffer_8cpp_source.html">AMMOffer.cpp</a>.</p>
</div>
</div>
<a id="ad2eba1069935d7ca545125141fe44d3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2eba1069935d7ca545125141fe44d3a">&#9670;&nbsp;</a></span>fully_consumed()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::fully_consumed </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="AMMOffer_8h_source.html#l00097">97</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.h</a>.</p>
</div>
</div>
<a id="a3757f92066ba7fa0fcf4b8964b00dfa4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3757f92066ba7fa0fcf4b8964b00dfa4">&#9670;&nbsp;</a></span>limitOut()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname">TAmounts&lt; TIn, TOut &gt; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::limitOut </td>
<td>(</td>
<td class="paramtype">TAmounts&lt; TIn, TOut &gt; const &amp;&#160;</td>
<td class="paramname"><em>offrAmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TOut const &amp;&#160;</td>
<td class="paramname"><em>limit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>fixReducedOffers</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>roundUp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Limit out of the provided offer. </p>
<p>If one-path then swapOut using current balances. If multi-path then ceil_out using current quality. </p>
<p class="definition">Definition at line <a class="el" href="AMMOffer_8cpp_source.html#l00088">88</a> of file <a class="el" href="AMMOffer_8cpp_source.html">AMMOffer.cpp</a>.</p>
</div>
</div>
<a id="a47c9d8c0e8d74d833a2591b303b02c3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47c9d8c0e8d74d833a2591b303b02c3e">&#9670;&nbsp;</a></span>limitIn()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname">TAmounts&lt; TIn, TOut &gt; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::limitIn </td>
<td>(</td>
<td class="paramtype">TAmounts&lt; TIn, TOut &gt; const &amp;&#160;</td>
<td class="paramname"><em>offrAmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TIn const &amp;&#160;</td>
<td class="paramname"><em>limit</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Limit in of the provided offer. </p>
<p>If one-path then swapIn using current balances. If multi-path then ceil_in using current quality. </p>
<p class="definition">Definition at line <a class="el" href="AMMOffer_8cpp_source.html#l00118">118</a> of file <a class="el" href="AMMOffer_8cpp_source.html">AMMOffer.cpp</a>.</p>
</div>
</div>
<a id="aedb2204df9f80970d1356c8e1997ca35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedb2204df9f80970d1356c8e1997ca35">&#9670;&nbsp;</a></span>getQualityFunc()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1QualityFunction.html">QualityFunction</a> <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::getQualityFunc</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMOffer_8cpp_source.html#l00130">130</a> of file <a class="el" href="AMMOffer_8cpp_source.html">AMMOffer.cpp</a>.</p>
</div>
</div>
<a id="a1e5bdbacd99624d69a544b22fc3b9973"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e5bdbacd99624d69a544b22fc3b9973">&#9670;&nbsp;</a></span>send()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<div class="memtemplate">
template&lt;typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::send </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Send funds without incurring the transfer fee. </p>
<p class="definition">Definition at line <a class="el" href="AMMOffer_8h_source.html#l00127">127</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.h</a>.</p>
</div>
</div>
<a id="a15fd33ac7f16cc9180854d0fd1c5d6ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15fd33ac7f16cc9180854d0fd1c5d6ef">&#9670;&nbsp;</a></span>isFunded()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::isFunded </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="AMMOffer_8h_source.html#l00133">133</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.h</a>.</p>
</div>
</div>
<a id="a27aaec299811ff36f123aec975db230d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27aaec299811ff36f123aec975db230d">&#9670;&nbsp;</a></span>adjustRates()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&gt; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::adjustRates </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>ofrInRate</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>ofrOutRate</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMOffer_8h_source.html#l00140">140</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a463950305358ecea6335e1556448024b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a463950305358ecea6335e1556448024b">&#9670;&nbsp;</a></span>ammLiquidity_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1AMMLiquidity.html">AMMLiquidity</a>&lt;TIn, TOut&gt; const&amp; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::ammLiquidity_</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="AMMOffer_8h_source.html#l00042">42</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.h</a>.</p>
</div>
</div>
<a id="aa846ce37b8941fb26fac2db78655f609"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa846ce37b8941fb26fac2db78655f609">&#9670;&nbsp;</a></span>amounts_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const TAmounts&lt;TIn, TOut&gt; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::amounts_</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="AMMOffer_8h_source.html#l00052">52</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.h</a>.</p>
</div>
</div>
<a id="a75ffe2ba285ffe0238927a12c41aef8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75ffe2ba285ffe0238927a12c41aef8c">&#9670;&nbsp;</a></span>balances_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;TAmounts&lt;TIn, TOut&gt; &gt; <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::balances_</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="AMMOffer_8h_source.html#l00055">55</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.h</a>.</p>
</div>
</div>
<a id="a05edc64a26adef208eeeaf2c48279bfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05edc64a26adef208eeeaf2c48279bfc">&#9670;&nbsp;</a></span>quality_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const Quality <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::quality_</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="AMMOffer_8h_source.html#l00058">58</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.h</a>.</p>
</div>
</div>
<a id="a85677b5d46747caaf83f5d97d6122d22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85677b5d46747caaf83f5d97d6122d22">&#9670;&nbsp;</a></span>consumed_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TIn , typename TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1AMMOffer.html">ripple::AMMOffer</a>&lt; TIn, TOut &gt;::consumed_</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="AMMOffer_8h_source.html#l00060">60</a> of file <a class="el" href="AMMOffer_8h_source.html">AMMOffer.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