class_json_helper.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>openPilotLog: JsonHelper Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  17. <script type="text/javascript" src="search/searchdata.js"></script>
  18. <script type="text/javascript" src="search/search.js"></script>
  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  20. <link href="custom_dark_theme.css" rel="stylesheet" type="text/css"/>
  21. </head>
  22. <body>
  23. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  24. <div id="titlearea">
  25. <table cellspacing="0" cellpadding="0">
  26. <tbody>
  27. <tr style="height: 56px;">
  28. <td id="projectlogo"><img alt="Logo" src="icon_main.png"/></td>
  29. <td id="projectalign" style="padding-left: 0.5em;">
  30. <div id="projectname">openPilotLog
  31. </div>
  32. </td>
  33. </tr>
  34. </tbody>
  35. </table>
  36. </div>
  37. <!-- end header part -->
  38. <!-- Generated by Doxygen 1.9.1 -->
  39. <script type="text/javascript">
  40. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  41. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  42. /* @license-end */
  43. </script>
  44. <script type="text/javascript" src="menudata.js"></script>
  45. <script type="text/javascript" src="menu.js"></script>
  46. <script type="text/javascript">
  47. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  48. $(function() {
  49. initMenu('',true,false,'search.php','Search');
  50. $(document).ready(function() { init_search(); });
  51. });
  52. /* @license-end */</script>
  53. <div id="main-nav"></div>
  54. </div><!-- top -->
  55. <div id="side-nav" class="ui-resizable side-nav-resizable">
  56. <div id="nav-tree">
  57. <div id="nav-tree-contents">
  58. <div id="nav-sync" class="sync"></div>
  59. </div>
  60. </div>
  61. <div id="splitbar" style="-moz-user-select:none;"
  62. class="ui-resizable-handle">
  63. </div>
  64. </div>
  65. <script type="text/javascript">
  66. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  67. $(document).ready(function(){initNavTree('class_json_helper.html',''); initResizable(); });
  68. /* @license-end */
  69. </script>
  70. <div id="doc-content">
  71. <!-- window showing the filter options -->
  72. <div id="MSearchSelectWindow"
  73. onmouseover="return searchBox.OnSearchSelectShow()"
  74. onmouseout="return searchBox.OnSearchSelectHide()"
  75. onkeydown="return searchBox.OnSearchSelectKey(event)">
  76. </div>
  77. <!-- iframe showing the search results (closed by default) -->
  78. <div id="MSearchResultsWindow">
  79. <iframe src="javascript:void(0)" frameborder="0"
  80. name="MSearchResults" id="MSearchResults">
  81. </iframe>
  82. </div>
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#pub-methods">Public Member Functions</a> &#124;
  86. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  87. <a href="class_json_helper-members.html">List of all members</a> </div>
  88. <div class="headertitle">
  89. <div class="title">JsonHelper Class Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <p>The <a class="el" href="class_json_helper.html" title="The JsonHelper class is responsible for parsing the database (sqlite) to and from JSON.">JsonHelper</a> class is responsible for parsing the database (sqlite) to and from JSON.
  93. <a href="class_json_helper.html#details">More...</a></p>
  94. <p><code>#include &lt;<a class="el" href="jsonhelper_8h_source.html">jsonhelper.h</a>&gt;</code></p>
  95. <table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  97. Public Member Functions</h2></td></tr>
  98. <tr class="memitem:a875c6d20356802f2868fa4a220f04cd1"><td class="memItemLeft" align="right" valign="top"><a id="a875c6d20356802f2868fa4a220f04cd1"></a>
  99. &#160;</td><td class="memItemRight" valign="bottom"><b>JsonHelper</b> (QFileInfo database_file)</td></tr>
  100. <tr class="separator:a875c6d20356802f2868fa4a220f04cd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table><table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  103. Static Public Member Functions</h2></td></tr>
  104. <tr class="memitem:aea5f8bc11b1c77551c1c896c28bc24ad"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_helper.html#aea5f8bc11b1c77551c1c896c28bc24ad">exportDatabase</a> ()</td></tr>
  105. <tr class="memdesc:aea5f8bc11b1c77551c1c896c28bc24ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">exportDatabase exports the currently active database to JSON. <a href="class_json_helper.html#aea5f8bc11b1c77551c1c896c28bc24ad">More...</a><br /></td></tr>
  106. <tr class="separator:aea5f8bc11b1c77551c1c896c28bc24ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a59abc8b7ba32048737a1dfe2e6e57dc4"><td class="memItemLeft" align="right" valign="top"><a id="a59abc8b7ba32048737a1dfe2e6e57dc4"></a>
  108. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_helper.html#a59abc8b7ba32048737a1dfe2e6e57dc4">importDatabase</a> ()</td></tr>
  109. <tr class="memdesc:a59abc8b7ba32048737a1dfe2e6e57dc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">importDatabase imports a dataset from JSON. Files need to be at AStanardPaths::JSON for now. <br /></td></tr>
  110. <tr class="separator:a59abc8b7ba32048737a1dfe2e6e57dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:af786e08a3a0559bd3febf2e154024048"><td class="memItemLeft" align="right" valign="top">static QJsonDocument&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_helper.html#af786e08a3a0559bd3febf2e154024048">readFileToDoc</a> (const QString &amp;file_path)</td></tr>
  112. <tr class="memdesc:af786e08a3a0559bd3febf2e154024048"><td class="mdescLeft">&#160;</td><td class="mdescRight">readToDocument reads data from a JSON file into a QJSonDocument <a href="class_json_helper.html#af786e08a3a0559bd3febf2e154024048">More...</a><br /></td></tr>
  113. <tr class="separator:af786e08a3a0559bd3febf2e154024048"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a1c5fe445db6068ead319094e229cdbb7"><td class="memItemLeft" align="right" valign="top"><a id="a1c5fe445db6068ead319094e229cdbb7"></a>
  115. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_helper.html#a1c5fe445db6068ead319094e229cdbb7">writeDocToFile</a> (const QJsonDocument &amp;doc, const QString &amp;file_name)</td></tr>
  116. <tr class="memdesc:a1c5fe445db6068ead319094e229cdbb7"><td class="mdescLeft">&#160;</td><td class="mdescRight">writes a QJsonDocument to a file <br /></td></tr>
  117. <tr class="separator:a1c5fe445db6068ead319094e229cdbb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table>
  119. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  120. <div class="textblock"><p>The <a class="el" href="class_json_helper.html" title="The JsonHelper class is responsible for parsing the database (sqlite) to and from JSON.">JsonHelper</a> class is responsible for parsing the database (sqlite) to and from JSON. </p>
  121. </div><h2 class="groupheader">Member Function Documentation</h2>
  122. <a id="aea5f8bc11b1c77551c1c896c28bc24ad"></a>
  123. <h2 class="memtitle"><span class="permalink"><a href="#aea5f8bc11b1c77551c1c896c28bc24ad">&#9670;&nbsp;</a></span>exportDatabase()</h2>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="mlabels">
  127. <tr>
  128. <td class="mlabels-left">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">void JsonHelper::exportDatabase </td>
  132. <td>(</td>
  133. <td class="paramname"></td><td>)</td>
  134. <td></td>
  135. </tr>
  136. </table>
  137. </td>
  138. <td class="mlabels-right">
  139. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p>exportDatabase exports the currently active database to JSON. </p>
  144. <p>QJsonObject can be constructed from QHash&lt;QString, QVariant&gt; aka QVariantmap. All rows are put into a QJsonArray and the Array is embedded into a QJsonDocument, which can be exported. The files are created at Paths::Export. </p>
  145. </div>
  146. </div>
  147. <a id="af786e08a3a0559bd3febf2e154024048"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#af786e08a3a0559bd3febf2e154024048">&#9670;&nbsp;</a></span>readFileToDoc()</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="mlabels">
  152. <tr>
  153. <td class="mlabels-left">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname">QJsonDocument JsonHelper::readFileToDoc </td>
  157. <td>(</td>
  158. <td class="paramtype">const QString &amp;&#160;</td>
  159. <td class="paramname"><em>file_path</em></td><td>)</td>
  160. <td></td>
  161. </tr>
  162. </table>
  163. </td>
  164. <td class="mlabels-right">
  165. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <p>readToDocument reads data from a JSON file into a QJSonDocument </p>
  170. <dl class="params"><dt>Parameters</dt><dd>
  171. <table class="params">
  172. <tr><td class="paramname">file_path</td><td></td></tr>
  173. </table>
  174. </dd>
  175. </dl>
  176. </div>
  177. </div>
  178. <hr/>The documentation for this class was generated from the following files:<ul>
  179. <li>src/classes/<a class="el" href="jsonhelper_8h_source.html">jsonhelper.h</a></li>
  180. <li>src/classes/jsonhelper.cpp</li>
  181. </ul>
  182. </div><!-- contents -->
  183. </div><!-- doc-content -->
  184. <!-- start footer part -->
  185. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  186. <ul>
  187. <li class="navelem"><a class="el" href="class_json_helper.html">JsonHelper</a></li>
  188. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
  189. </ul>
  190. </div>
  191. </body>
  192. </html>