ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-26 14:05:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cf1b2bc8e43a57da9a990f414c8a805026ce12ff
rippled/classripple_1_1RawView.html
bthomee e0ff9ab743 deploy: dacecd24ba
2025-05-29 21:00:28 +00:00

370 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" 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::RawView 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_1RawView.html">RawView</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1RawView-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::RawView Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Interface for ledger entry changes.
<a href="classripple_1_1RawView.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="RawView_8h_source.html">RawView.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::RawView:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1RawView__inherit__graph.png" border="0" usemap="#aripple_1_1RawView_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1RawView_inherit__map" id="aripple_1_1RawView_inherit__map">
<area shape="rect" title="Interface for ledger entry changes." alt="" coords="5,104,132,129"/>
<area shape="rect" href="classripple_1_1TxsRawView.html" title="Interface for changing ledger entries with transactions." alt="" coords="211,55,362,80"/>
<area shape="rect" href="classripple_1_1detail_1_1ApplyViewBase.html" title=" " alt="" coords="180,128,393,153"/>
<area shape="rect" href="classripple_1_1Ledger.html" title="Holds a ledger." alt="" coords="476,5,587,31"/>
<area shape="rect" href="classripple_1_1OpenView.html" title="Writable ledger view that accumulates state and tx changes." alt="" coords="465,55,598,80"/>
<area shape="rect" href="classripple_1_1ApplyViewImpl.html" title="Editable, discardable view that can build metadata for one tx." alt="" coords="449,104,614,129"/>
<area shape="rect" href="classripple_1_1PaymentSandbox.html" title="A wrapper which makes credits unavailable to balances." alt="" coords="441,153,621,179"/>
<area shape="rect" href="classripple_1_1Sandbox.html" title="Discardable, editable view to a ledger." alt="" coords="470,203,593,228"/>
</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:a9bdaa1e7d96c41fd07d44a3ccc6e8c0e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#a9bdaa1e7d96c41fd07d44a3ccc6e8c0e">~RawView</a> ()=default</td></tr>
<tr class="separator:a9bdaa1e7d96c41fd07d44a3ccc6e8c0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbdbbc9799c838cdd2af9554558e01c9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#abbdbbc9799c838cdd2af9554558e01c9">RawView</a> ()=default</td></tr>
<tr class="separator:abbdbbc9799c838cdd2af9554558e01c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c6a7a0fb8de08c59aaf7bf4e9174537"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#a5c6a7a0fb8de08c59aaf7bf4e9174537">RawView</a> (<a class="el" href="classripple_1_1RawView.html">RawView</a> const &amp;)=default</td></tr>
<tr class="separator:a5c6a7a0fb8de08c59aaf7bf4e9174537"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0b436ab3082946f31da7c042c1b04a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RawView.html">RawView</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#af0b436ab3082946f31da7c042c1b04a4">operator=</a> (<a class="el" href="classripple_1_1RawView.html">RawView</a> const &amp;)=delete</td></tr>
<tr class="separator:af0b436ab3082946f31da7c042c1b04a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae90031cd2242cf34aeb93fbdbf92cfb8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#ae90031cd2242cf34aeb93fbdbf92cfb8">rawErase</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;sle)=0</td></tr>
<tr class="memdesc:ae90031cd2242cf34aeb93fbdbf92cfb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete an existing state item. <a href="classripple_1_1RawView.html#ae90031cd2242cf34aeb93fbdbf92cfb8">More...</a><br /></td></tr>
<tr class="separator:ae90031cd2242cf34aeb93fbdbf92cfb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a144f9ecbd046e28918d273728ad91eb0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#a144f9ecbd046e28918d273728ad91eb0">rawInsert</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;sle)=0</td></tr>
<tr class="memdesc:a144f9ecbd046e28918d273728ad91eb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unconditionally insert a state item. <a href="classripple_1_1RawView.html#a144f9ecbd046e28918d273728ad91eb0">More...</a><br /></td></tr>
<tr class="separator:a144f9ecbd046e28918d273728ad91eb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad27fcee888dd020ca39a2327d1a5f19c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#ad27fcee888dd020ca39a2327d1a5f19c">rawReplace</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;sle)=0</td></tr>
<tr class="memdesc:ad27fcee888dd020ca39a2327d1a5f19c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unconditionally replace a state item. <a href="classripple_1_1RawView.html#ad27fcee888dd020ca39a2327d1a5f19c">More...</a><br /></td></tr>
<tr class="separator:ad27fcee888dd020ca39a2327d1a5f19c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accebb9124b44b63080c236f01e070a1e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#accebb9124b44b63080c236f01e070a1e">rawDestroyXRP</a> (<a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> const &amp;fee)=0</td></tr>
<tr class="memdesc:accebb9124b44b63080c236f01e070a1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy XRP. <a href="classripple_1_1RawView.html#accebb9124b44b63080c236f01e070a1e">More...</a><br /></td></tr>
<tr class="separator:accebb9124b44b63080c236f01e070a1e"><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 >Interface for ledger entry changes. </p>
<p >Subclasses allow raw modification of ledger entries. </p>
<p class="definition">Definition at line <a class="el" href="RawView_8h_source.html#l00034">34</a> of file <a class="el" href="RawView_8h_source.html">RawView.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9bdaa1e7d96c41fd07d44a3ccc6e8c0e" name="a9bdaa1e7d96c41fd07d44a3ccc6e8c0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bdaa1e7d96c41fd07d44a3ccc6e8c0e">&#9670;&#160;</a></span>~RawView()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::RawView::~RawView </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abbdbbc9799c838cdd2af9554558e01c9" name="abbdbbc9799c838cdd2af9554558e01c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbdbbc9799c838cdd2af9554558e01c9">&#9670;&#160;</a></span>RawView() <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::RawView::RawView </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="a5c6a7a0fb8de08c59aaf7bf4e9174537" name="a5c6a7a0fb8de08c59aaf7bf4e9174537"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c6a7a0fb8de08c59aaf7bf4e9174537">&#9670;&#160;</a></span>RawView() <span class="overload">[2/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::RawView::RawView </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1RawView.html">RawView</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>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af0b436ab3082946f31da7c042c1b04a4" name="af0b436ab3082946f31da7c042c1b04a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0b436ab3082946f31da7c042c1b04a4">&#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="classripple_1_1RawView.html">RawView</a> &amp; ripple::RawView::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1RawView.html">RawView</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>
<a id="ae90031cd2242cf34aeb93fbdbf92cfb8" name="ae90031cd2242cf34aeb93fbdbf92cfb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae90031cd2242cf34aeb93fbdbf92cfb8">&#9670;&#160;</a></span>rawErase()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::RawView::rawErase </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>sle</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete an existing state item. </p>
<p >The SLE is provided so the implementation can calculate metadata. </p>
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a27f6d838768ff645f63dbbca85160ab7">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a781e62e909b6509b1863b7305295cb39">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#ab8ec1fb6833f8962f766b214c580ab7b">ripple::OpenView</a>.</p>
</div>
</div>
<a id="a144f9ecbd046e28918d273728ad91eb0" name="a144f9ecbd046e28918d273728ad91eb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a144f9ecbd046e28918d273728ad91eb0">&#9670;&#160;</a></span>rawInsert()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::RawView::rawInsert </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>sle</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unconditionally insert a state item. </p>
<p >Requirements: The key must not already exist.</p>
<p >Effects: </p><pre class="fragment">The key is associated with the SLE.
</pre> <dl class="section note"><dt>Note</dt><dd>The key is taken from the SLE </dd></dl>
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a7ed6dcfefe77ee7b9e90e052df79e52d">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#aacd0fa84b0681ca34739a9fddde754a0">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#ad8795d23968108dca84420d2d25e1dd7">ripple::OpenView</a>.</p>
</div>
</div>
<a id="ad27fcee888dd020ca39a2327d1a5f19c" name="ad27fcee888dd020ca39a2327d1a5f19c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad27fcee888dd020ca39a2327d1a5f19c">&#9670;&#160;</a></span>rawReplace()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::RawView::rawReplace </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>sle</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unconditionally replace a state item. </p>
<p >Requirements: </p><pre class="fragment">The key must exist.
</pre><p> Effects: </p><pre class="fragment">The key is associated with the SLE.
</pre> <dl class="section note"><dt>Note</dt><dd>The key is taken from the SLE </dd></dl>
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a210375076ddca23b7374efea0b34de4a">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a720bb7359587d757eff58b3f26ea4f94">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#ad2a95c6fd9303d94164d55530cc1df39">ripple::OpenView</a>.</p>
</div>
</div>
<a id="accebb9124b44b63080c236f01e070a1e" name="accebb9124b44b63080c236f01e070a1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accebb9124b44b63080c236f01e070a1e">&#9670;&#160;</a></span>rawDestroyXRP()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::RawView::rawDestroyXRP </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> const &amp;&#160;</td>
<td class="paramname"><em>fee</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy XRP. </p>
<p >This is used to pay for transaction fees. </p>
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a12a86d2a4af573d10f76664259df1b1e">ripple::Ledger</a>, <a class="el" href="classripple_1_1OpenView.html#a88584a83d760fe41178b3397359b7816">ripple::OpenView</a>, and <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a1c8f17e8aa8248be7d972ffecdd949a8">ripple::detail::ApplyViewBase</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