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

deploy: dc8b37a524

Browse Source
This commit is contained in:
bthomee
2025-09-18 08:15:26 -07:00
parent 566976e9d7
commit 099ba7da4d
500 changed files with 25758 additions and 25596 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
classripple_1_1TOffer.html
View File

@@ -249,7 +249,7 @@ Private Attributes</h2></td></tr>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class TIn = STAmount, class TOut = STAmount&gt;<br />
class ripple::TOffer&lt; TIn, TOut &gt;</div>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00052">52</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00051">51</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1571dc42015780b1f496a084363c47d1" name="a1571dc42015780b1f496a084363c47d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1571dc42015780b1f496a084363c47d1">&#9670;&#160;</a></span>TOffer() <span class="overload">[1/3]</span></h2>
@@ -306,7 +306,7 @@ template&lt;class TIn , class TOut &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00199">199</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00198">198</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -336,7 +336,7 @@ template&lt;class TIn , class TOut &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00213">213</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00212">212</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -366,7 +366,7 @@ template&lt;class TIn , class TOut &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00227">227</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00226">226</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -398,7 +398,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
<p>Returns the quality of the offer. </p>
<p>Conceptually, the quality is the ratio of output to input currency. The implementation calculates it as the ratio of input to output currency (so it sorts ascending). The quality is computed at the time the offer is placed, and never changes for the lifetime of the offer. This is an important business rule that maintains accuracy when an offer is partially filled; Subsequent partial fills will use the original quality. </p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00078">78</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00077">77</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -421,7 +421,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
<p>Returns the account id of the offer's owner. </p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00085">85</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00084">84</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -445,7 +445,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
<p>Returns the in and out amounts. </p>
<p>Some or all of the out amount may be unfunded. </p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00094">94</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00093">93</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -468,7 +468,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
<p>Returns <code>true</code> if no more funds can flow through this offer. </p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00101">101</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00100">100</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -502,7 +502,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
<p>Adjusts the offer to indicate that we consumed some (or all) of it. </p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00112">112</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00111">111</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -523,7 +523,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00126">126</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00125">125</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -544,7 +544,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00132">132</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00131">131</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -565,7 +565,7 @@ template&lt;class TIn , class TOut &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00312">312</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00311">311</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -586,7 +586,7 @@ template&lt;class TIn , class TOut &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00326">326</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00325">325</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -624,7 +624,7 @@ template&lt;class TIn , class TOut &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00238">238</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00237">237</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -662,7 +662,7 @@ template&lt;class TIn , class TOut &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00255">255</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00254">254</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -694,7 +694,7 @@ template&lt;typename... Args&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00273">273</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00272">272</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -715,7 +715,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00157">157</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00156">156</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -755,7 +755,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00164">164</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00163">163</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -790,7 +790,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
<p>Check any required invariant. </p>
<p>Limit order book offer always returns true. </p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00174">174</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00173">173</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -817,7 +817,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00280">280</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00279">279</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -844,7 +844,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00288">288</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00287">287</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -871,7 +871,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00296">296</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00295">295</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -898,7 +898,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00304">304</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00303">303</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -917,7 +917,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00319">319</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00318">318</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -936,7 +936,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00333">333</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00332">332</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -963,7 +963,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00055">55</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00054">54</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -989,7 +989,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00056">56</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00055">55</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -1015,7 +1015,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00057">57</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00056">56</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -1041,7 +1041,7 @@ template&lt;class TIn = STAmount, class TOut = STAmount&gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00059">59</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00058">58</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -1067,7 +1067,7 @@ template&lt;class TIn , class TOut &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00040">40</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00039">39</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>
@@ -1093,7 +1093,7 @@ template&lt;class TIn , class TOut &gt; </div>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00041">41</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Offer_8h_source.html#l00040">40</a> of file <a class="el" href="Offer_8h_source.html">Offer.h</a>.</p>
</div>
</div>