ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1Book.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

292 lines
16 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::Book 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 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="classripple_1_1Book.html">Book</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-static-methods">Static Private Member Functions</a> &#124;
<a href="classripple_1_1Book-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Book Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Specifies an order book.
<a href="classripple_1_1Book.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Book_8h_source.html">Book.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::Book:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Book__inherit__graph.png" border="0" usemap="#aripple_1_1Book_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1Book_inherit__map" id="aripple_1_1Book_inherit__map">
<area shape="rect" title="Specifies an order book." alt="" coords="37,93,137,119"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="5,5,168,45"/>
<area shape="poly" title=" " alt="" coords="89,59,89,93,84,93,84,59"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::Book:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Book__coll__graph.png" border="0" usemap="#aripple_1_1Book_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1Book_coll__map" id="aripple_1_1Book_coll__map">
<area shape="rect" title="Specifies an order book." alt="" coords="1067,70,1167,95"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="803,5,965,45"/>
<area shape="poly" title=" " alt="" coords="980,32,1043,45,1094,67,1092,72,1042,51,979,37"/>
<area shape="rect" href="classripple_1_1Issue.html" title="A currency issued by an account." alt="" coords="833,70,935,95"/>
<area shape="poly" title=" " alt="" coords="948,80,1066,80,1066,85,948,85"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="491,33,689,73"/>
<area shape="poly" title=" " alt="" coords="704,62,833,75,833,80,703,67"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,43,349,69"/>
<area shape="poly" title=" " alt="" coords="362,42,413,36,490,37,490,42,413,41,363,48"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="487,97,693,137"/>
<area shape="poly" title=" " alt="" coords="363,66,497,95,496,100,362,71"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,109,389,149"/>
<area shape="poly" title=" " alt="" coords="402,124,433,118,461,107,473,96,485,83,509,71,512,76,488,87,477,100,464,112,434,123,403,130"/>
<area shape="poly" title=" " alt="" coords="382,150,414,156,438,158,462,156,502,147,539,135,541,140,503,152,463,161,438,164,413,161,381,155"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,117,108,142"/>
<area shape="poly" title=" " alt="" coords="122,127,221,127,221,132,122,132"/>
<area shape="poly" title=" " alt="" coords="707,101,833,86,834,91,707,106"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="807,120,961,160"/>
<area shape="poly" title=" " alt="" coords="974,117,1042,100,1069,93,1071,98,1043,105,976,122"/>
</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:a11abcc0ea010a3f83ff56ca2c6e47427" id="r_a11abcc0ea010a3f83ff56ca2c6e47427"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Book.html#a11abcc0ea010a3f83ff56ca2c6e47427">Book</a> ()</td></tr>
<tr class="separator:a11abcc0ea010a3f83ff56ca2c6e47427"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb02fe8ca21be2fcd7fb096ebc69c85c" id="r_afb02fe8ca21be2fcd7fb096ebc69c85c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Book.html#afb02fe8ca21be2fcd7fb096ebc69c85c">Book</a> (<a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;in_, <a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;out_, <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; const &amp;domain_)</td></tr>
<tr class="separator:afb02fe8ca21be2fcd7fb096ebc69c85c"><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:a44f1acfd1d549e7f025f5372fb345f27" id="r_a44f1acfd1d549e7f025f5372fb345f27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Issue.html">Issue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Book.html#a44f1acfd1d549e7f025f5372fb345f27">in</a></td></tr>
<tr class="separator:a44f1acfd1d549e7f025f5372fb345f27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6992e8a5da385182ec3ab51a0216281a" id="r_a6992e8a5da385182ec3ab51a0216281a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Issue.html">Issue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Book.html#a6992e8a5da385182ec3ab51a0216281a">out</a></td></tr>
<tr class="separator:a6992e8a5da385182ec3ab51a0216281a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaee2f080506ecd7aff540356f37ef4a2" id="r_aaee2f080506ecd7aff540356f37ef4a2"><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_1Book.html#aaee2f080506ecd7aff540356f37ef4a2">domain</a></td></tr>
<tr class="separator:aaee2f080506ecd7aff540356f37ef4a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-methods" name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:ae60d6cae0e97e9f17c93945feca09fb5" id="r_ae60d6cae0e97e9f17c93945feca09fb5"><td class="memItemLeft" align="right" valign="top">static auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1CountedObject.html#ae60d6cae0e97e9f17c93945feca09fb5">getCounter</a> () noexcept</td></tr>
<tr class="separator:ae60d6cae0e97e9f17c93945feca09fb5"><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>Specifies an order book. </p>
<p>The order book is a pair of Issues called in and out. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Book_8h_source.html#l00016">16</a> of file <a class="el" href="Book_8h_source.html">Book.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a11abcc0ea010a3f83ff56ca2c6e47427" name="a11abcc0ea010a3f83ff56ca2c6e47427"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11abcc0ea010a3f83ff56ca2c6e47427">&#9670;&#160;</a></span>Book() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::Book::Book </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Book_8h_source.html#l00023">23</a> of file <a class="el" href="Book_8h_source.html">Book.h</a>.</p>
</div>
</div>
<a id="afb02fe8ca21be2fcd7fb096ebc69c85c" name="afb02fe8ca21be2fcd7fb096ebc69c85c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb02fe8ca21be2fcd7fb096ebc69c85c">&#9670;&#160;</a></span>Book() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::Book::Book </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;&#160;</td>
<td class="paramname"><em>in_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;&#160;</td>
<td class="paramname"><em>out_</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; <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>domain_</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="Book_8h_source.html#l00027">27</a> of file <a class="el" href="Book_8h_source.html">Book.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae60d6cae0e97e9f17c93945feca09fb5" name="ae60d6cae0e97e9f17c93945feca09fb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae60d6cae0e97e9f17c93945feca09fb5">&#9670;&#160;</a></span>getCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static auto &amp; <a class="el" href="classripple_1_1CountedObject.html">ripple::CountedObject</a>&lt; <a class="el" href="classripple_1_1Book.html">Book</a> &gt;::getCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span><span class="mlabel">noexcept</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="CountedObject_8h_source.html#l00110">110</a> of file <a class="el" href="CountedObject_8h_source.html">CountedObject.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a44f1acfd1d549e7f025f5372fb345f27" name="a44f1acfd1d549e7f025f5372fb345f27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44f1acfd1d549e7f025f5372fb345f27">&#9670;&#160;</a></span>in</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Issue.html">Issue</a> ripple::Book::in</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Book_8h_source.html#l00019">19</a> of file <a class="el" href="Book_8h_source.html">Book.h</a>.</p>
</div>
</div>
<a id="a6992e8a5da385182ec3ab51a0216281a" name="a6992e8a5da385182ec3ab51a0216281a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6992e8a5da385182ec3ab51a0216281a">&#9670;&#160;</a></span>out</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Issue.html">Issue</a> ripple::Book::out</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Book_8h_source.html#l00020">20</a> of file <a class="el" href="Book_8h_source.html">Book.h</a>.</p>
</div>
</div>
<a id="aaee2f080506ecd7aff540356f37ef4a2" name="aaee2f080506ecd7aff540356f37ef4a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaee2f080506ecd7aff540356f37ef4a2">&#9670;&#160;</a></span>domain</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>&gt; ripple::Book::domain</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Book_8h_source.html#l00021">21</a> of file <a class="el" href="Book_8h_source.html">Book.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