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
f42ca4239534b42d7f4542459b491656b71e9c6c
rippled/classripple_1_1Resource_1_1Charge.html
manojsdoshi 430f6c0cf3 deploy: 023f5704d0
2020-04-24 01:09:47 +00:00

367 lines
20 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::Resource::Charge 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 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="namespaceripple_1_1Resource.html">Resource</a></li><li class="navelem"><a class="el" href="classripple_1_1Resource_1_1Charge.html">Charge</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1Resource_1_1Charge-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::Resource::Charge Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A consumption charge.
<a href="classripple_1_1Resource_1_1Charge.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::Resource::Charge:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Resource_1_1Charge__coll__graph.png" border="0" usemap="#ripple_1_1Resource_1_1Charge_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1Resource_1_1Charge_coll__map" id="ripple_1_1Resource_1_1Charge_coll__map">
<area shape="rect" title="A consumption charge." alt="" coords="5,95,185,121"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="52,5,139,32"/>
</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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a02d387c2cf9ed17fa6d471598124564e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Charge.html#a02d387c2cf9ed17fa6d471598124564e">value_type</a> = int</td></tr>
<tr class="memdesc:a02d387c2cf9ed17fa6d471598124564e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type used to hold a consumption charge. <a href="classripple_1_1Resource_1_1Charge.html#a02d387c2cf9ed17fa6d471598124564e">More...</a><br /></td></tr>
<tr class="separator:a02d387c2cf9ed17fa6d471598124564e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a04d85fef4ef9303613d555b47a887efb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Charge.html#a04d85fef4ef9303613d555b47a887efb">Charge</a> ()=delete</td></tr>
<tr class="separator:a04d85fef4ef9303613d555b47a887efb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11be2f5c54abb54b6afca31c46b17998"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Charge.html#a11be2f5c54abb54b6afca31c46b17998">Charge</a> (<a class="el" href="classripple_1_1Resource_1_1Charge.html#a02d387c2cf9ed17fa6d471598124564e">value_type</a> <a class="el" href="classripple_1_1Resource_1_1Charge.html#abeec2cf87ea2c1afd5b33135dfa6253d">cost</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;<a class="el" href="classripple_1_1Resource_1_1Charge.html#af1fc12f3893b6cd6eed0dc343678c87a">label</a>=<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>())</td></tr>
<tr class="memdesc:a11be2f5c54abb54b6afca31c46b17998"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a charge with the specified cost and name. <a href="classripple_1_1Resource_1_1Charge.html#a11be2f5c54abb54b6afca31c46b17998">More...</a><br /></td></tr>
<tr class="separator:a11be2f5c54abb54b6afca31c46b17998"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1fc12f3893b6cd6eed0dc343678c87a"><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="classripple_1_1Resource_1_1Charge.html#af1fc12f3893b6cd6eed0dc343678c87a">label</a> () const</td></tr>
<tr class="memdesc:af1fc12f3893b6cd6eed0dc343678c87a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the human readable label associated with the charge. <a href="classripple_1_1Resource_1_1Charge.html#af1fc12f3893b6cd6eed0dc343678c87a">More...</a><br /></td></tr>
<tr class="separator:af1fc12f3893b6cd6eed0dc343678c87a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeec2cf87ea2c1afd5b33135dfa6253d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Resource_1_1Charge.html#a02d387c2cf9ed17fa6d471598124564e">value_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Charge.html#abeec2cf87ea2c1afd5b33135dfa6253d">cost</a> () const</td></tr>
<tr class="memdesc:abeec2cf87ea2c1afd5b33135dfa6253d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the cost of the charge in <a class="el" href="classripple_1_1Resource_1_1Manager.html" title="Tracks load and resource consumption.">Resource::Manager</a> units. <a href="classripple_1_1Resource_1_1Charge.html#abeec2cf87ea2c1afd5b33135dfa6253d">More...</a><br /></td></tr>
<tr class="separator:abeec2cf87ea2c1afd5b33135dfa6253d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ed6361d00000cc6124f397f1cc44d0c"><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_1Resource_1_1Charge.html#a9ed6361d00000cc6124f397f1cc44d0c">to_string</a> () const</td></tr>
<tr class="memdesc:a9ed6361d00000cc6124f397f1cc44d0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts this charge into a human readable string. <a href="classripple_1_1Resource_1_1Charge.html#a9ed6361d00000cc6124f397f1cc44d0c">More...</a><br /></td></tr>
<tr class="separator:a9ed6361d00000cc6124f397f1cc44d0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9f99ebbb67d9b6cf29969d8e1375015"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Charge.html#ab9f99ebbb67d9b6cf29969d8e1375015">operator==</a> (<a class="el" href="classripple_1_1Resource_1_1Charge.html">Charge</a> const &amp;) const</td></tr>
<tr class="separator:ab9f99ebbb67d9b6cf29969d8e1375015"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae432bd9acca60d91b4e015b1085ecd33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Charge.html#ae432bd9acca60d91b4e015b1085ecd33">operator!=</a> (<a class="el" href="classripple_1_1Resource_1_1Charge.html">Charge</a> const &amp;) const</td></tr>
<tr class="separator:ae432bd9acca60d91b4e015b1085ecd33"><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:a76f96fec41e05a79d17e57a126cf3dd5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Resource_1_1Charge.html#a02d387c2cf9ed17fa6d471598124564e">value_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Resource_1_1Charge.html#a76f96fec41e05a79d17e57a126cf3dd5">m_cost</a></td></tr>
<tr class="separator:a76f96fec41e05a79d17e57a126cf3dd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a34078ac9bc264c2788f56a756467d9"><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_1Resource_1_1Charge.html#a2a34078ac9bc264c2788f56a756467d9">m_label</a></td></tr>
<tr class="separator:a2a34078ac9bc264c2788f56a756467d9"><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 consumption charge. </p>
<p class="definition">Definition at line <a class="el" href="Charge_8h_source.html#l00030">30</a> of file <a class="el" href="Charge_8h_source.html">Charge.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a02d387c2cf9ed17fa6d471598124564e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02d387c2cf9ed17fa6d471598124564e">&#9670;&nbsp;</a></span>value_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1Resource_1_1Charge.html#a02d387c2cf9ed17fa6d471598124564e">ripple::Resource::Charge::value_type</a> = int</td>
</tr>
</table>
</div><div class="memdoc">
<p>The type used to hold a consumption charge. </p>
<p class="definition">Definition at line <a class="el" href="Charge_8h_source.html#l00034">34</a> of file <a class="el" href="Charge_8h_source.html">Charge.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a04d85fef4ef9303613d555b47a887efb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04d85fef4ef9303613d555b47a887efb">&#9670;&nbsp;</a></span>Charge() <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::Resource::Charge::Charge </td>
<td>(</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>
<a id="a11be2f5c54abb54b6afca31c46b17998"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11be2f5c54abb54b6afca31c46b17998">&#9670;&nbsp;</a></span>Charge() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::Resource::Charge::Charge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Resource_1_1Charge.html#a02d387c2cf9ed17fa6d471598124564e">value_type</a>&#160;</td>
<td class="paramname"><em>cost</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>label</em> = <code><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>()</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a charge with the specified cost and name. </p>
<p class="definition">Definition at line <a class="el" href="Charge_8cpp_source.html#l00026">26</a> of file <a class="el" href="Charge_8cpp_source.html">Charge.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af1fc12f3893b6cd6eed0dc343678c87a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1fc12f3893b6cd6eed0dc343678c87a">&#9670;&nbsp;</a></span>label()</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> const &amp; ripple::Resource::Charge::label </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the human readable label associated with the charge. </p>
<p class="definition">Definition at line <a class="el" href="Charge_8cpp_source.html#l00032">32</a> of file <a class="el" href="Charge_8cpp_source.html">Charge.cpp</a>.</p>
</div>
</div>
<a id="abeec2cf87ea2c1afd5b33135dfa6253d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeec2cf87ea2c1afd5b33135dfa6253d">&#9670;&nbsp;</a></span>cost()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Resource_1_1Charge.html#a02d387c2cf9ed17fa6d471598124564e">Charge::value_type</a> ripple::Resource::Charge::cost </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the cost of the charge in <a class="el" href="classripple_1_1Resource_1_1Manager.html" title="Tracks load and resource consumption.">Resource::Manager</a> units. </p>
<p class="definition">Definition at line <a class="el" href="Charge_8cpp_source.html#l00038">38</a> of file <a class="el" href="Charge_8cpp_source.html">Charge.cpp</a>.</p>
</div>
</div>
<a id="a9ed6361d00000cc6124f397f1cc44d0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ed6361d00000cc6124f397f1cc44d0c">&#9670;&nbsp;</a></span>to_string()</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::Resource::Charge::to_string </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts this charge into a human readable string. </p>
<p class="definition">Definition at line <a class="el" href="Charge_8cpp_source.html#l00044">44</a> of file <a class="el" href="Charge_8cpp_source.html">Charge.cpp</a>.</p>
</div>
</div>
<a id="ab9f99ebbb67d9b6cf29969d8e1375015"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9f99ebbb67d9b6cf29969d8e1375015">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::Resource::Charge::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Resource_1_1Charge.html">Charge</a> const &amp;&#160;</td>
<td class="paramname"><em>c</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Charge_8cpp_source.html#l00059">59</a> of file <a class="el" href="Charge_8cpp_source.html">Charge.cpp</a>.</p>
</div>
</div>
<a id="ae432bd9acca60d91b4e015b1085ecd33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae432bd9acca60d91b4e015b1085ecd33">&#9670;&nbsp;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::Resource::Charge::operator!= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Resource_1_1Charge.html">Charge</a> const &amp;&#160;</td>
<td class="paramname"><em>c</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Charge_8cpp_source.html#l00065">65</a> of file <a class="el" href="Charge_8cpp_source.html">Charge.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a76f96fec41e05a79d17e57a126cf3dd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76f96fec41e05a79d17e57a126cf3dd5">&#9670;&nbsp;</a></span>m_cost</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="classripple_1_1Resource_1_1Charge.html#a02d387c2cf9ed17fa6d471598124564e">value_type</a> ripple::Resource::Charge::m_cost</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="Charge_8h_source.html#l00060">60</a> of file <a class="el" href="Charge_8h_source.html">Charge.h</a>.</p>
</div>
</div>
<a id="a2a34078ac9bc264c2788f56a756467d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a34078ac9bc264c2788f56a756467d9">&#9670;&nbsp;</a></span>m_label</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> ripple::Resource::Charge::m_label</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="Charge_8h_source.html#l00061">61</a> of file <a class="el" href="Charge_8h_source.html">Charge.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