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
b9058045945c27a01d3620507f47e55634c65d89
rippled/structripple_1_1StrandContext.html
manojsdoshi dffdcfc0e7 deploy: 9d89d4c188
2021-03-12 22:34:28 +00:00

549 lines
34 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::StrandContext Struct 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="structripple_1_1StrandContext.html">StrandContext</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="structripple_1_1StrandContext-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::StrandContext Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Context needed to build Strand Steps and for error checking.
<a href="structripple_1_1StrandContext.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::StrandContext:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1StrandContext__coll__graph.png" border="0" usemap="#ripple_1_1StrandContext_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1StrandContext_coll__map" id="ripple_1_1StrandContext_coll__map">
<area shape="rect" title="Context needed to build Strand Steps and for error checking." alt="" coords="1155,172,1315,199"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="811,157,974,213"/>
<area shape="rect" href="classripple_1_1Issue.html" title="A currency issued by an account." alt="" coords="842,237,943,264"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="491,230,689,271"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,147,389,189"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="487,165,693,206"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="519,297,661,338"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,155,108,181"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,320,349,347"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="827,459,958,485"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1147,444,1323,500"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1147,525,1323,566"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="1372,411,1572,437"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="1375,575,1569,601"/>
<area shape="rect" href="classripple_1_1Step.html" title="A step in a payment path." alt="" coords="845,5,941,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="803,56,983,83"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="837,107,948,133"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="517,107,663,133"/>
</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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a097aac45f577b584145d4005dec223cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a097aac45f577b584145d4005dec223cd">StrandContext</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;view_, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1Step.html">Step</a> &gt;&gt; const &amp;strand_, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;strandSrc_, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;strandDst_, <a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;strandDeliver_, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; Quality &gt; const &amp;limitQuality_, bool isLast_, bool ownerPaysTransferFee_, bool offerCrossing_, bool isDefaultPath_, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt;, 2 &gt; &amp;seenDirectIssues_, boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt; &amp;seenBookOuts_, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j_)</td></tr>
<tr class="memdesc:a097aac45f577b584145d4005dec223cd"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structripple_1_1StrandContext.html" title="Context needed to build Strand Steps and for error checking.">StrandContext</a> constructor. <a href="structripple_1_1StrandContext.html#a097aac45f577b584145d4005dec223cd">More...</a><br /></td></tr>
<tr class="separator:a097aac45f577b584145d4005dec223cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0e059ee50baf7c62cfa1748b40f1092d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a0e059ee50baf7c62cfa1748b40f1092d">view</a></td></tr>
<tr class="memdesc:a0e059ee50baf7c62cfa1748b40f1092d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current <a class="el" href="classripple_1_1ReadView.html" title="A view into a ledger.">ReadView</a>. <a href="structripple_1_1StrandContext.html#a0e059ee50baf7c62cfa1748b40f1092d">More...</a><br /></td></tr>
<tr class="separator:a0e059ee50baf7c62cfa1748b40f1092d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a212516d00b7d56494ab25f682bf4f380"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a212516d00b7d56494ab25f682bf4f380">strandSrc</a></td></tr>
<tr class="memdesc:a212516d00b7d56494ab25f682bf4f380"><td class="mdescLeft">&#160;</td><td class="mdescRight">Strand source account. <a href="structripple_1_1StrandContext.html#a212516d00b7d56494ab25f682bf4f380">More...</a><br /></td></tr>
<tr class="separator:a212516d00b7d56494ab25f682bf4f380"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b7aef996aecc1b31da6baee5649c321"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a2b7aef996aecc1b31da6baee5649c321">strandDst</a></td></tr>
<tr class="memdesc:a2b7aef996aecc1b31da6baee5649c321"><td class="mdescLeft">&#160;</td><td class="mdescRight">Strand destination account. <a href="structripple_1_1StrandContext.html#a2b7aef996aecc1b31da6baee5649c321">More...</a><br /></td></tr>
<tr class="separator:a2b7aef996aecc1b31da6baee5649c321"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03b9f93d198f909b093bf62c00a9e7a0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classripple_1_1Issue.html">Issue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a03b9f93d198f909b093bf62c00a9e7a0">strandDeliver</a></td></tr>
<tr class="memdesc:a03b9f93d198f909b093bf62c00a9e7a0"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> strand delivers. <a href="structripple_1_1StrandContext.html#a03b9f93d198f909b093bf62c00a9e7a0">More...</a><br /></td></tr>
<tr class="separator:a03b9f93d198f909b093bf62c00a9e7a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2eac14aa58ae3e5633ab2f00e4f3603"><td class="memItemLeft" align="right" valign="top">const <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; Quality &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#ae2eac14aa58ae3e5633ab2f00e4f3603">limitQuality</a></td></tr>
<tr class="memdesc:ae2eac14aa58ae3e5633ab2f00e4f3603"><td class="mdescLeft">&#160;</td><td class="mdescRight">Worst accepted quality. <a href="structripple_1_1StrandContext.html#ae2eac14aa58ae3e5633ab2f00e4f3603">More...</a><br /></td></tr>
<tr class="separator:ae2eac14aa58ae3e5633ab2f00e4f3603"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a449baf2ba9ae982f455c65884b3a8500"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a449baf2ba9ae982f455c65884b3a8500">isFirst</a></td></tr>
<tr class="memdesc:a449baf2ba9ae982f455c65884b3a8500"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> is first in Strand <a href="structripple_1_1StrandContext.html#a449baf2ba9ae982f455c65884b3a8500">More...</a><br /></td></tr>
<tr class="separator:a449baf2ba9ae982f455c65884b3a8500"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affdfbc855490fb34aad3acdf59457f4a"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#affdfbc855490fb34aad3acdf59457f4a">isLast</a> = false</td></tr>
<tr class="memdesc:affdfbc855490fb34aad3acdf59457f4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> is last in Strand <a href="structripple_1_1StrandContext.html#affdfbc855490fb34aad3acdf59457f4a">More...</a><br /></td></tr>
<tr class="separator:affdfbc855490fb34aad3acdf59457f4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71597e6329f3c2845e5e153f62edf31d"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a71597e6329f3c2845e5e153f62edf31d">ownerPaysTransferFee</a></td></tr>
<tr class="memdesc:a71597e6329f3c2845e5e153f62edf31d"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if owner, not sender, pays fee <a href="structripple_1_1StrandContext.html#a71597e6329f3c2845e5e153f62edf31d">More...</a><br /></td></tr>
<tr class="separator:a71597e6329f3c2845e5e153f62edf31d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85b6e9d4657b1aef125158607e7b9c19"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a85b6e9d4657b1aef125158607e7b9c19">offerCrossing</a></td></tr>
<tr class="memdesc:a85b6e9d4657b1aef125158607e7b9c19"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if offer crossing, not payment <a href="structripple_1_1StrandContext.html#a85b6e9d4657b1aef125158607e7b9c19">More...</a><br /></td></tr>
<tr class="separator:a85b6e9d4657b1aef125158607e7b9c19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82d457c1417626119622430af844184e"><td class="memItemLeft" align="right" valign="top">const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a82d457c1417626119622430af844184e">isDefaultPath</a></td></tr>
<tr class="memdesc:a82d457c1417626119622430af844184e"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if Strand is default path <a href="structripple_1_1StrandContext.html#a82d457c1417626119622430af844184e">More...</a><br /></td></tr>
<tr class="separator:a82d457c1417626119622430af844184e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf8cbe3f3e12efda21a694f5228a7a2d"><td class="memItemLeft" align="right" valign="top">const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#abf8cbe3f3e12efda21a694f5228a7a2d">strandSize</a></td></tr>
<tr class="memdesc:abf8cbe3f3e12efda21a694f5228a7a2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of Strand. <a href="structripple_1_1StrandContext.html#abf8cbe3f3e12efda21a694f5228a7a2d">More...</a><br /></td></tr>
<tr class="separator:abf8cbe3f3e12efda21a694f5228a7a2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20f852451e14c6cc04c3fbb5a49c41f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Step.html">Step</a> const *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a20f852451e14c6cc04c3fbb5a49c41f6">prevStep</a> = nullptr</td></tr>
<tr class="memdesc:a20f852451e14c6cc04c3fbb5a49c41f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The previous step in the strand. <a href="structripple_1_1StrandContext.html#a20f852451e14c6cc04c3fbb5a49c41f6">More...</a><br /></td></tr>
<tr class="separator:a20f852451e14c6cc04c3fbb5a49c41f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f64547d1189ede6fef202ada9dc0f2b"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt;, 2 &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a1f64547d1189ede6fef202ada9dc0f2b">seenDirectIssues</a></td></tr>
<tr class="memdesc:a1f64547d1189ede6fef202ada9dc0f2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A strand may not include the same account node more than once in the same currency. <a href="structripple_1_1StrandContext.html#a1f64547d1189ede6fef202ada9dc0f2b">More...</a><br /></td></tr>
<tr class="separator:a1f64547d1189ede6fef202ada9dc0f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bef921eb9b057dff6fa57d4bef62025"><td class="memItemLeft" align="right" valign="top">boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a0bef921eb9b057dff6fa57d4bef62025">seenBookOuts</a></td></tr>
<tr class="memdesc:a0bef921eb9b057dff6fa57d4bef62025"><td class="mdescLeft">&#160;</td><td class="mdescRight">A strand may not include an offer that output the same issue more than once. <a href="structripple_1_1StrandContext.html#a0bef921eb9b057dff6fa57d4bef62025">More...</a><br /></td></tr>
<tr class="separator:a0bef921eb9b057dff6fa57d4bef62025"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4004cdee59805566766958fbf01c13ae"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a4004cdee59805566766958fbf01c13ae">j</a></td></tr>
<tr class="separator:a4004cdee59805566766958fbf01c13ae"><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>Context needed to build Strand Steps and for error checking. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00497">497</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a097aac45f577b584145d4005dec223cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a097aac45f577b584145d4005dec223cd">&#9670;&nbsp;</a></span>StrandContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::StrandContext::StrandContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;&#160;</td>
<td class="paramname"><em>view_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1Step.html">Step</a> &gt;&gt; const &amp;&#160;</td>
<td class="paramname"><em>strand_</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>strandSrc_</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>strandDst_</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>strandDeliver_</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; Quality &gt; const &amp;&#160;</td>
<td class="paramname"><em>limitQuality_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isLast_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>ownerPaysTransferFee_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>offerCrossing_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isDefaultPath_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt;, 2 &gt; &amp;&#160;</td>
<td class="paramname"><em>seenDirectIssues_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>seenBookOuts_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>j_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structripple_1_1StrandContext.html" title="Context needed to build Strand Steps and for error checking.">StrandContext</a> constructor. </p>
<p>Journal for logging </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seenDirectIssues_</td><td>For detecting currency loops </td></tr>
<tr><td class="paramname">seenBookOuts_</td><td>For detecting book loops </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PaySteps_8cpp_source.html#l00575">575</a> of file <a class="el" href="PaySteps_8cpp_source.html">PaySteps.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0e059ee50baf7c62cfa1748b40f1092d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e059ee50baf7c62cfa1748b40f1092d">&#9670;&nbsp;</a></span>view</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const&amp; ripple::StrandContext::view</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current <a class="el" href="classripple_1_1ReadView.html" title="A view into a ledger.">ReadView</a>. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00499">499</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a212516d00b7d56494ab25f682bf4f380"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a212516d00b7d56494ab25f682bf4f380">&#9670;&nbsp;</a></span>strandSrc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> ripple::StrandContext::strandSrc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Strand source account. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00500">500</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a2b7aef996aecc1b31da6baee5649c321"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b7aef996aecc1b31da6baee5649c321">&#9670;&nbsp;</a></span>strandDst</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> ripple::StrandContext::strandDst</td>
</tr>
</table>
</div><div class="memdoc">
<p>Strand destination account. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00501">501</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a03b9f93d198f909b093bf62c00a9e7a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03b9f93d198f909b093bf62c00a9e7a0">&#9670;&nbsp;</a></span>strandDeliver</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classripple_1_1Issue.html">Issue</a> ripple::StrandContext::strandDeliver</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> strand delivers. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00502">502</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="ae2eac14aa58ae3e5633ab2f00e4f3603"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2eac14aa58ae3e5633ab2f00e4f3603">&#9670;&nbsp;</a></span>limitQuality</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;Quality&gt; ripple::StrandContext::limitQuality</td>
</tr>
</table>
</div><div class="memdoc">
<p>Worst accepted quality. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00503">503</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a449baf2ba9ae982f455c65884b3a8500"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a449baf2ba9ae982f455c65884b3a8500">&#9670;&nbsp;</a></span>isFirst</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const bool ripple::StrandContext::isFirst</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> is first in Strand </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00504">504</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="affdfbc855490fb34aad3acdf59457f4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affdfbc855490fb34aad3acdf59457f4a">&#9670;&nbsp;</a></span>isLast</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const bool ripple::StrandContext::isLast = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> is last in Strand </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00505">505</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a71597e6329f3c2845e5e153f62edf31d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71597e6329f3c2845e5e153f62edf31d">&#9670;&nbsp;</a></span>ownerPaysTransferFee</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const bool ripple::StrandContext::ownerPaysTransferFee</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if owner, not sender, pays fee </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00506">506</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a85b6e9d4657b1aef125158607e7b9c19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85b6e9d4657b1aef125158607e7b9c19">&#9670;&nbsp;</a></span>offerCrossing</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const bool ripple::StrandContext::offerCrossing</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if offer crossing, not payment </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00507">507</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a82d457c1417626119622430af844184e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82d457c1417626119622430af844184e">&#9670;&nbsp;</a></span>isDefaultPath</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const bool ripple::StrandContext::isDefaultPath</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if Strand is default path </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00508">508</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="abf8cbe3f3e12efda21a694f5228a7a2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf8cbe3f3e12efda21a694f5228a7a2d">&#9670;&nbsp;</a></span>strandSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const size_t ripple::StrandContext::strandSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length of Strand. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00509">509</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a20f852451e14c6cc04c3fbb5a49c41f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20f852451e14c6cc04c3fbb5a49c41f6">&#9670;&nbsp;</a></span>prevStep</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Step.html">Step</a> const* const ripple::StrandContext::prevStep = nullptr</td>
</tr>
</table>
</div><div class="memdoc">
<p>The previous step in the strand. </p>
<p>Needed to check the no ripple constraint </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00513">513</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a1f64547d1189ede6fef202ada9dc0f2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f64547d1189ede6fef202ada9dc0f2b">&#9670;&nbsp;</a></span>seenDirectIssues</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt;boost::container::flat_set&lt;<a class="el" href="classripple_1_1Issue.html">Issue</a>&gt;, 2&gt;&amp; ripple::StrandContext::seenDirectIssues</td>
</tr>
</table>
</div><div class="memdoc">
<p>A strand may not include the same account node more than once in the same currency. </p>
<p>In a direct step, an account will show up at most twice: once as a src and once as a dst (hence the two element array). The strandSrc and strandDst will only show up once each. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00519">519</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a0bef921eb9b057dff6fa57d4bef62025"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bef921eb9b057dff6fa57d4bef62025">&#9670;&nbsp;</a></span>seenBookOuts</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::container::flat_set&lt;<a class="el" href="classripple_1_1Issue.html">Issue</a>&gt;&amp; ripple::StrandContext::seenBookOuts</td>
</tr>
</table>
</div><div class="memdoc">
<p>A strand may not include an offer that output the same issue more than once. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00523">523</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a4004cdee59805566766958fbf01c13ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4004cdee59805566766958fbf01c13ae">&#9670;&nbsp;</a></span>j</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> ripple::StrandContext::j</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00524">524</a> of file <a class="el" href="Steps_8h_source.html">Steps.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