-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfile__input_8h_source.html
More file actions
188 lines (186 loc) · 17 KB
/
file__input_8h_source.html
File metadata and controls
188 lines (186 loc) · 17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<!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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Aether: include/file_input.h Source File</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="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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Aether
 <span id="projectnumber">0.0</span>
</div>
<div id="projectbrief">Ionosphere-Thermosphere model</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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');
/* @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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">file_input.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright 2020, the Aether Development Team (see doc/dev_team.md for members)</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Full license can be found in License.md</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#ifndef INCLUDE_FILE_INPUT_H_</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#define INCLUDE_FILE_INPUT_H_</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Functions that assist in the reading of files.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> **************************************************************/</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <fstream></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> \brief Reads the file until it finds a #command, returns "#command"</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> \param file_ptr file pointer to the open file</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> std::string find_next_hash(std::ifstream &file_ptr);</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> \brief Reads a series of line that can be in a CSV format, returns 2D array</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> \param file_ptr file pointer to the open file</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> std::vector<std::vector<std::string>> read_csv(std::ifstream &file_ptr);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> \brief Reads a series of line that can be in a SSV format, returns 2D array</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> \param file_ptr file pointer to the open file</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> \param</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> std::vector<std::vector<std::string>> read_ssv(std::ifstream &file_ptr);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> \brief Reads either a comma-separated time or series of lines describing time</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> format is either </span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> y, m, d, h, m, s, ms </span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> or</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> y</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> m</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> d</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> h</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> m</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> s</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> ms</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> \param file_ptr file pointer to the open file</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> \param</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> std::vector<int> read_itime(std::ifstream &file_ptr, std::string hash);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> \brief Converts a string to lower case, returning lower case string</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> \param instring string to make lower</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> std::string make_lower(std::string instring);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> \brief Strips everything including and after two spaces, returns stripped str</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> \param instring string to strip end off of</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> std::string strip_string_end(std::string instring);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> \brief Takes all of the spaces out of the sting, returns stripped string</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> \param instring string to take spaces out of</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> std::string strip_spaces(std::string instring);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> \brief read in a string from a file</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> \param file_ptr file pointer to the open file</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> \param hash string to print out if there is an error</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> std::string read_string(std::ifstream &file_ptr, std::string hash);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> \brief read in an integer from a file</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> \param file_ptr file pointer to the open file</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> \param hash string to print out if there is an error</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">int</span> read_int(std::ifstream &file_ptr, std::string hash);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> \brief read in a float from a file</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> \param file_ptr file pointer to the open file</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> \param hash string to print out if there is an error</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> precision_t read_float(std::ifstream &file_ptr, std::string hash);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> \brief take a string with comma-separated-values and parse into vector</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> \param line string containing comma separated values</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> std::vector<std::string> parse_csv_row_into_vector(std::string line);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="preprocessor">#endif // INCLUDE_FILE_INPUT_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>