123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202 |
- <!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.9.1"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>openPilotLog: JsonHelper Class 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="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="navtreedata.js"></script>
- <script type="text/javascript" src="navtree.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" />
- <link href="custom_dark_theme.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="projectlogo"><img alt="Logo" src="icon_main.png"/></td>
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">openPilotLog
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.1 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&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>
- </div><!-- top -->
- <div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- <div id="nav-sync" class="sync"></div>
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
- </div>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(document).ready(function(){initNavTree('class_json_helper.html',''); initResizable(); });
- /* @license-end */
- </script>
- <div id="doc-content">
- <!-- 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 class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="class_json_helper-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">JsonHelper Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <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.
- <a href="class_json_helper.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="jsonhelper_8h_source.html">jsonhelper.h</a>></code></p>
- <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:a875c6d20356802f2868fa4a220f04cd1"><td class="memItemLeft" align="right" valign="top"><a id="a875c6d20356802f2868fa4a220f04cd1"></a>
-  </td><td class="memItemRight" valign="bottom"><b>JsonHelper</b> (QFileInfo database_file)</td></tr>
- <tr class="separator:a875c6d20356802f2868fa4a220f04cd1"><td class="memSeparator" colspan="2"> </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:aea5f8bc11b1c77551c1c896c28bc24ad"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_helper.html#aea5f8bc11b1c77551c1c896c28bc24ad">exportDatabase</a> ()</td></tr>
- <tr class="memdesc:aea5f8bc11b1c77551c1c896c28bc24ad"><td class="mdescLeft"> </td><td class="mdescRight">exportDatabase exports the currently active database to JSON. <a href="class_json_helper.html#aea5f8bc11b1c77551c1c896c28bc24ad">More...</a><br /></td></tr>
- <tr class="separator:aea5f8bc11b1c77551c1c896c28bc24ad"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a59abc8b7ba32048737a1dfe2e6e57dc4"><td class="memItemLeft" align="right" valign="top"><a id="a59abc8b7ba32048737a1dfe2e6e57dc4"></a>
- static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_helper.html#a59abc8b7ba32048737a1dfe2e6e57dc4">importDatabase</a> ()</td></tr>
- <tr class="memdesc:a59abc8b7ba32048737a1dfe2e6e57dc4"><td class="mdescLeft"> </td><td class="mdescRight">importDatabase imports a dataset from JSON. Files need to be at AStanardPaths::JSON for now. <br /></td></tr>
- <tr class="separator:a59abc8b7ba32048737a1dfe2e6e57dc4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af786e08a3a0559bd3febf2e154024048"><td class="memItemLeft" align="right" valign="top">static QJsonDocument </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_helper.html#af786e08a3a0559bd3febf2e154024048">readFileToDoc</a> (const QString &file_path)</td></tr>
- <tr class="memdesc:af786e08a3a0559bd3febf2e154024048"><td class="mdescLeft"> </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>
- <tr class="separator:af786e08a3a0559bd3febf2e154024048"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1c5fe445db6068ead319094e229cdbb7"><td class="memItemLeft" align="right" valign="top"><a id="a1c5fe445db6068ead319094e229cdbb7"></a>
- static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_helper.html#a1c5fe445db6068ead319094e229cdbb7">writeDocToFile</a> (const QJsonDocument &doc, const QString &file_name)</td></tr>
- <tr class="memdesc:a1c5fe445db6068ead319094e229cdbb7"><td class="mdescLeft"> </td><td class="mdescRight">writes a QJsonDocument to a file <br /></td></tr>
- <tr class="separator:a1c5fe445db6068ead319094e229cdbb7"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <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>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a id="aea5f8bc11b1c77551c1c896c28bc24ad"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aea5f8bc11b1c77551c1c896c28bc24ad">◆ </a></span>exportDatabase()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void JsonHelper::exportDatabase </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>exportDatabase exports the currently active database to JSON. </p>
- <p>QJsonObject can be constructed from QHash<QString, QVariant> 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>
- </div>
- </div>
- <a id="af786e08a3a0559bd3febf2e154024048"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af786e08a3a0559bd3febf2e154024048">◆ </a></span>readFileToDoc()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">QJsonDocument JsonHelper::readFileToDoc </td>
- <td>(</td>
- <td class="paramtype">const QString & </td>
- <td class="paramname"><em>file_path</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>readToDocument reads data from a JSON file into a QJSonDocument </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">file_path</td><td></td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>src/classes/<a class="el" href="jsonhelper_8h_source.html">jsonhelper.h</a></li>
- <li>src/classes/jsonhelper.cpp</li>
- </ul>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="navelem"><a class="el" href="class_json_helper.html">JsonHelper</a></li>
- <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>
- </ul>
- </div>
- </body>
- </html>
|