wownero-cpp/docs/doxygen/structmonero_1_1monero__transfer.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" 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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: monero::monero_transfer 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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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">Monero C++ Library
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<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');
  $(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="namespacemonero.html">monero</a></li><li class="navelem"><a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</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-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">monero::monero_transfer Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></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:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structmonero_1_1monero__transfer.png" usemap="#monero::monero_5Ftransfer_map" alt=""/>
  <map id="monero::monero_5Ftransfer_map" name="monero::monero_5Ftransfer_map">
<area href="structmonero_1_1serializable__struct.html" alt="monero::serializable_struct" shape="rect" coords="220,0,430,24"/>
<area href="structmonero_1_1monero__incoming__transfer.html" alt="monero::monero_incoming_transfer" shape="rect" coords="0,112,210,136"/>
<area href="structmonero_1_1monero__outgoing__transfer.html" alt="monero::monero_outgoing_transfer" shape="rect" coords="220,112,430,136"/>
<area href="structmonero_1_1monero__transfer__query.html" alt="monero::monero_transfer_query" shape="rect" coords="440,112,650,136"/>
  </map>
</div></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:ae34c855d2139c06df65ee46be86df9e6" id="r_ae34c855d2139c06df65ee46be86df9e6"><td class="memItemLeft" align="right" valign="top">rapidjson::Value&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae34c855d2139c06df65ee46be86df9e6">to_rapidjson_val</a> (rapidjson::Document::AllocatorType &amp;allocator) const</td></tr>
<tr class="separator:ae34c855d2139c06df65ee46be86df9e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3049b3ab9f38480271f0d62b91554cd5" id="r_a3049b3ab9f38480271f0d62b91554cd5"><td class="memItemLeft" align="right" valign="top"><a id="a3049b3ab9f38480271f0d62b91554cd5" name="a3049b3ab9f38480271f0d62b91554cd5"></a>
virtual boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>is_incoming</b> () const =0</td></tr>
<tr class="separator:a3049b3ab9f38480271f0d62b91554cd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f949ec6d6103551275ff9878dd1345f" id="r_a3f949ec6d6103551275ff9878dd1345f"><td class="memItemLeft" align="right" valign="top"><a id="a3f949ec6d6103551275ff9878dd1345f" name="a3f949ec6d6103551275ff9878dd1345f"></a>
std::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 std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;src, const std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;tgt) const</td></tr>
<tr class="separator:a3f949ec6d6103551275ff9878dd1345f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4638381bad98b428cbdf97361bcd2bcd" id="r_a4638381bad98b428cbdf97361bcd2bcd"><td class="memItemLeft" align="right" valign="top"><a id="a4638381bad98b428cbdf97361bcd2bcd" name="a4638381bad98b428cbdf97361bcd2bcd"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>is_outgoing</b> () const</td></tr>
<tr class="separator:a4638381bad98b428cbdf97361bcd2bcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a280c676c6dcd71a4949840da1fc83589" id="r_a280c676c6dcd71a4949840da1fc83589"><td class="memItemLeft" align="right" valign="top"><a id="a280c676c6dcd71a4949840da1fc83589" name="a280c676c6dcd71a4949840da1fc83589"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>merge</b> (const std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;self, const std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;other)</td></tr>
<tr class="separator:a280c676c6dcd71a4949840da1fc83589"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structmonero_1_1serializable__struct"><td colspan="2" onclick="javascript:dynsection.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:a723e44b22962d02d3f78bc7c2043dc1e inherit pub_methods_structmonero_1_1serializable__struct" id="r_a723e44b22962d02d3f78bc7c2043dc1e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmonero_1_1serializable__struct.html#a723e44b22962d02d3f78bc7c2043dc1e">serialize</a> () const</td></tr>
<tr class="separator:a723e44b22962d02d3f78bc7c2043dc1e 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 id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af911925165dfff164db015ae8783c8b9" id="r_af911925165dfff164db015ae8783c8b9"><td class="memItemLeft" align="right" valign="top"><a id="af911925165dfff164db015ae8783c8b9" name="af911925165dfff164db015ae8783c8b9"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>from_property_tree</b> (const boost::property_tree::ptree &amp;node, const std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__transfer.html">monero_transfer</a> &gt; &amp;transfer)</td></tr>
<tr class="separator:af911925165dfff164db015ae8783c8b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ad8805f58288f529e5a28426ea8a97e79" id="r_ad8805f58288f529e5a28426ea8a97e79"><td class="memItemLeft" align="right" valign="top"><a id="ad8805f58288f529e5a28426ea8a97e79" name="ad8805f58288f529e5a28426ea8a97e79"></a>
std::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:ad8805f58288f529e5a28426ea8a97e79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f102f3f43572bceff25243ac5cb89bf" id="r_a8f102f3f43572bceff25243ac5cb89bf"><td class="memItemLeft" align="right" valign="top"><a id="a8f102f3f43572bceff25243ac5cb89bf" name="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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a121fc549ccc450ae81c0e8626fa81565" id="r_a121fc549ccc450ae81c0e8626fa81565"><td class="memItemLeft" align="right" valign="top"><a id="a121fc549ccc450ae81c0e8626fa81565" name="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"><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>Models a base transfer of funds to or from the wallet.</p>
<p>TODO: m_is_incoming for api consistency </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae34c855d2139c06df65ee46be86df9e6" name="ae34c855d2139c06df65ee46be86df9e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae34c855d2139c06df65ee46be86df9e6">&#9670;&#160;</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::to_rapidjson_val </td>
          <td>(</td>
          <td class="paramtype">rapidjson::Document::AllocatorType &amp;</td>          <td class="paramname"><span class="paramname"><em>allocator</em></span></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>Implements <a class="el" href="structmonero_1_1serializable__struct.html#a3c53ab95b12f02db20cf20cd6d69ad4b">monero::serializable_struct</a>.</p>

<p>Reimplemented in <a class="el" href="structmonero_1_1monero__transfer__query.html#a04694bb70b70a24b2eb347f127c2aed8">monero::monero_transfer_query</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/<b>monero_wallet_model.cpp</b></li>
</ul>
</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.10.0
</small></address>
</body>
</html>