wownero-cpp/docs/structmonero_1_1serializable__struct.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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: monero::serializable_struct 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.20 -->
<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_1serializable__struct.html">serializable_struct</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structmonero_1_1serializable__struct-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">monero::serializable_struct 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__daemon__model_8h_source.html">monero_daemon_model.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for monero::serializable_struct:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structmonero_1_1serializable__struct.png" usemap="#monero::serializable_5Fstruct_map" alt=""/>
  <map id="monero::serializable_5Fstruct_map" name="monero::serializable_5Fstruct_map">
<area href="structmonero_1_1monero__account.html" alt="monero::monero_account" shape="rect" coords="265,56,520,80"/>
<area href="structmonero_1_1monero__address__book__entry.html" alt="monero::monero_address_book_entry" shape="rect" coords="265,112,520,136"/>
<area href="structmonero_1_1monero__block__header.html" alt="monero::monero_block_header" shape="rect" coords="265,168,520,192"/>
<area href="structmonero_1_1monero__check.html" alt="monero::monero_check" shape="rect" coords="265,224,520,248"/>
<area href="structmonero_1_1monero__integrated__address.html" alt="monero::monero_integrated_address" shape="rect" coords="265,280,520,304"/>
<area href="structmonero_1_1monero__key__image.html" alt="monero::monero_key_image" shape="rect" coords="265,336,520,360"/>
<area href="structmonero_1_1monero__key__image__import__result.html" alt="monero::monero_key_image_import_result" shape="rect" coords="265,392,520,416"/>
<area href="structmonero_1_1monero__message__signature__result.html" alt="monero::monero_message_signature_result" shape="rect" coords="265,448,520,472"/>
<area href="structmonero_1_1monero__multisig__info.html" alt="monero::monero_multisig_info" shape="rect" coords="265,504,520,528"/>
<area href="structmonero_1_1monero__multisig__init__result.html" alt="monero::monero_multisig_init_result" shape="rect" coords="265,560,520,584"/>
<area href="structmonero_1_1monero__multisig__sign__result.html" alt="monero::monero_multisig_sign_result" shape="rect" coords="265,616,520,640"/>
<area href="structmonero_1_1monero__output.html" alt="monero::monero_output" shape="rect" coords="265,672,520,696"/>
<area href="structmonero_1_1monero__rpc__connection.html" alt="monero::monero_rpc_connection" shape="rect" coords="265,728,520,752"/>
<area href="structmonero_1_1monero__subaddress.html" alt="monero::monero_subaddress" shape="rect" coords="265,784,520,808"/>
<area href="structmonero_1_1monero__sync__result.html" alt="monero::monero_sync_result" shape="rect" coords="265,840,520,864"/>
<area href="structmonero_1_1monero__transfer.html" alt="monero::monero_transfer" shape="rect" coords="265,896,520,920"/>
<area href="structmonero_1_1monero__tx.html" alt="monero::monero_tx" shape="rect" coords="265,952,520,976"/>
<area href="structmonero_1_1monero__tx__config.html" alt="monero::monero_tx_config" shape="rect" coords="265,1008,520,1032"/>
<area href="structmonero_1_1monero__tx__set.html" alt="monero::monero_tx_set" shape="rect" coords="265,1064,520,1088"/>
<area href="structmonero_1_1monero__version.html" alt="monero::monero_version" shape="rect" coords="265,1120,520,1144"/>
  </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: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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c53ab95b12f02db20cf20cd6d69ad4b"><td class="memItemLeft" align="right" valign="top">virtual rapidjson::Value&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmonero_1_1serializable__struct.html#a3c53ab95b12f02db20cf20cd6d69ad4b">to_rapidjson_val</a> (rapidjson::Document::AllocatorType &amp;allocator) const =0</td></tr>
<tr class="separator:a3c53ab95b12f02db20cf20cd6d69ad4b"><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>Base struct which can be serialized. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a723e44b22962d02d3f78bc7c2043dc1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a723e44b22962d02d3f78bc7c2043dc1e">&#9670;&nbsp;</a></span>serialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string monero::serializable_struct::serialize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Serializes the struct to a json std::string.</p>
<dl class="section return"><dt>Returns</dt><dd>the struct serialized to a json std::string </dd></dl>

