Files
wownero-cpp/docs/structmonero_1_1monero__transfer__query.html
T
2019-12-15 08:42:10 -05:00

226 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: monero::monero_transfer_query 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">Monero C++ Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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="namespacemonero.html">monero</a></li><li class="navelem"><a class="el" href="structmonero_1_1monero__transfer__query.html">monero_transfer_query</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structmonero_1_1monero__transfer__query-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">monero::monero_transfer_query Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="monero__wallet__model_8h_source.html">monero_wallet_model.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for monero::monero_transfer_query:</div>
<div class="dyncontent">
<div class="center">
<img src="structmonero_1_1monero__transfer__query.png" usemap="#monero::monero_5Ftransfer_5Fquery_map" alt=""/>
<map id="monero::monero_5Ftransfer_5Fquery_map" name="monero::monero_5Ftransfer_5Fquery_map">
<area href="structmonero_1_1monero__transfer.html" alt="monero::monero_transfer" shape="rect" coords="0,56,192,80"/>
<area href="structmonero_1_1serializable__struct.html" alt="monero::serializable_struct" shape="rect" coords="0,0,192,24"/>
</map>
</div></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:a04694bb70b70a24b2eb347f127c2aed8"><td class="memItemLeft" align="right" valign="top">rapidjson::Value&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmonero_1_1monero__transfer__query.html#a04694bb70b70a24b2eb347f127c2aed8">to_rapidjson_val</a> (rapidjson::Document::AllocatorType &amp;allocator) const</td></tr>
<tr class="separator:a04694bb70b70a24b2eb347f127c2aed8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3488cfeb4de66ef9b5c770a7be467700"><td class="memItemLeft" align="right" valign="top"><a id="a3488cfeb4de66ef9b5c770a7be467700"></a>
shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer__query.html">monero_transfer_query</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>copy</b> (const shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;src, const shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;tgt) const</td></tr>
<tr class="separator:a3488cfeb4de66ef9b5c770a7be467700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2dee1b84c61edd44ccb58b9b61bc05e1"><td class="memItemLeft" align="right" valign="top"><a id="a2dee1b84c61edd44ccb58b9b61bc05e1"></a>
shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer__query.html">monero_transfer_query</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>copy</b> (const shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer__query.html">monero_transfer_query</a> &gt; &amp;src, const shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer__query.html">monero_transfer_query</a> &gt; &amp;tgt) const</td></tr>
<tr class="separator:a2dee1b84c61edd44ccb58b9b61bc05e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbaf53a704b5b516d786c46ca0892c91"><td class="memItemLeft" align="right" valign="top"><a id="adbaf53a704b5b516d786c46ca0892c91"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>is_incoming</b> () const</td></tr>
<tr class="separator:adbaf53a704b5b516d786c46ca0892c91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c95782919a0b74129a8725dd878ab5b"><td class="memItemLeft" align="right" valign="top"><a id="a4c95782919a0b74129a8725dd878ab5b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>meets_criteria</b> (<a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> *transfer) const</td></tr>
<tr class="separator:a4c95782919a0b74129a8725dd878ab5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structmonero_1_1monero__transfer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structmonero_1_1monero__transfer')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structmonero_1_1monero__transfer.html">monero::monero_transfer</a></td></tr>
<tr class="memitem:a7e7a5b8ef5913e5a194e3b5b3a2aa513 inherit pub_methods_structmonero_1_1monero__transfer"><td class="memItemLeft" align="right" valign="top"><a id="a7e7a5b8ef5913e5a194e3b5b3a2aa513"></a>
shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>copy</b> (const shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;src, const shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;tgt) const</td></tr>
<tr class="separator:a7e7a5b8ef5913e5a194e3b5b3a2aa513 inherit pub_methods_structmonero_1_1monero__transfer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc7af8616fc33332d01db190e1fcd0a8 inherit pub_methods_structmonero_1_1monero__transfer"><td class="memItemLeft" align="right" valign="top"><a id="acc7af8616fc33332d01db190e1fcd0a8"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>is_outgoing</b> () const</td></tr>
<tr class="separator:acc7af8616fc33332d01db190e1fcd0a8 inherit pub_methods_structmonero_1_1monero__transfer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb06eb7e4d4083ac43da7174379d83bc inherit pub_methods_structmonero_1_1monero__transfer"><td class="memItemLeft" align="right" valign="top"><a id="acb06eb7e4d4083ac43da7174379d83bc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>merge</b> (const shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;self, const shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;other)</td></tr>
<tr class="separator:acb06eb7e4d4083ac43da7174379d83bc inherit pub_methods_structmonero_1_1monero__transfer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structmonero_1_1serializable__struct"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structmonero_1_1serializable__struct')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structmonero_1_1serializable__struct.html">monero::serializable_struct</a></td></tr>
<tr class="memitem:aff4103707ee262cc4bd15d8e789adddc inherit pub_methods_structmonero_1_1serializable__struct"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmonero_1_1serializable__struct.html#aff4103707ee262cc4bd15d8e789adddc">serialize</a> () const</td></tr>
<tr class="separator:aff4103707ee262cc4bd15d8e789adddc inherit pub_methods_structmonero_1_1serializable__struct"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ab9f5a4e3383de5fe9a21233181c153e3"><td class="memItemLeft" align="right" valign="top"><a id="ab9f5a4e3383de5fe9a21233181c153e3"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>from_property_tree</b> (const boost::property_tree::ptree &amp;node, const shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer__query.html">monero_transfer_query</a> &gt; &amp;transfer_query)</td></tr>
<tr class="separator:ab9f5a4e3383de5fe9a21233181c153e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bd61c8e514e8f67ae2cddc6d3fca72d"><td class="memItemLeft" align="right" valign="top"><a id="a2bd61c8e514e8f67ae2cddc6d3fca72d"></a>
static shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer__query.html">monero_transfer_query</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize_from_block</b> (const string &amp;transfer_query_json)</td></tr>
<tr class="separator:a2bd61c8e514e8f67ae2cddc6d3fca72d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_methods_structmonero_1_1monero__transfer"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_structmonero_1_1monero__transfer')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="structmonero_1_1monero__transfer.html">monero::monero_transfer</a></td></tr>
<tr class="memitem:a50e1ae3315da471fb59160ddb3c5f514 inherit pub_static_methods_structmonero_1_1monero__transfer"><td class="memItemLeft" align="right" valign="top"><a id="a50e1ae3315da471fb59160ddb3c5f514"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>from_property_tree</b> (const boost::property_tree::ptree &amp;node, const shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;transfer)</td></tr>
<tr class="separator:a50e1ae3315da471fb59160ddb3c5f514 inherit pub_static_methods_structmonero_1_1monero__transfer"><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:af6f8b3f4cacd525021b8df7d4d69d0e7"><td class="memItemLeft" align="right" valign="top"><a id="af6f8b3f4cacd525021b8df7d4d69d0e7"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_is_incoming</b></td></tr>
<tr class="separator:af6f8b3f4cacd525021b8df7d4d69d0e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a076b25097db4ce7a09ad83f043f3b47b"><td class="memItemLeft" align="right" valign="top"><a id="a076b25097db4ce7a09ad83f043f3b47b"></a>
boost::optional&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_address</b></td></tr>
<tr class="separator:a076b25097db4ce7a09ad83f043f3b47b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa59631c617571e143c4f2d33250e65f"><td class="memItemLeft" align="right" valign="top"><a id="afa59631c617571e143c4f2d33250e65f"></a>
vector&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_addresses</b></td></tr>
<tr class="separator:afa59631c617571e143c4f2d33250e65f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac85ba9eb1f5960823f67850b75334194"><td class="memItemLeft" align="right" valign="top"><a id="ac85ba9eb1f5960823f67850b75334194"></a>
boost::optional&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_subaddress_index</b></td></tr>
<tr class="separator:ac85ba9eb1f5960823f67850b75334194"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8d7e89613eff9f44b72688e9971b892"><td class="memItemLeft" align="right" valign="top"><a id="ac8d7e89613eff9f44b72688e9971b892"></a>
vector&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_subaddress_indices</b></td></tr>
<tr class="separator:ac8d7e89613eff9f44b72688e9971b892"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab81ffb69851f5998861c0ca48c967207"><td class="memItemLeft" align="right" valign="top"><a id="ab81ffb69851f5998861c0ca48c967207"></a>
vector&lt; shared_ptr&lt; <a class="el" href="structmonero_1_1monero__destination.html">monero_destination</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_destinations</b></td></tr>
<tr class="separator:ab81ffb69851f5998861c0ca48c967207"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f92651508297de4a9b343845ad5b013"><td class="memItemLeft" align="right" valign="top"><a id="a5f92651508297de4a9b343845ad5b013"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_has_destinations</b></td></tr>
<tr class="separator:a5f92651508297de4a9b343845ad5b013"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dacec294df31affb0344c4b67c8e0ed"><td class="memItemLeft" align="right" valign="top"><a id="a4dacec294df31affb0344c4b67c8e0ed"></a>
boost::optional&lt; shared_ptr&lt; <a class="el" href="structmonero_1_1monero__tx__query.html">monero_tx_query</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_tx_query</b></td></tr>
<tr class="separator:a4dacec294df31affb0344c4b67c8e0ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structmonero_1_1monero__transfer"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structmonero_1_1monero__transfer')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structmonero_1_1monero__transfer.html">monero::monero_transfer</a></td></tr>
<tr class="memitem:a3d03eac71b9d9a11e74a52ffdec490b6 inherit pub_attribs_structmonero_1_1monero__transfer"><td class="memItemLeft" align="right" valign="top"><a id="a3d03eac71b9d9a11e74a52ffdec490b6"></a>
shared_ptr&lt; <a class="el" href="structmonero_1_1monero__tx__wallet.html">monero_tx_wallet</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_tx</b></td></tr>
<tr class="separator:a3d03eac71b9d9a11e74a52ffdec490b6 inherit pub_attribs_structmonero_1_1monero__transfer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f102f3f43572bceff25243ac5cb89bf inherit pub_attribs_structmonero_1_1monero__transfer"><td class="memItemLeft" align="right" valign="top"><a id="a8f102f3f43572bceff25243ac5cb89bf"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_amount</b></td></tr>
<tr class="separator:a8f102f3f43572bceff25243ac5cb89bf inherit pub_attribs_structmonero_1_1monero__transfer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a121fc549ccc450ae81c0e8626fa81565 inherit pub_attribs_structmonero_1_1monero__transfer"><td class="memItemLeft" align="right" valign="top"><a id="a121fc549ccc450ae81c0e8626fa81565"></a>
boost::optional&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_account_index</b></td></tr>
<tr class="separator:a121fc549ccc450ae81c0e8626fa81565 inherit pub_attribs_structmonero_1_1monero__transfer"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33b70ec4ef38105a1c5667bffee872d6 inherit pub_attribs_structmonero_1_1monero__transfer"><td class="memItemLeft" align="right" valign="top"><a id="a33b70ec4ef38105a1c5667bffee872d6"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_num_suggested_confirmations</b></td></tr>
<tr class="separator:a33b70ec4ef38105a1c5667bffee872d6 inherit pub_attribs_structmonero_1_1monero__transfer"><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>Configures a query to retrieve transfers.</p>
<p>All transfers are returned except those that do not meet the criteria defined in this query. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a04694bb70b70a24b2eb347f127c2aed8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04694bb70b70a24b2eb347f127c2aed8">&#9670;&nbsp;</a></span>to_rapidjson_val()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rapidjson::Value monero::monero_transfer_query::to_rapidjson_val </td>
<td>(</td>
<td class="paramtype">rapidjson::Document::AllocatorType &amp;&#160;</td>
<td class="paramname"><em>allocator</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the struct to a rapidjson Value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">allocator</td><td>is the rapidjson document allocator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the struct as a rapidjson Value </dd></dl>
<p>Reimplemented from <a class="el" href="structmonero_1_1monero__transfer.html#ae34c855d2139c06df65ee46be86df9e6">monero::monero_transfer</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>wallet/<a class="el" href="monero__wallet__model_8h_source.html">monero_wallet_model.h</a></li>
<li>wallet/monero_wallet_model.cpp</li>
</ul>
</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.15
</small></address>
</body>
</html>