namespaceexperimental.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  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.8.20"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>openPilotLog: experimental Namespace 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="projectalign" style="padding-left: 0.5em;">
  29. <div id="projectname">openPilotLog
  30. </div>
  31. </td>
  32. </tr>
  33. </tbody>
  34. </table>
  35. </div>
  36. <!-- end header part -->
  37. <!-- Generated by Doxygen 1.8.20 -->
  38. <script type="text/javascript">
  39. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  40. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  41. /* @license-end */
  42. </script>
  43. <script type="text/javascript" src="menudata.js"></script>
  44. <script type="text/javascript" src="menu.js"></script>
  45. <script type="text/javascript">
  46. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  47. $(function() {
  48. initMenu('',true,false,'search.php','Search');
  49. $(document).ready(function() { init_search(); });
  50. });
  51. /* @license-end */</script>
  52. <div id="main-nav"></div>
  53. </div><!-- top -->
  54. <div id="side-nav" class="ui-resizable side-nav-resizable">
  55. <div id="nav-tree">
  56. <div id="nav-tree-contents">
  57. <div id="nav-sync" class="sync"></div>
  58. </div>
  59. </div>
  60. <div id="splitbar" style="-moz-user-select:none;"
  61. class="ui-resizable-handle">
  62. </div>
  63. </div>
  64. <script type="text/javascript">
  65. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  66. $(document).ready(function(){initNavTree('namespaceexperimental.html',''); initResizable(); });
  67. /* @license-end */
  68. </script>
  69. <div id="doc-content">
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div class="header">
  83. <div class="summary">
  84. <a href="#nested-classes">Classes</a> &#124;
  85. <a href="#typedef-members">Typedefs</a> &#124;
  86. <a href="#enum-members">Enumerations</a> &#124;
  87. <a href="#func-members">Functions</a> &#124;
  88. <a href="#var-members">Variables</a> </div>
  89. <div class="headertitle">
  90. <div class="title">experimental Namespace Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <p>Temporary namespace for experimental features. Will be removed in later versions.
  94. <a href="namespaceexperimental.html#details">More...</a></p>
  95. <table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  97. Classes</h2></td></tr>
  98. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structexperimental_1_1_a_aircraft_entry.html">AAircraftEntry</a></td></tr>
  99. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classexperimental_1_1_a_database.html">ADatabase</a></td></tr>
  101. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The DB class encapsulates the SQL database by providing fast access to hot database data. <a href="classexperimental_1_1_a_database.html#details">More...</a><br /></td></tr>
  102. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classexperimental_1_1_a_database_error.html">ADatabaseError</a></td></tr>
  104. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Custom Database Error derived from QSqlError. Extends text() adding "Database Error: " before the text. <a href="classexperimental_1_1_a_database_error.html#details">More...</a><br /></td></tr>
  105. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classexperimental_1_1_a_entry.html">AEntry</a></td></tr>
  107. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Entry class encapsulates table metadata(table name, row id) and data for new and existing entries in the database to operate on. <a href="classexperimental_1_1_a_entry.html#details">More...</a><br /></td></tr>
  108. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classexperimental_1_1_a_flight_entry.html">AFlightEntry</a></td></tr>
  110. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structexperimental_1_1_a_pilot_entry.html">APilotEntry</a></td></tr>
  112. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structexperimental_1_1_a_tail_entry.html">ATailEntry</a></td></tr>
  114. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structexperimental_1_1_data_position.html">DataPosition</a></td></tr>
  116. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classexperimental_1_1_user_input.html">UserInput</a></td></tr>
  118. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The EntryData struct. Contains ALL possible data. However depending on who is constructing it, different types are initialised. FUTURE: Would it be necessary to able to change data? George: I would say no because we dont want to fuck around with the entry. Collect data from user -&gt; Pack it up in the entry -&gt; Consume it. <a href="classexperimental_1_1_user_input.html#details">More...</a><br /></td></tr>
  119. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table><table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  122. Typedefs</h2></td></tr>
  123. <tr class="memitem:a76d743fc188a8749586879cb92b03d32"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceexperimental.html#a76d743fc188a8749586879cb92b03d32">ColName</a> = QString</td></tr>
  124. <tr class="memdesc:a76d743fc188a8749586879cb92b03d32"><td class="mdescLeft">&#160;</td><td class="mdescRight">An alias for QString. <a href="namespaceexperimental.html#a76d743fc188a8749586879cb92b03d32">More...</a><br /></td></tr>
  125. <tr class="separator:a76d743fc188a8749586879cb92b03d32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:af474dfeadc39a1c2e3f43d0599291d38"><td class="memItemLeft" align="right" valign="top"><a id="af474dfeadc39a1c2e3f43d0599291d38"></a>
  127. using&#160;</td><td class="memItemRight" valign="bottom"><b>ColData</b> = QVariant</td></tr>
  128. <tr class="separator:af474dfeadc39a1c2e3f43d0599291d38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:acd0ee32d7abd56aa1a5a5e036ff7f15d"><td class="memItemLeft" align="right" valign="top"><a id="acd0ee32d7abd56aa1a5a5e036ff7f15d"></a>
  130. using&#160;</td><td class="memItemRight" valign="bottom"><b>TableName</b> = QString</td></tr>
  131. <tr class="separator:acd0ee32d7abd56aa1a5a5e036ff7f15d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a8a8ceb9d4b823e0af1fc4a6027ca555b"><td class="memItemLeft" align="right" valign="top"><a id="a8a8ceb9d4b823e0af1fc4a6027ca555b"></a>
  133. using&#160;</td><td class="memItemRight" valign="bottom"><b>RowId</b> = int</td></tr>
  134. <tr class="separator:a8a8ceb9d4b823e0af1fc4a6027ca555b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a603205bf7834d8dbc57758989cbee13b"><td class="memItemLeft" align="right" valign="top"><a id="a603205bf7834d8dbc57758989cbee13b"></a>
  136. using&#160;</td><td class="memItemRight" valign="bottom"><b>TableNames</b> = QStringList</td></tr>
  137. <tr class="separator:a603205bf7834d8dbc57758989cbee13b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a01da8376fbde5916551d8769978953c5"><td class="memItemLeft" align="right" valign="top"><a id="a01da8376fbde5916551d8769978953c5"></a>
  139. using&#160;</td><td class="memItemRight" valign="bottom"><b>TableData</b> = QMap&lt; <a class="el" href="namespaceexperimental.html#a76d743fc188a8749586879cb92b03d32">ColName</a>, ColData &gt;</td></tr>
  140. <tr class="separator:a01da8376fbde5916551d8769978953c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a6fb99af0e3d897a0234539333b812016"><td class="memItemLeft" align="right" valign="top"><a id="a6fb99af0e3d897a0234539333b812016"></a>
  142. using&#160;</td><td class="memItemRight" valign="bottom"><b>ColumnData</b> = QPair&lt; <a class="el" href="namespaceexperimental.html#a76d743fc188a8749586879cb92b03d32">ColName</a>, ColData &gt;</td></tr>
  143. <tr class="separator:a6fb99af0e3d897a0234539333b812016"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a66358bd419ea3d31d254199463a67a56"><td class="memItemLeft" align="right" valign="top"><a id="a66358bd419ea3d31d254199463a67a56"></a>
  145. using&#160;</td><td class="memItemRight" valign="bottom"><b>ColumnNames</b> = QStringList</td></tr>
  146. <tr class="separator:a66358bd419ea3d31d254199463a67a56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a81fa2fc4988b2cfe1c9d9e1a1fadc2f8"><td class="memItemLeft" align="right" valign="top"><a id="a81fa2fc4988b2cfe1c9d9e1a1fadc2f8"></a>
  148. using&#160;</td><td class="memItemRight" valign="bottom"><b>TableColumns</b> = QMap&lt; TableName, ColumnNames &gt;</td></tr>
  149. <tr class="separator:a81fa2fc4988b2cfe1c9d9e1a1fadc2f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:aa7223fd06d1710c8f3e7f04b59a2904d"><td class="memItemLeft" align="right" valign="top"><a id="aa7223fd06d1710c8f3e7f04b59a2904d"></a>
  151. using&#160;</td><td class="memItemRight" valign="bottom"><b>EntryData</b> = QMap&lt; QString, QString &gt;</td></tr>
  152. <tr class="separator:aa7223fd06d1710c8f3e7f04b59a2904d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. </table><table class="memberdecls">
  154. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  155. Enumerations</h2></td></tr>
  156. <tr class="memitem:a4ae0b93d398c270c979a8eec17545b8a"><td class="memItemLeft" align="right" valign="top"><a id="a4ae0b93d398c270c979a8eec17545b8a"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceexperimental.html#a4ae0b93d398c270c979a8eec17545b8a">ADatabaseTarget</a> { <br />
  157. &#160;&#160;<b>airport_identifier_icao</b>,
  158. <b>airport_identifier_iata</b>,
  159. <b>airport_identifier_all</b>,
  160. <b>airport_names</b>,
  161. <br />
  162. &#160;&#160;<b>pilots</b>,
  163. <b>registrations</b>,
  164. <b>aircraft</b>,
  165. <b>companies</b>,
  166. <br />
  167. &#160;&#160;<b>tails</b>
  168. <br />
  169. }</td></tr>
  170. <tr class="memdesc:a4ae0b93d398c270c979a8eec17545b8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The DBTarget enum provides the items for which QCompleter completion lists are provided from the database. <br /></td></tr>
  171. <tr class="separator:a4ae0b93d398c270c979a8eec17545b8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. </table><table class="memberdecls">
  173. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  174. Functions</h2></td></tr>
  175. <tr class="memitem:a3f601400554a3aab738cab39bfa5cc7e"><td class="memItemLeft" align="right" valign="top"><a id="a3f601400554a3aab738cab39bfa5cc7e"></a>
  176. <a class="el" href="classexperimental_1_1_a_database.html">ADatabase</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceexperimental.html#a3f601400554a3aab738cab39bfa5cc7e">aDB</a> ()</td></tr>
  177. <tr class="memdesc:a3f601400554a3aab738cab39bfa5cc7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convinience function that returns instance of DataBase. Instead of this: DataBase::getInstance().commit(...) Write this: <a class="el" href="namespaceexperimental.html#a3f601400554a3aab738cab39bfa5cc7e" title="Convinience function that returns instance of DataBase. Instead of this: DataBase::getInstance()....">aDB()</a>-&gt;commit(...) <br /></td></tr>
  178. <tr class="separator:a3f601400554a3aab738cab39bfa5cc7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:aea36ebaa5a084c8fa5eec118584723f2"><td class="memItemLeft" align="right" valign="top"><a id="aea36ebaa5a084c8fa5eec118584723f2"></a>
  180. <a class="el" href="classexperimental_1_1_user_input.html">UserInput</a>&#160;</td><td class="memItemRight" valign="bottom"><b>newPilotInput</b> (EntryData ed)</td></tr>
  181. <tr class="separator:aea36ebaa5a084c8fa5eec118584723f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:a51043728b158c4be62d11caa7aaecab0"><td class="memItemLeft" align="right" valign="top"><a id="a51043728b158c4be62d11caa7aaecab0"></a>
  183. <a class="el" href="classexperimental_1_1_user_input.html">UserInput</a>&#160;</td><td class="memItemRight" valign="bottom"><b>newFlightInput</b> (EntryData ed)</td></tr>
  184. <tr class="separator:a51043728b158c4be62d11caa7aaecab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:aff4a64912874a0532ca560845b90499e"><td class="memItemLeft" align="right" valign="top"><a id="aff4a64912874a0532ca560845b90499e"></a>
  186. <a class="el" href="classexperimental_1_1_user_input.html">UserInput</a>&#160;</td><td class="memItemRight" valign="bottom"><b>newAircraftInput</b> (EntryData ed)</td></tr>
  187. <tr class="separator:aff4a64912874a0532ca560845b90499e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. </table><table class="memberdecls">
  189. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
  190. Variables</h2></td></tr>
  191. <tr class="memitem:a9363999814f09e4ac0f75b7710e01308"><td class="memItemLeft" align="right" valign="top"><a id="a9363999814f09e4ac0f75b7710e01308"></a>
  192. auto const&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_PILOT_POSITION</b> = <a class="el" href="structexperimental_1_1_data_position.html">DataPosition</a>(&quot;pilots&quot;, 0)</td></tr>
  193. <tr class="separator:a9363999814f09e4ac0f75b7710e01308"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <tr class="memitem:a5410bf63f5083d22b84feb9d8b4b9994"><td class="memItemLeft" align="right" valign="top"><a id="a5410bf63f5083d22b84feb9d8b4b9994"></a>
  195. auto const&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_TAIL_POSITION</b> = <a class="el" href="structexperimental_1_1_data_position.html">DataPosition</a>(&quot;tails&quot;, 0)</td></tr>
  196. <tr class="separator:a5410bf63f5083d22b84feb9d8b4b9994"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <tr class="memitem:a3e8e221359ea8d2b7207fac8ab74e6f3"><td class="memItemLeft" align="right" valign="top"><a id="a3e8e221359ea8d2b7207fac8ab74e6f3"></a>
  198. auto const&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_AIRCRAFT_POSITION</b> = <a class="el" href="structexperimental_1_1_data_position.html">DataPosition</a>(&quot;aircraft&quot;, 0)</td></tr>
  199. <tr class="separator:a3e8e221359ea8d2b7207fac8ab74e6f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. <tr class="memitem:a3ed49f6eb498fb92dfafd52e21035c86"><td class="memItemLeft" align="right" valign="top"><a id="a3ed49f6eb498fb92dfafd52e21035c86"></a>
  201. auto const&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_FLIGHT_POSITION</b> = <a class="el" href="structexperimental_1_1_data_position.html">DataPosition</a>(&quot;flights&quot;, 0)</td></tr>
  202. <tr class="separator:a3ed49f6eb498fb92dfafd52e21035c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. </table>
  204. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  205. <div class="textblock"><p>Temporary namespace for experimental features. Will be removed in later versions. </p>
  206. <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Remove this namespace (and learn about some nice \something of doxygen) Decide documentation style. <a href="https://www.doxygen.nl/manual/docblocks.html#specialblock">https://www.doxygen.nl/manual/docblocks.html#specialblock</a> </dd></dl>
  207. </div><h2 class="groupheader">Typedef Documentation</h2>
  208. <a id="a76d743fc188a8749586879cb92b03d32"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#a76d743fc188a8749586879cb92b03d32">&#9670;&nbsp;</a></span>ColName</h2>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname">using <a class="el" href="namespaceexperimental.html#a76d743fc188a8749586879cb92b03d32">experimental::ColName</a> = typedef QString</td>
  215. </tr>
  216. </table>
  217. </div><div class="memdoc">
  218. <p>An alias for QString. </p>
  219. <p>Very long description <em>with</em> <b>markdown?</b></p>
  220. <hr />
  221. <h1><a class="anchor" id="autotoc_md0"></a>
  222. Header</h1>
  223. </div>
  224. </div>
  225. </div><!-- contents -->
  226. </div><!-- doc-content -->
  227. <!-- start footer part -->
  228. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  229. <ul>
  230. <li class="navelem"><a class="el" href="namespaceexperimental.html">experimental</a></li>
  231. <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
  232. </ul>
  233. </div>
  234. </body>
  235. </html>