2
0

datetime_8h_source.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
  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/functions/datetime.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('datetime_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">datetime.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="preprocessor">#ifndef DATETIME_H</span></div>
  89. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define DATETIME_H</span></div>
  90. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &quot;src/opl.h&quot;</span></div>
  91. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
  92. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_o_p_l.html">OPL</a> {</div>
  93. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
  94. <div class="line"><a name="l00007"></a><span class="lineno"><a class="line" href="class_o_p_l_1_1_date_time.html"> 7</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_o_p_l_1_1_date_time.html">DateTime</a> {</div>
  95. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="keyword">public</span>:</div>
  96. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; <span class="keyword">const</span> <span class="keyword">inline</span> <span class="keyword">static</span> QString ISO_FORMAT_STRING = QStringLiteral(<span class="stringliteral">&quot;yyyy-MM-dd&quot;</span>);</div>
  97. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="keyword">const</span> <span class="keyword">inline</span> <span class="keyword">static</span> QString DE_FORMAT_STRING = QStringLiteral(<span class="stringliteral">&quot;dd.MM.yyyy&quot;</span>);</div>
  98. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <span class="keyword">const</span> <span class="keyword">inline</span> <span class="keyword">static</span> QString EN_FORMAT_STRING = QStringLiteral(<span class="stringliteral">&quot;MM/dd/yyyy&quot;</span>);</div>
  99. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
  100. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">inline</span> QMap&lt;OPL::DateFormat, QString&gt; DATEFORMATSMAP = {</div>
  101. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; {OPL::DateFormat::ISODate, ISO_FORMAT_STRING},</div>
  102. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; {OPL::DateFormat::DE, DE_FORMAT_STRING },</div>
  103. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; {OPL::DateFormat::EN, EN_FORMAT_STRING },</div>
  104. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
  105. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; };</div>
  106. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
  107. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">inline</span> QStringList DISPLAY_NAMES = {</div>
  108. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; QStringLiteral(<span class="stringliteral">&quot;ISO 8601: yyyy-MM-dd&quot;</span>),</div>
  109. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; QStringLiteral(<span class="stringliteral">&quot;DE: dd.MM.yyyy&quot;</span>),</div>
  110. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; QStringLiteral(<span class="stringliteral">&quot;EN: MM/dd/yyyy&quot;</span>)</div>
  111. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; };</div>
  112. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
  113. <div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="class_o_p_l_1_1_date_time.html#ae4c63618854365d1a1d6d8fc2d231f1a"> 29</a></span>&#160; <span class="keyword">inline</span> <span class="keyword">static</span> QString <a class="code" href="class_o_p_l_1_1_date_time.html#ae4c63618854365d1a1d6d8fc2d231f1a">dateToString</a>(<span class="keyword">const</span> QDate &amp;date, <a class="code" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> format = OPL::DateFormat::ISODate)</div>
  114. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div>
  115. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">return</span> date.toString(DATEFORMATSMAP.value(format));</div>
  116. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; };</div>
  117. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
  118. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">static</span> QDate <a class="code" href="class_o_p_l_1_1_date_time.html#a8995f51a618ce5411930209889b7fbef">parseInput</a>(QString &amp;user_input, <a class="code" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> format);</div>
  119. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
  120. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> tryToFix(QString &amp;user_input, <a class="code" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> format);</div>
  121. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
  122. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_o_p_l_1_1_date_time.html#aa845df34fc308820472e1fe3aff29589">padCentury</a>(QString &amp;io_user_input, <a class="code" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> format);</div>
  123. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
  124. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_o_p_l_1_1_date_time.html#a552680c8122a61f360456eb998e13654">padZeroes</a>(QString &amp;io_user_input);</div>
  125. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
  126. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> addSeperators(QString &amp;io_user_input, <span class="keyword">const</span> <a class="code" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> &amp;format);</div>
  127. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
  128. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> containsSeperator(<span class="keyword">const</span> QString &amp;user_input);</div>
  129. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
  130. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
  131. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
  132. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> QStringList&amp; getDisplayNames();</div>
  133. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
  134. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> QString getFormatString(<a class="code" href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a> format);</div>
  135. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
  136. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> QString <a class="code" href="class_o_p_l_1_1_date_time.html#add36917b3d13e4a2bb3f8dbac7973da6">currentDate</a>();</div>
  137. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
  138. <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="class_o_p_l_1_1_date_time.html#ae225c8c48918ca8aba36383028cad2d0"> 72</a></span>&#160; <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">const</span> QString <a class="code" href="class_o_p_l_1_1_date_time.html#ae225c8c48918ca8aba36383028cad2d0">dateTimeToString</a> (<span class="keyword">const</span> QDateTime&amp; date_time, OPL::DateTimeFormat format) {</div>
  139. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordflow">switch</span> (format) {</div>
  140. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">case</span> OPL::DateTimeFormat::Default:</div>
  141. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">return</span> date_time.toString(Qt::ISODate);</div>
  142. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">case</span> OPL::DateTimeFormat::Backup:</div>
  143. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordflow">return</span> date_time.toString(QStringLiteral(<span class="stringliteral">&quot;yyyy_MM_dd_T_hh_mm&quot;</span>));</div>
  144. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordflow">default</span>:</div>
  145. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">return</span> QString();</div>
  146. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; }</div>
  147. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div>
  148. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
  149. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">static</span> <span class="keyword">inline</span> QDateTime fromString(<span class="keyword">const</span> QString&amp; date_time_string)</div>
  150. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; {</div>
  151. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">auto</span> date_time = QDateTime::fromString(date_time_string, QStringLiteral(<span class="stringliteral">&quot;yyyy-MM-ddhh:mm&quot;</span>));</div>
  152. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; date_time.setTimeZone(QTimeZone::utc());</div>
  153. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">return</span> date_time;</div>
  154. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; }</div>
  155. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
  156. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;};</div>
  157. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
  158. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;} <span class="comment">// namespace OPL</span></div>
  159. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
  160. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// DATETIME_H</span></div>
  161. <div class="ttc" id="aclass_o_p_l_1_1_date_time_html"><div class="ttname"><a href="class_o_p_l_1_1_date_time.html">OPL::DateTime</a></div><div class="ttdef"><b>Definition:</b> datetime.h:7</div></div>
  162. <div class="ttc" id="aclass_o_p_l_1_1_date_time_html_a552680c8122a61f360456eb998e13654"><div class="ttname"><a href="class_o_p_l_1_1_date_time.html#a552680c8122a61f360456eb998e13654">OPL::DateTime::padZeroes</a></div><div class="ttdeci">static void padZeroes(QString &amp;io_user_input)</div><div class="ttdoc">pads a user-provided date string with 0s to facilitate conversion to QDate</div><div class="ttdef"><b>Definition:</b> datetime.cpp:69</div></div>
  163. <div class="ttc" id="aclass_o_p_l_1_1_date_time_html_a8995f51a618ce5411930209889b7fbef"><div class="ttname"><a href="class_o_p_l_1_1_date_time.html#a8995f51a618ce5411930209889b7fbef">OPL::DateTime::parseInput</a></div><div class="ttdeci">static QDate parseInput(QString &amp;user_input, OPL::DateFormat format)</div><div class="ttdoc">takes a user-provided input and tries to convert it to a (valid) QDate.</div><div class="ttdef"><b>Definition:</b> datetime.cpp:5</div></div>
  164. <div class="ttc" id="aclass_o_p_l_1_1_date_time_html_aa845df34fc308820472e1fe3aff29589"><div class="ttname"><a href="class_o_p_l_1_1_date_time.html#aa845df34fc308820472e1fe3aff29589">OPL::DateTime::padCentury</a></div><div class="ttdeci">static void padCentury(QString &amp;io_user_input, OPL::DateFormat format)</div><div class="ttdoc">padCentury adds the century to a date where it was omitted</div><div class="ttdef"><b>Definition:</b> datetime.cpp:38</div></div>
  165. <div class="ttc" id="aclass_o_p_l_1_1_date_time_html_add36917b3d13e4a2bb3f8dbac7973da6"><div class="ttname"><a href="class_o_p_l_1_1_date_time.html#add36917b3d13e4a2bb3f8dbac7973da6">OPL::DateTime::currentDate</a></div><div class="ttdeci">static const QString currentDate()</div><div class="ttdoc">today Returns a string containing the current date in ISO format</div><div class="ttdef"><b>Definition:</b> datetime.cpp:137</div></div>
  166. <div class="ttc" id="aclass_o_p_l_1_1_date_time_html_ae225c8c48918ca8aba36383028cad2d0"><div class="ttname"><a href="class_o_p_l_1_1_date_time.html#ae225c8c48918ca8aba36383028cad2d0">OPL::DateTime::dateTimeToString</a></div><div class="ttdeci">static const QString dateTimeToString(const QDateTime &amp;date_time, OPL::DateTimeFormat format)</div><div class="ttdoc">dateTimeToString formats a QDateTime object into a string in a uniform way.</div><div class="ttdef"><b>Definition:</b> datetime.h:72</div></div>
  167. <div class="ttc" id="aclass_o_p_l_1_1_date_time_html_ae4c63618854365d1a1d6d8fc2d231f1a"><div class="ttname"><a href="class_o_p_l_1_1_date_time.html#ae4c63618854365d1a1d6d8fc2d231f1a">OPL::DateTime::dateToString</a></div><div class="ttdeci">static QString dateToString(const QDate &amp;date, OPL::DateFormat format=OPL::DateFormat::ISODate)</div><div class="ttdoc">Reimplements QDate::toString to accept OPL::Date::DateFormat enums.</div><div class="ttdef"><b>Definition:</b> datetime.h:29</div></div>
  168. <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>
  169. <div class="ttc" id="anamespace_o_p_l_html_af7cd691b5d236d3e846193464e9cba28"><div class="ttname"><a href="namespace_o_p_l.html#af7cd691b5d236d3e846193464e9cba28">OPL::DateFormat</a></div><div class="ttdeci">DateFormat</div><div class="ttdoc">ADateFormats enumerates the accepted date formats for QDateEdits.</div><div class="ttdef"><b>Definition:</b> opl.h:92</div></div>
  170. </div><!-- fragment --></div><!-- contents -->
  171. </div><!-- doc-content -->
  172. <!-- start footer part -->
  173. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  174. <ul>
  175. <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_e823141bb13a34caac0c96ccd0d33fcf.html">functions</a></li><li class="navelem"><b>datetime.h</b></li>
  176. <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>
  177. </ul>
  178. </div>
  179. </body>
  180. </html>