dbsummary_8h_source.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  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: src/database/dbsummary.h Source File</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('dbsummary_8h_source.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="headertitle">
  85. <div class="title">dbsummary.h</div> </div>
  86. </div><!--header-->
  87. <div class="contents">
  88. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
  89. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *openPilotLog - A FOSS Pilot Logbook Application</span></div>
  90. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *Copyright (C) 2020-2022 Felix Turowsky</span></div>
  91. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  92. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *This program is free software: you can redistribute it and/or modify</span></div>
  93. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *it under the terms of the GNU General Public License as published by</span></div>
  94. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *the Free Software Foundation, either version 3 of the License, or</span></div>
  95. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *(at your option) any later version.</span></div>
  96. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
  97. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *This program is distributed in the hope that it will be useful,</span></div>
  98. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
  99. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
  100. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *GNU General Public License for more details.</span></div>
  101. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> *</span></div>
  102. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *You should have received a copy of the GNU General Public License</span></div>
  103. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.</span></div>
  104. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> */</span></div>
  105. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#ifndef DBSUMMARY_H</span></div>
  106. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define DBSUMMARY_H</span></div>
  107. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
  108. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;src/database/database.h&quot;</span></div>
  109. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
  110. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_o_p_l.html">OPL</a> {</div>
  111. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
  112. <div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="namespace_o_p_l.html#a57a78a0fee920e2605638d9fea82b57e"> 28</a></span>&#160;<span class="keyword">enum class</span> <a class="code" href="namespace_o_p_l.html#a57a78a0fee920e2605638d9fea82b57e">DbSummaryKey</a> {</div>
  113. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; total_flights,</div>
  114. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; total_tails,</div>
  115. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; total_pilots,</div>
  116. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; last_flight,</div>
  117. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; total_time,</div>
  118. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;};</div>
  119. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
  120. <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="class_o_p_l_1_1_db_summary.html"> 44</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_o_p_l_1_1_db_summary.html">DbSummary</a> : <span class="keyword">public</span> QObject</div>
  121. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;{</div>
  122. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keyword">public</span>:</div>
  123. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="class_o_p_l_1_1_db_summary.html">DbSummary</a>() = <span class="keywordflow">default</span>;</div>
  124. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
  125. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> QMap&lt;DbSummaryKey, QString&gt; <a class="code" href="class_o_p_l_1_1_db_summary.html#a7f82bff756d73d1430fda9681fb4a66e">databaseSummary</a>(<span class="keyword">const</span> QString&amp; db_path);</div>
  126. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
  127. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> QString <a class="code" href="class_o_p_l_1_1_db_summary.html#a64a8a01526b171f5376eae880a7fd148">summaryString</a>(<span class="keyword">const</span> QString&amp; db_path);</div>
  128. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
  129. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keyword">private</span>:</div>
  130. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; Q_OBJECT</div>
  131. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keyword">static</span> QString SQLITE_DRIVER = QStringLiteral(<span class="stringliteral">&quot;QSQLITE&quot;</span>);</div>
  132. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
  133. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;};</div>
  134. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
  135. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
  136. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;} <span class="comment">// namespace OPL</span></div>
  137. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
  138. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// DBSUMMARY_H</span></div>
  139. <div class="ttc" id="aclass_o_p_l_1_1_db_summary_html"><div class="ttname"><a href="class_o_p_l_1_1_db_summary.html">OPL::DbSummary</a></div><div class="ttdoc">The DbSummary class collects summaries of entries and relevant data from the database.</div><div class="ttdef"><b>Definition:</b> dbsummary.h:45</div></div>
  140. <div class="ttc" id="aclass_o_p_l_1_1_db_summary_html_a64a8a01526b171f5376eae880a7fd148"><div class="ttname"><a href="class_o_p_l_1_1_db_summary.html#a64a8a01526b171f5376eae880a7fd148">OPL::DbSummary::summaryString</a></div><div class="ttdeci">static const QString summaryString(const QString &amp;db_path)</div><div class="ttdoc">returns a short summary string of the database, containing total time and date of last flight.</div><div class="ttdef"><b>Definition:</b> dbsummary.cpp:83</div></div>
  141. <div class="ttc" id="aclass_o_p_l_1_1_db_summary_html_a7f82bff756d73d1430fda9681fb4a66e"><div class="ttname"><a href="class_o_p_l_1_1_db_summary.html#a7f82bff756d73d1430fda9681fb4a66e">OPL::DbSummary::databaseSummary</a></div><div class="ttdeci">static const QMap&lt; DbSummaryKey, QString &gt; databaseSummary(const QString &amp;db_path)</div><div class="ttdoc">Return a summary of a database.</div><div class="ttdef"><b>Definition:</b> dbsummary.cpp:22</div></div>
  142. <div class="ttc" id="anamespace_o_p_l_html"><div class="ttname"><a href="namespace_o_p_l.html">OPL</a></div><div class="ttdoc">A namespace to collect constants and enums used throughout the application.</div><div class="ttdef"><b>Definition:</b> paths.cpp:3</div></div>
  143. <div class="ttc" id="anamespace_o_p_l_html_a57a78a0fee920e2605638d9fea82b57e"><div class="ttname"><a href="namespace_o_p_l.html#a57a78a0fee920e2605638d9fea82b57e">OPL::DbSummaryKey</a></div><div class="ttdeci">DbSummaryKey</div><div class="ttdoc">Enumerates the QHash keys used when summarising a database.</div><div class="ttdef"><b>Definition:</b> dbsummary.h:28</div></div>
  144. </div><!-- fragment --></div><!-- contents -->
  145. </div><!-- doc-content -->
  146. <!-- start footer part -->
  147. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  148. <ul>
  149. <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_803ee67260c130b45d29089798491ab2.html">database</a></li><li class="navelem"><b>dbsummary.h</b></li>
  150. <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>
  151. </ul>
  152. </div>
  153. </body>
  154. </html>