Files
wownero-cpp/docs/structmonero_1_1monero__tx__config.html
T
2020-08-21 11:59:08 -04:00

216 lines
16 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.19"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: monero::monero_tx_config 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.19 -->
<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__tx__config.html">monero_tx_config</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__tx__config-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">monero::monero_tx_config 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_tx_config:</div>
<div class="dyncontent">
<div class="center">
<img src="structmonero_1_1monero__tx__config.png" usemap="#monero::monero_5Ftx_5Fconfig_map" alt=""/>
<map id="monero::monero_5Ftx_5Fconfig_map" name="monero::monero_5Ftx_5Fconfig_map">
<area href="structmonero_1_1serializable__struct.html" alt="monero::serializable_struct" shape="rect" coords="0,0,162,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:a1b74e21922c8db97e9e3dadafc96fcb0"><td class="memItemLeft" align="right" valign="top"><a id="a1b74e21922c8db97e9e3dadafc96fcb0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>monero_tx_config</b> (const <a class="el" href="structmonero_1_1monero__tx__config.html">monero_tx_config</a> &amp;config)</td></tr>
<tr class="separator:a1b74e21922c8db97e9e3dadafc96fcb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfc5381646e21493ccfa775d6ad05233"><td class="memItemLeft" align="right" valign="top"><a id="adfc5381646e21493ccfa775d6ad05233"></a>
<a class="el" href="structmonero_1_1monero__tx__config.html">monero_tx_config</a>&#160;</td><td class="memItemRight" valign="bottom"><b>copy</b> () const</td></tr>
<tr class="separator:adfc5381646e21493ccfa775d6ad05233"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c9444c9febc075bcdd6b3854b742808"><td class="memItemLeft" align="right" valign="top">rapidjson::Value&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmonero_1_1monero__tx__config.html#a0c9444c9febc075bcdd6b3854b742808">to_rapidjson_val</a> (rapidjson::Document::AllocatorType &amp;allocator) const</td></tr>
<tr class="separator:a0c9444c9febc075bcdd6b3854b742808"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea0ba1f36144255ab54f663c3015649d"><td class="memItemLeft" align="right" valign="top"><a id="aea0ba1f36144255ab54f663c3015649d"></a>
std::vector&lt; std::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>get_normalized_destinations</b> () const</td></tr>
<tr class="separator:aea0ba1f36144255ab54f663c3015649d"><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:a723e44b22962d02d3f78bc7c2043dc1e inherit pub_methods_structmonero_1_1serializable__struct"><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 name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a5678c571cc0282008df57a6bd1bba5af"><td class="memItemLeft" align="right" valign="top"><a id="a5678c571cc0282008df57a6bd1bba5af"></a>
static std::shared_ptr&lt; <a class="el" href="structmonero_1_1monero__tx__config.html">monero_tx_config</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize</b> (const std::string &amp;config_json)</td></tr>
<tr class="separator:a5678c571cc0282008df57a6bd1bba5af"><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:a93b7ce3d70b7dad7bd9b7967661ac73b"><td class="memItemLeft" align="right" valign="top"><a id="a93b7ce3d70b7dad7bd9b7967661ac73b"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_address</b></td></tr>
<tr class="separator:a93b7ce3d70b7dad7bd9b7967661ac73b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a4fcc7dedb204c9e217097bb5ae20d0"><td class="memItemLeft" align="right" valign="top"><a id="a5a4fcc7dedb204c9e217097bb5ae20d0"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_amount</b></td></tr>
<tr class="separator:a5a4fcc7dedb204c9e217097bb5ae20d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79a2863bc788e769b38337c3668c6fa6"><td class="memItemLeft" align="right" valign="top"><a id="a79a2863bc788e769b38337c3668c6fa6"></a>
std::vector&lt; std::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:a79a2863bc788e769b38337c3668c6fa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa412b7cff3f988f1a3cbca03ffc09a09"><td class="memItemLeft" align="right" valign="top"><a id="aa412b7cff3f988f1a3cbca03ffc09a09"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_payment_id</b></td></tr>
<tr class="separator:aa412b7cff3f988f1a3cbca03ffc09a09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a649bdcd522b916fa5f8c400be2d8cd9f"><td class="memItemLeft" align="right" valign="top"><a id="a649bdcd522b916fa5f8c400be2d8cd9f"></a>
boost::optional&lt; <a class="el" href="namespacemonero.html#aaa3433e5c51f3ac269204e7cd1bd5c4c">monero_tx_priority</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_priority</b></td></tr>
<tr class="separator:a649bdcd522b916fa5f8c400be2d8cd9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37f17b3ac07a4c085b1d9f2f48e494b1"><td class="memItemLeft" align="right" valign="top"><a id="a37f17b3ac07a4c085b1d9f2f48e494b1"></a>
boost::optional&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_ring_size</b></td></tr>
<tr class="separator:a37f17b3ac07a4c085b1d9f2f48e494b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a276407f6b96e22745f00c077f93e1d0c"><td class="memItemLeft" align="right" valign="top"><a id="a276407f6b96e22745f00c077f93e1d0c"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_fee</b></td></tr>
<tr class="separator:a276407f6b96e22745f00c077f93e1d0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b4a6643413b19e3c50fcf8feddbe766"><td class="memItemLeft" align="right" valign="top"><a id="a7b4a6643413b19e3c50fcf8feddbe766"></a>
boost::optional&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_account_index</b></td></tr>
<tr class="separator:a7b4a6643413b19e3c50fcf8feddbe766"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee33127566631fdae83aff8adbea766b"><td class="memItemLeft" align="right" valign="top"><a id="aee33127566631fdae83aff8adbea766b"></a>
std::vector&lt; uint32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_subaddress_indices</b></td></tr>
<tr class="separator:aee33127566631fdae83aff8adbea766b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f61a45f6d8abd48aa35e7a4b0430c14"><td class="memItemLeft" align="right" valign="top"><a id="a6f61a45f6d8abd48aa35e7a4b0430c14"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_unlock_height</b></td></tr>
<tr class="separator:a6f61a45f6d8abd48aa35e7a4b0430c14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a0a00c9234ab00ff08cdc5193faddfa"><td class="memItemLeft" align="right" valign="top"><a id="a8a0a00c9234ab00ff08cdc5193faddfa"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_can_split</b></td></tr>
<tr class="separator:a8a0a00c9234ab00ff08cdc5193faddfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0740f8b07e3b5c0ae51f4398e551ce9f"><td class="memItemLeft" align="right" valign="top"><a id="a0740f8b07e3b5c0ae51f4398e551ce9f"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_relay</b></td></tr>
<tr class="separator:a0740f8b07e3b5c0ae51f4398e551ce9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3394258322fa533930bf2d6367007ef"><td class="memItemLeft" align="right" valign="top"><a id="aa3394258322fa533930bf2d6367007ef"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_note</b></td></tr>
<tr class="separator:aa3394258322fa533930bf2d6367007ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a593655c4004fbc8ac64ed708451e7287"><td class="memItemLeft" align="right" valign="top"><a id="a593655c4004fbc8ac64ed708451e7287"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_recipient_name</b></td></tr>
<tr class="separator:a593655c4004fbc8ac64ed708451e7287"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4f17eaa00c62c96a5f0faa2735bf439"><td class="memItemLeft" align="right" valign="top"><a id="ae4f17eaa00c62c96a5f0faa2735bf439"></a>
boost::optional&lt; uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_below_amount</b></td></tr>
<tr class="separator:ae4f17eaa00c62c96a5f0faa2735bf439"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02830380841c2b166f926011bf53f775"><td class="memItemLeft" align="right" valign="top"><a id="a02830380841c2b166f926011bf53f775"></a>
boost::optional&lt; bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_sweep_each_subaddress</b></td></tr>
<tr class="separator:a02830380841c2b166f926011bf53f775"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a674c4fb24465eb3f156e63bc1c2f5151"><td class="memItemLeft" align="right" valign="top"><a id="a674c4fb24465eb3f156e63bc1c2f5151"></a>
boost::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>m_key_image</b></td></tr>
<tr class="separator:a674c4fb24465eb3f156e63bc1c2f5151"><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 transaction to send, sweep, or create a payment URI. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a0c9444c9febc075bcdd6b3854b742808"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c9444c9febc075bcdd6b3854b742808">&#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_tx_config::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>Implements <a class="el" href="structmonero_1_1serializable__struct.html#a3c53ab95b12f02db20cf20cd6d69ad4b">monero::serializable_struct</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.svg" width="104" height="31" alt="doxygen"/></a> 1.8.19
</small></address>
</body>
</html>