class_a_date.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  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: ADate 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_a_date.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-static-methods">Static Public Member Functions</a> &#124;
  86. <a href="class_a_date-members.html">List of all members</a> </div>
  87. <div class="headertitle">
  88. <div class="title">ADate Class Reference</div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <p>The <a class="el" href="class_a_date.html" title="The ADate class is responsible for input/output of Dates and handling the different Date Formats.">ADate</a> class is responsible for input/output of Dates and handling the different Date Formats.
  92. <a href="class_a_date.html#details">More...</a></p>
  93. <p><code>#include &lt;<a class="el" href="adate_8h_source.html">adate.h</a>&gt;</code></p>
  94. <table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  96. Static Public Member Functions</h2></td></tr>
  97. <tr class="memitem:a607fa6f1a9d893c5a24e2800c32e69c1"><td class="memItemLeft" align="right" valign="top">static QDate&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_date.html#a607fa6f1a9d893c5a24e2800c32e69c1">parseInput</a> (QString &amp;io_user_input, <a class="el" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> format)</td></tr>
  98. <tr class="memdesc:a607fa6f1a9d893c5a24e2800c32e69c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">takes a user-provided input and tries to convert it to a (valid) QDate. <a href="class_a_date.html#a607fa6f1a9d893c5a24e2800c32e69c1">More...</a><br /></td></tr>
  99. <tr class="separator:a607fa6f1a9d893c5a24e2800c32e69c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:aece227f9f64b6fe05cbef4fe9c9a40c0"><td class="memItemLeft" align="right" valign="top"><a id="aece227f9f64b6fe05cbef4fe9c9a40c0"></a>
  101. static void&#160;</td><td class="memItemRight" valign="bottom"><b>tryToFix</b> (QString &amp;io_user_input, <a class="el" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> format)</td></tr>
  102. <tr class="separator:aece227f9f64b6fe05cbef4fe9c9a40c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a1cf78be9174827b409376e6df298e905"><td class="memItemLeft" align="right" valign="top"><a id="a1cf78be9174827b409376e6df298e905"></a>
  104. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_date.html#a1cf78be9174827b409376e6df298e905">padCentury</a> (QString &amp;io_user_input, <a class="el" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> format)</td></tr>
  105. <tr class="memdesc:a1cf78be9174827b409376e6df298e905"><td class="mdescLeft">&#160;</td><td class="mdescRight">padCentury adds the century to a date where it was omitted <br /></td></tr>
  106. <tr class="separator:a1cf78be9174827b409376e6df298e905"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ac73a41e8dac47a3a2a3fcef5b3d19eee"><td class="memItemLeft" align="right" valign="top"><a id="ac73a41e8dac47a3a2a3fcef5b3d19eee"></a>
  108. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_date.html#ac73a41e8dac47a3a2a3fcef5b3d19eee">padZeroes</a> (QString &amp;io_user_input)</td></tr>
  109. <tr class="memdesc:ac73a41e8dac47a3a2a3fcef5b3d19eee"><td class="mdescLeft">&#160;</td><td class="mdescRight">pads a user-provided date string with 0s to facilitate conversion to QDate <br /></td></tr>
  110. <tr class="separator:ac73a41e8dac47a3a2a3fcef5b3d19eee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:aadac6b9e484c56381b8a52da79456926"><td class="memItemLeft" align="right" valign="top"><a id="aadac6b9e484c56381b8a52da79456926"></a>
  112. static void&#160;</td><td class="memItemRight" valign="bottom"><b>addSeperators</b> (QString &amp;io_user_input, const <a class="el" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> &amp;format)</td></tr>
  113. <tr class="separator:aadac6b9e484c56381b8a52da79456926"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a210af97b49e6c66f451f83a6251fe83a"><td class="memItemLeft" align="right" valign="top"><a id="a210af97b49e6c66f451f83a6251fe83a"></a>
  115. static bool&#160;</td><td class="memItemRight" valign="bottom"><b>containsSeperator</b> (const QString &amp;user_input)</td></tr>
  116. <tr class="separator:a210af97b49e6c66f451f83a6251fe83a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a8d8378c2f02e85235852386a49972306"><td class="memItemLeft" align="right" valign="top"><a id="a8d8378c2f02e85235852386a49972306"></a>
  118. static QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_date.html#a8d8378c2f02e85235852386a49972306">toString</a> (const QDate &amp;date, <a class="el" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> format=OPL::DateFormat::ISODate)</td></tr>
  119. <tr class="memdesc:a8d8378c2f02e85235852386a49972306"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reimplements QDate::toString to accept OPL::Date::ADateFormat enums. <br /></td></tr>
  120. <tr class="separator:a8d8378c2f02e85235852386a49972306"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:aa796e1c6b429ff2324d7392c6267d125"><td class="memItemLeft" align="right" valign="top"><a id="aa796e1c6b429ff2324d7392c6267d125"></a>
  122. static const QStringList &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getDisplayNames</b> ()</td></tr>
  123. <tr class="separator:aa796e1c6b429ff2324d7392c6267d125"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ad2658f9943fa085c31ac5384ac32e8ea"><td class="memItemLeft" align="right" valign="top"><a id="ad2658f9943fa085c31ac5384ac32e8ea"></a>
  125. static const QString&#160;</td><td class="memItemRight" valign="bottom"><b>getFormatString</b> (<a class="el" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> format)</td></tr>
  126. <tr class="separator:ad2658f9943fa085c31ac5384ac32e8ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a66f239a67221f4922f34e1a977c90058"><td class="memItemLeft" align="right" valign="top">static const QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_date.html#a66f239a67221f4922f34e1a977c90058">currentDate</a> ()</td></tr>
  128. <tr class="memdesc:a66f239a67221f4922f34e1a977c90058"><td class="mdescLeft">&#160;</td><td class="mdescRight">today Returns a string containing the current date in ISO format <a href="class_a_date.html#a66f239a67221f4922f34e1a977c90058">More...</a><br /></td></tr>
  129. <tr class="separator:a66f239a67221f4922f34e1a977c90058"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. </table>
  131. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  132. <div class="textblock"><p>The <a class="el" href="class_a_date.html" title="The ADate class is responsible for input/output of Dates and handling the different Date Formats.">ADate</a> class is responsible for input/output of Dates and handling the different Date Formats. </p>
  133. </div><h2 class="groupheader">Member Function Documentation</h2>
  134. <a id="a66f239a67221f4922f34e1a977c90058"></a>
  135. <h2 class="memtitle"><span class="permalink"><a href="#a66f239a67221f4922f34e1a977c90058">&#9670;&nbsp;</a></span>currentDate()</h2>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="mlabels">
  139. <tr>
  140. <td class="mlabels-left">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">const QString ADate::currentDate </td>
  144. <td>(</td>
  145. <td class="paramname"></td><td>)</td>
  146. <td></td>
  147. </tr>
  148. </table>
  149. </td>
  150. <td class="mlabels-right">
  151. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. <p>today Returns a string containing the current date in ISO format </p>
  156. <dl class="section return"><dt>Returns</dt><dd></dd></dl>
  157. </div>
  158. </div>
  159. <a id="a607fa6f1a9d893c5a24e2800c32e69c1"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#a607fa6f1a9d893c5a24e2800c32e69c1">&#9670;&nbsp;</a></span>parseInput()</h2>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="mlabels">
  164. <tr>
  165. <td class="mlabels-left">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">QDate ADate::parseInput </td>
  169. <td>(</td>
  170. <td class="paramtype">QString &amp;&#160;</td>
  171. <td class="paramname"><em>io_user_input</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype"><a class="el" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a>&#160;</td>
  177. <td class="paramname"><em>format</em>&#160;</td>
  178. </tr>
  179. <tr>
  180. <td></td>
  181. <td>)</td>
  182. <td></td><td></td>
  183. </tr>
  184. </table>
  185. </td>
  186. <td class="mlabels-right">
  187. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>takes a user-provided input and tries to convert it to a (valid) QDate. </p>
  192. <dl class="section return"><dt>Returns</dt><dd>QDate (invalid if input not recognized) </dd></dl>
  193. </div>
  194. </div>
  195. <hr/>The documentation for this class was generated from the following files:<ul>
  196. <li>src/functions/<a class="el" href="adate_8h_source.html">adate.h</a></li>
  197. <li>src/functions/adate.cpp</li>
  198. </ul>
  199. </div><!-- contents -->
  200. </div><!-- doc-content -->
  201. <!-- start footer part -->
  202. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  203. <ul>
  204. <li class="navelem"><a class="el" href="class_a_date.html">ADate</a></li>
  205. <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>
  206. </ul>
  207. </div>
  208. </body>
  209. </html>