</div>
</div>
<a id="a3c53ab95b12f02db20cf20cd6d69ad4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c53ab95b12f02db20cf20cd6d69ad4b">&#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">virtual rapidjson::Value monero::serializable_struct::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">pure 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>Implemented in <a class="el" href="structmonero_1_1monero__address__book__entry.html#a581c7ca994d40a7518b8b2aee9f7fd19">monero::monero_address_book_entry</a>, <a class="el" href="structmonero_1_1monero__multisig__sign__result.html#a2f3a44d2d301cc1d4689f1ce22e1b1c6">monero::monero_multisig_sign_result</a>, <a class="el" href="structmonero_1_1monero__multisig__init__result.html#a58d52e773d96251edfeba893ca5cdf51">monero::monero_multisig_init_result</a>, <a class="el" href="structmonero_1_1monero__multisig__info.html#a74b60f619cbb3bd5cc7e90962cf91305">monero::monero_multisig_info</a>, <a class="el" href="structmonero_1_1monero__check__reserve.html#ab86672fe20e03b108b101496b3ebe6f3">monero::monero_check_reserve</a>, <a class="el" href="structmonero_1_1monero__check__tx.html#aa58bcd6250ea88c7ab9298e4d70896a6">monero::monero_check_tx</a>, <a class="el" href="structmonero_1_1monero__check.html#a405a6322e58b150cc3643e0569039ceb">monero::monero_check</a>, <a class="el" href="structmonero_1_1monero__message__signature__result.html#a946c26767fd373e7cbce469459589fdb">monero::monero_message_signature_result</a>, <a class="el" href="structmonero_1_1monero__key__image__import__result.html#ad8212a1e966156dc3465eaff06f2c285">monero::monero_key_image_import_result</a>, <a class="el" href="structmonero_1_1monero__tx__config.html#a0c9444c9febc075bcdd6b3854b742808">monero::monero_tx_config</a>, <a class="el" href="structmonero_1_1monero__integrated__address.html#ab90b92ee287a2803a6d80742daddf6bd">monero::monero_integrated_address</a>, <a class="el" href="structmonero_1_1monero__tx__set.html#a1790e49c74e30198cf1509be63ec7632">monero::monero_tx_set</a>, <a class="el" href="structmonero_1_1monero__tx__query.html#a2355afaf070c49ae18fee757145e2391">monero::monero_tx_query</a>, <a class="el" href="structmonero_1_1monero__tx__wallet.html#ab00bc1f8108ea8f863418ab1418bb801">monero::monero_tx_wallet</a>, <a class="el" href="structmonero_1_1monero__output__query.html#ada2d3e0d4de47ec56ec6213a7643e774">monero::monero_output_query</a>, <a class="el" href="structmonero_1_1monero__output__wallet.html#a67d006fa99d921d67b16b01b22697b27">monero::monero_output_wallet</a>, <a class="el" href="structmonero_1_1monero__transfer__query.html#a04694bb70b70a24b2eb347f127c2aed8">monero::monero_transfer_query</a>, <a class="el" href="structmonero_1_1monero__outgoing__transfer.html#ae2252aa8350174cb8a365ba8fd617c68">monero::monero_outgoing_transfer</a>, <a class="el" href="structmonero_1_1monero__incoming__transfer.html#a085ed3aefec908c716f35ab4e1692708">monero::monero_incoming_transfer</a>, <a class="el" href="structmonero_1_1monero__transfer.html#ae34c855d2139c06df65ee46be86df9e6">monero::monero_transfer</a>, <a class="el" href="structmonero_1_1monero__account.html#a5329f389c5ca07a8aaa3e22900118472">monero::monero_account</a>, <a class="el" href="structmonero_1_1monero__subaddress.html#a481f939434c4a6cb631d3d27daf77db5">monero::monero_subaddress</a>, <a class="el" href="structmonero_1_1monero__sync__result.html#a554b3c5d14d71f256f0ed3dcfec67f15">monero::monero_sync_result</a>, <a class="el" href="structmonero_1_1monero__output.html#a5a2d6361b4ca65dc0088f6c2efdabea7">monero::monero_output</a>, <a class="el" href="structmonero_1_1monero__key__image.html#a66c0231759cad5692f90b731677e2127">monero::monero_key_image</a>, <a class="el" href="structmonero_1_1monero__tx.html#a17cef8cbfdb09e73ad48873db3095115">monero::monero_tx</a>, <a class="el" href="structmonero_1_1monero__block.html#aff7b5fbba400067c049aed9afaf8359b">monero::monero_block</a>, <a class="el" href="structmonero_1_1monero__block__header.html#a7d75c164db7b4b16c50bec984b32b134">monero::monero_block_header</a>, <a class="el" href="structmonero_1_1monero__rpc__connection.html#ab6402ce8b8beb9d72bf6c475711850d7">monero::monero_rpc_connection</a>, and <a class="el" href="structmonero_1_1monero__version.html#ad6f7ed41f9888f28b37a0a68498d0bd9">monero::monero_version</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>daemon/<a class="el" href="monero__daemon__model_8h_source.html">monero_daemon_model.h</a></li>
<li>daemon/monero_daemon_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.20
</small></address>
</body>
</html>