Files
rippled/classbeast_1_1unit__test_1_1amount.html
2025-11-04 00:36:48 -08:00

311 lines
16 KiB
HTML

<!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: beast::unit_test::amount 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="namespacebeast.html">beast</a></li><li class="navelem"><a class="el" href="namespacebeast_1_1unit__test.html">unit_test</a></li><li class="navelem"><a class="el" href="classbeast_1_1unit__test_1_1amount.html">amount</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classbeast_1_1unit__test_1_1amount-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">beast::unit_test::amount Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Utility for producing nicely composed output of amounts with units.
<a href="classbeast_1_1unit__test_1_1amount.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="include_2xrpl_2beast_2unit__test_2amount_8h_source.html">amount.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for beast::unit_test::amount:</div>
<div class="dyncontent">
<div class="center"><img src="classbeast_1_1unit__test_1_1amount__coll__graph.png" border="0" usemap="#abeast_1_1unit__test_1_1amount_coll__map" alt="Collaboration graph"/></div>
<map name="abeast_1_1unit__test_1_1amount_coll__map" id="abeast_1_1unit__test_1_1amount_coll__map">
<area shape="rect" title="Utility for producing nicely composed output of amounts with units." alt="" coords="5,183,187,208"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="27,95,115,120"/>
<area shape="poly" title=" " alt="" coords="81,133,95,181,90,183,75,134"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="139,95,226,120"/>
<area shape="poly" title=" " alt="" coords="163,131,110,184,106,180,160,128"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="113,5,252,45"/>
<area shape="poly" title=" " alt="" coords="185,59,185,94,180,94,180,59"/>
</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:aec631b4d5e8a3b6b9ce082cded0767c1" id="r_aec631b4d5e8a3b6b9ce082cded0767c1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1unit__test_1_1amount.html#aec631b4d5e8a3b6b9ce082cded0767c1">amount</a> (<a class="el" href="classbeast_1_1unit__test_1_1amount.html">amount</a> const &amp;)=default</td></tr>
<tr class="separator:aec631b4d5e8a3b6b9ce082cded0767c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4e645402924058956bc081cb7adadf3" id="r_ac4e645402924058956bc081cb7adadf3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1unit__test_1_1amount.html">amount</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1unit__test_1_1amount.html#ac4e645402924058956bc081cb7adadf3">operator=</a> (<a class="el" href="classbeast_1_1unit__test_1_1amount.html">amount</a> const &amp;)=delete</td></tr>
<tr class="separator:ac4e645402924058956bc081cb7adadf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a927948d1a9197faeec295ea41a7a5777" id="r_a927948d1a9197faeec295ea41a7a5777"><td class="memTemplParams" colspan="2">template&lt;class = void&gt; </td></tr>
<tr class="memitem:a927948d1a9197faeec295ea41a7a5777"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbeast_1_1unit__test_1_1amount.html#a927948d1a9197faeec295ea41a7a5777">amount</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> n, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;what)</td></tr>
<tr class="separator:a927948d1a9197faeec295ea41a7a5777"><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:adb7ecad4a07203acf7bf91d9eec474f8" id="r_adb7ecad4a07203acf7bf91d9eec474f8"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1unit__test_1_1amount.html#adb7ecad4a07203acf7bf91d9eec474f8">n_</a></td></tr>
<tr class="separator:adb7ecad4a07203acf7bf91d9eec474f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41ccfdde8dd461585131591763e382ee" id="r_a41ccfdde8dd461585131591763e382ee"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1unit__test_1_1amount.html#a41ccfdde8dd461585131591763e382ee">what_</a></td></tr>
<tr class="separator:a41ccfdde8dd461585131591763e382ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a4da24c30c34953a0bb80796bc668e0e9" id="r_a4da24c30c34953a0bb80796bc668e0e9"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1unit__test_1_1amount.html#a4da24c30c34953a0bb80796bc668e0e9">operator&lt;&lt;</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &amp;s, <a class="el" href="classbeast_1_1unit__test_1_1amount.html">amount</a> const &amp;t)</td></tr>
<tr class="separator:a4da24c30c34953a0bb80796bc668e0e9"><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>Utility for producing nicely composed output of amounts with units. </p>
<p class="definition">Definition at line <a class="el" href="include_2xrpl_2beast_2unit__test_2amount_8h_source.html#l00016">16</a> of file <a class="el" href="include_2xrpl_2beast_2unit__test_2amount_8h_source.html">include/xrpl/beast/unit_test/amount.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aec631b4d5e8a3b6b9ce082cded0767c1" name="aec631b4d5e8a3b6b9ce082cded0767c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec631b4d5e8a3b6b9ce082cded0767c1">&#9670;&#160;</a></span>amount() <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">beast::unit_test::amount::amount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1unit__test_1_1amount.html">amount</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">
</div>
</div>
<a id="a927948d1a9197faeec295ea41a7a5777" name="a927948d1a9197faeec295ea41a7a5777"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a927948d1a9197faeec295ea41a7a5777">&#9670;&#160;</a></span>amount() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class &gt; </div>
<table class="memname">
<tr>
<td class="memname">beast::unit_test::amount::amount </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>what</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="include_2xrpl_2beast_2unit__test_2amount_8h_source.html#l00035">35</a> of file <a class="el" href="include_2xrpl_2beast_2unit__test_2amount_8h_source.html">include/xrpl/beast/unit_test/amount.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac4e645402924058956bc081cb7adadf3" name="ac4e645402924058956bc081cb7adadf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4e645402924058956bc081cb7adadf3">&#9670;&#160;</a></span>operator=()</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="classbeast_1_1unit__test_1_1amount.html">amount</a> &amp; beast::unit_test::amount::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1unit__test_1_1amount.html">amount</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">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a4da24c30c34953a0bb80796bc668e0e9" name="a4da24c30c34953a0bb80796bc668e0e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4da24c30c34953a0bb80796bc668e0e9">&#9670;&#160;</a></span>operator&lt;&lt;</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/io/basic_ostream.html">std::ostream</a> &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &amp;&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1unit__test_1_1amount.html">amount</a> const &amp;&#160;</td>
<td class="paramname"><em>t</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">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="include_2xrpl_2beast_2unit__test_2amount_8h_source.html#l00039">39</a> of file <a class="el" href="include_2xrpl_2beast_2unit__test_2amount_8h_source.html">include/xrpl/beast/unit_test/amount.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adb7ecad4a07203acf7bf91d9eec474f8" name="adb7ecad4a07203acf7bf91d9eec474f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb7ecad4a07203acf7bf91d9eec474f8">&#9670;&#160;</a></span>n_</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/size_t.html">std::size_t</a> beast::unit_test::amount::n_</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="include_2xrpl_2beast_2unit__test_2amount_8h_source.html#l00019">19</a> of file <a class="el" href="include_2xrpl_2beast_2unit__test_2amount_8h_source.html">include/xrpl/beast/unit_test/amount.h</a>.</p>
</div>
</div>
<a id="a41ccfdde8dd461585131591763e382ee" name="a41ccfdde8dd461585131591763e382ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41ccfdde8dd461585131591763e382ee">&#9670;&#160;</a></span>what_</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/string/basic_string.html">std::string</a> const&amp; beast::unit_test::amount::what_</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="include_2xrpl_2beast_2unit__test_2amount_8h_source.html#l00020">20</a> of file <a class="el" href="include_2xrpl_2beast_2unit__test_2amount_8h_source.html">include/xrpl/beast/unit_test/amount.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>