driver__obs__gsm90_8hpp_source.html 15.1 KB
Newer Older
Achim Morschhauser's avatar
Achim Morschhauser committed
1
2
3
4
5
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
Achim Morschhauser's avatar
Achim Morschhauser committed
6
7
8
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GeomagLogger: include/driver_obs_gsm90.hpp Source File</title>
Achim Morschhauser's avatar
Achim Morschhauser committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<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>
<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;">
Achim Morschhauser's avatar
Achim Morschhauser committed
23
24
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GeomagLogger
Achim Morschhauser's avatar
Achim Morschhauser committed
25
26
27
28
29
30
31
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
Achim Morschhauser's avatar
Achim Morschhauser committed
32
<!-- Generated by Doxygen 1.8.13 -->
Achim Morschhauser's avatar
Achim Morschhauser committed
33
34
35
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
Achim Morschhauser's avatar
Achim Morschhauser committed
36
37
38
39
40
41
42
43
44
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
Achim Morschhauser's avatar
Achim Morschhauser committed
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!-- 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">driver_obs_gsm90.hpp</div>  </div>
</div><!--header-->
<div class="contents">
Achim Morschhauser's avatar
Achim Morschhauser committed
69
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/********************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">* WRITTEN BY ACHIM MORSCHHAUSER, GFZ POTSDAM, April 2016            *</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">* mors//gfz-potsdam.de                              *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">*                                       *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">* This class provides the driver for a GemSys GSM-90 proton magnetometer.       *</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">*                                       *</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">* It is based on the abstract observatory driver class driver_obs.      *</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">* TODO 20160520 AM      Try different commands to save GSM from dubious state</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">*                       when testing the baud rate. May be achieved by over-</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">*                       writing set_baudrate.</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">*                                       *</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">********************************************************************************/</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#ifndef _DRIVER_OBS_GSM90_H</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#define _DRIVER_OBS_GSM90_H</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;driver_obs_gsm.hpp&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;data_obs_scalar.hpp&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;data_obs.hpp&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;buffer_obs.hpp&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">//TODO Automatic check if GSM-90 or GSM-19 is used.</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">/****************************************************************************</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> ****************************************************************************</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> *                                                                          *</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> * This class provides the driver for a GSM-90.                             *</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> *                                                                          *</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"> * It is based on the generic GSM  driver class driver_obs_gsm              *</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"> *                                                                          *</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"> ****************************************************************************</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"> ***************************************************************************/</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classdriver__obs__gsm90.html">   37</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdriver__obs__gsm90.html">driver_obs_gsm90</a> : <span class="keyword">public</span> <a class="code" href="classdriver__obs__gsm.html">driver_obs_gsm</a></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;{</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">// Constructors</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="keyword">public</span>: <a class="code" href="classdriver__obs__gsm90.html#a361ee2ee1d920ae70eac72821edde40d">driver_obs_gsm90</a>(std::string port, <a class="code" href="classbuffer__obs.html">buffer_obs</a>* <a class="code" href="classdriver__obs.html#a5953d64be5b3006aa8fb439db8ab1129">buffer</a>);</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="keyword">public</span>: <a class="code" href="classdriver__obs__gsm90.html#a361ee2ee1d920ae70eac72821edde40d">driver_obs_gsm90</a>(std::string port, <a class="code" href="classbuffer__obs.html">buffer_obs</a>* buffer, <span class="keywordtype">int</span> baud);</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment">// Public Methods</span></div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="keyword">public</span>: <span class="keywordtype">int</span> <a class="code" href="classdriver__obs__gsm90.html#aa51ab2388523ab4783894c90ff756485">freerun</a>(<span class="keywordtype">double</span> <a class="code" href="classdriver__obs.html#a46b9d8013cd13df2cb45fcbb05f55691">freq</a>);</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="keyword">public</span>: <span class="keywordtype">int</span> <a class="code" href="classdriver__obs__gsm90.html#af95f3de241ccc9d1810bfbd8e26f936d">run</a>(<span class="keywordtype">double</span> freq);</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">// Private Methods</span></div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="keywordtype">int</span> init();</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="keywordtype">int</span> set_cycle(<span class="keywordtype">double</span> freq);</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;};</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _DRIVER_OBS_GSM90_H */</span><span class="preprocessor"></span></div><div class="ttc" id="classdriver__obs_html_a46b9d8013cd13df2cb45fcbb05f55691"><div class="ttname"><a href="classdriver__obs.html#a46b9d8013cd13df2cb45fcbb05f55691">driver_obs::freq</a></div><div class="ttdeci">double freq</div><div class="ttdef"><b>Definition:</b> driver_obs.hpp:36</div></div>
Achim Morschhauser's avatar
Achim Morschhauser committed
70
71
72
73
<div class="ttc" id="classbuffer__obs_html"><div class="ttname"><a href="classbuffer__obs.html">buffer_obs</a></div><div class="ttdef"><b>Definition:</b> buffer_obs.hpp:18</div></div>
<div class="ttc" id="classdriver__obs_html_a5953d64be5b3006aa8fb439db8ab1129"><div class="ttname"><a href="classdriver__obs.html#a5953d64be5b3006aa8fb439db8ab1129">driver_obs::buffer</a></div><div class="ttdeci">buffer_obs * buffer</div><div class="ttdef"><b>Definition:</b> driver_obs.hpp:30</div></div>
<div class="ttc" id="classdriver__obs__gsm90_html_a361ee2ee1d920ae70eac72821edde40d"><div class="ttname"><a href="classdriver__obs__gsm90.html#a361ee2ee1d920ae70eac72821edde40d">driver_obs_gsm90::driver_obs_gsm90</a></div><div class="ttdeci">driver_obs_gsm90(std::string port, buffer_obs *buffer)</div><div class="ttdef"><b>Definition:</b> driver_obs_gsm90.cpp:36</div></div>
<div class="ttc" id="classdriver__obs__gsm90_html"><div class="ttname"><a href="classdriver__obs__gsm90.html">driver_obs_gsm90</a></div><div class="ttdef"><b>Definition:</b> driver_obs_gsm90.hpp:37</div></div>
Achim Morschhauser's avatar
Achim Morschhauser committed
74
75
<div class="ttc" id="classdriver__obs__gsm90_html_af95f3de241ccc9d1810bfbd8e26f936d"><div class="ttname"><a href="classdriver__obs__gsm90.html#af95f3de241ccc9d1810bfbd8e26f936d">driver_obs_gsm90::run</a></div><div class="ttdeci">int run(double freq)</div><div class="ttdef"><b>Definition:</b> driver_obs_gsm90.cpp:70</div></div>
<div class="ttc" id="classdriver__obs__gsm90_html_aa51ab2388523ab4783894c90ff756485"><div class="ttname"><a href="classdriver__obs__gsm90.html#aa51ab2388523ab4783894c90ff756485">driver_obs_gsm90::freerun</a></div><div class="ttdeci">int freerun(double freq)</div><div class="ttdef"><b>Definition:</b> driver_obs_gsm90.cpp:108</div></div>
Achim Morschhauser's avatar
Achim Morschhauser committed
76
77
78
79
80
81
<div class="ttc" id="classdriver__obs__gsm_html"><div class="ttname"><a href="classdriver__obs__gsm.html">driver_obs_gsm</a></div><div class="ttdef"><b>Definition:</b> driver_obs_gsm.hpp:31</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
Achim Morschhauser's avatar
Achim Morschhauser committed
82
</a> 1.8.13
Achim Morschhauser's avatar
Achim Morschhauser committed
83
84
85
</small></address>
</body>
</html>