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
e2b7ef418d04a83b54b764be575c4400ca8e6dac
rippled/classripple_1_1Issue.html
bthomee e61ca37029 deploy: eac3abdca9
2025-01-21 19:58:08 +00:00

351 lines
18 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" 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::Issue 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.5 -->
<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_1Issue.html">Issue</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="#friends">Friends</a> &#124;
<a href="classripple_1_1Issue-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Issue Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A currency issued by an account.
<a href="classripple_1_1Issue.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Issue_8h_source.html">Issue.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::Issue:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Issue__coll__graph.png" border="0" usemap="#aripple_1_1Issue_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1Issue_coll__map" id="aripple_1_1Issue_coll__map">
<area shape="rect" title="A currency issued by an account." alt="" coords="803,69,904,94"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="491,29,689,69"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,39,349,65"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="487,93,693,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,105,389,145"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,113,108,138"/>
</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:ab56795de9a4a19f91c2a8129de991b8b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Issue.html#ab56795de9a4a19f91c2a8129de991b8b">Issue</a> ()=default</td></tr>
<tr class="separator:ab56795de9a4a19f91c2a8129de991b8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca4fa5e360c85db5e4764cadd3aef887"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Issue.html#aca4fa5e360c85db5e4764cadd3aef887">Issue</a> (<a class="el" href="namespaceripple.html#a8792cc3f99463ceba4e96dde34fe17a4">Currency</a> const &amp;c, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;a)</td></tr>
<tr class="separator:aca4fa5e360c85db5e4764cadd3aef887"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a564723bf4d14d6991f8e039e0be58c19"><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_1Issue.html#a564723bf4d14d6991f8e039e0be58c19">getIssuer</a> () const</td></tr>
<tr class="separator:a564723bf4d14d6991f8e039e0be58c19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e58e7c6ac6ca280fa330040b32707ea"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Issue.html#a2e58e7c6ac6ca280fa330040b32707ea">getText</a> () const</td></tr>
<tr class="separator:a2e58e7c6ac6ca280fa330040b32707ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6801cdebb9eaf7cfd7d1ec83eb9ab82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Issue.html#ac6801cdebb9eaf7cfd7d1ec83eb9ab82">setJson</a> (<a class="el" href="classJson_1_1Value.html">Json::Value</a> &amp;jv) const</td></tr>
<tr class="separator:ac6801cdebb9eaf7cfd7d1ec83eb9ab82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8615e07409164d6d0a8084879ad7bc8c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Issue.html#a8615e07409164d6d0a8084879ad7bc8c">native</a> () const</td></tr>
<tr class="separator:a8615e07409164d6d0a8084879ad7bc8c"><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:a4b723aa4198e4c630e41de06586e2fe7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a8792cc3f99463ceba4e96dde34fe17a4">Currency</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Issue.html#a4b723aa4198e4c630e41de06586e2fe7">currency</a> {}</td></tr>
<tr class="separator:a4b723aa4198e4c630e41de06586e2fe7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46e4805870b1bad6a8691bed0b8acec8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Issue.html#a46e4805870b1bad6a8691bed0b8acec8">account</a> {}</td></tr>
<tr class="separator:a46e4805870b1bad6a8691bed0b8acec8"><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:a3edf46768bac088826323eb875ee228a"><td class="memItemLeft" align="right" valign="top">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/compare/weak_ordering.html">std::weak_ordering</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Issue.html#a3edf46768bac088826323eb875ee228a">operator&lt;=&gt;</a> (<a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;lhs, <a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;rhs)</td></tr>
<tr class="memdesc:a3edf46768bac088826323eb875ee228a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Strict weak ordering. <a href="classripple_1_1Issue.html#a3edf46768bac088826323eb875ee228a">More...</a><br /></td></tr>
<tr class="separator:a3edf46768bac088826323eb875ee228a"><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 >A currency issued by an account. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceripple.html#a8792cc3f99463ceba4e96dde34fe17a4" title="Currency is a hash representing a specific currency.">Currency</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284" title="A 160-bit unsigned that uniquely identifies an account.">AccountID</a>, <a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a>, <a class="el" href="classripple_1_1Book.html" title="Specifies an order book.">Book</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="Issue_8h_source.html#l00035">35</a> of file <a class="el" href="Issue_8h_source.html">Issue.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab56795de9a4a19f91c2a8129de991b8b" name="ab56795de9a4a19f91c2a8129de991b8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab56795de9a4a19f91c2a8129de991b8b">&#9670;&#160;</a></span>Issue() <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">ripple::Issue::Issue </td>
<td>(</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="aca4fa5e360c85db5e4764cadd3aef887" name="aca4fa5e360c85db5e4764cadd3aef887"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca4fa5e360c85db5e4764cadd3aef887">&#9670;&#160;</a></span>Issue() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::Issue::Issue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a8792cc3f99463ceba4e96dde34fe17a4">Currency</a> const &amp;&#160;</td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;&#160;</td>
<td class="paramname"><em>a</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="Issue_8h_source.html#l00043">43</a> of file <a class="el" href="Issue_8h_source.html">Issue.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a564723bf4d14d6991f8e039e0be58c19" name="a564723bf4d14d6991f8e039e0be58c19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a564723bf4d14d6991f8e039e0be58c19">&#9670;&#160;</a></span>getIssuer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp; ripple::Issue::getIssuer </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="Issue_8h_source.html#l00048">48</a> of file <a class="el" href="Issue_8h_source.html">Issue.h</a>.</p>
</div>
</div>
<a id="a2e58e7c6ac6ca280fa330040b32707ea" name="a2e58e7c6ac6ca280fa330040b32707ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e58e7c6ac6ca280fa330040b32707ea">&#9670;&#160;</a></span>getText()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::Issue::getText </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="Issue_8cpp_source.html#l00030">30</a> of file <a class="el" href="Issue_8cpp_source.html">Issue.cpp</a>.</p>
</div>
</div>
<a id="ac6801cdebb9eaf7cfd7d1ec83eb9ab82" name="ac6801cdebb9eaf7cfd7d1ec83eb9ab82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6801cdebb9eaf7cfd7d1ec83eb9ab82">&#9670;&#160;</a></span>setJson()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::Issue::setJson </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classJson_1_1Value.html">Json::Value</a> &amp;&#160;</td>
<td class="paramname"><em>jv</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Issue_8cpp_source.html#l00053">53</a> of file <a class="el" href="Issue_8cpp_source.html">Issue.cpp</a>.</p>
</div>
</div>
<a id="a8615e07409164d6d0a8084879ad7bc8c" name="a8615e07409164d6d0a8084879ad7bc8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8615e07409164d6d0a8084879ad7bc8c">&#9670;&#160;</a></span>native()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::Issue::native </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="Issue_8cpp_source.html#l00061">61</a> of file <a class="el" href="Issue_8cpp_source.html">Issue.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a3edf46768bac088826323eb875ee228a" name="a3edf46768bac088826323eb875ee228a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3edf46768bac088826323eb875ee228a">&#9670;&#160;</a></span>operator&lt;=&gt;</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/compare/weak_ordering.html">std::weak_ordering</a> operator&lt;=&gt; </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;&#160;</td>
<td class="paramname"><em>lhs</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>rhs</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>Strict weak ordering. </p>
<p class="definition">Definition at line <a class="el" href="Issue_8h_source.html#l00101">101</a> of file <a class="el" href="Issue_8h_source.html">Issue.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a4b723aa4198e4c630e41de06586e2fe7" name="a4b723aa4198e4c630e41de06586e2fe7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b723aa4198e4c630e41de06586e2fe7">&#9670;&#160;</a></span>currency</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a8792cc3f99463ceba4e96dde34fe17a4">Currency</a> ripple::Issue::currency {}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Issue_8h_source.html#l00038">38</a> of file <a class="el" href="Issue_8h_source.html">Issue.h</a>.</p>
</div>
</div>
<a id="a46e4805870b1bad6a8691bed0b8acec8" name="a46e4805870b1bad6a8691bed0b8acec8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46e4805870b1bad6a8691bed0b8acec8">&#9670;&#160;</a></span>account</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> ripple::Issue::account {}</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Issue_8h_source.html#l00039">39</a> of file <a class="el" href="Issue_8h_source.html">Issue.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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink