source: flair-dev/trunk/doc/Flair/_battery_monitor_8h_source.html @ 15

Last change on this file since 15 was 15, checked in by Sanahuja Guillaume, 5 years ago

m

File size: 16.0 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.7"/>
7<title>Flair: BatteryMonitor.h Source File</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtree.js"></script>
14<script type="text/javascript">
15  $(document).ready(initResizable);
16  $(window).load(resizeHeight);
17</script>
18<link href="search/search.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/javascript">
21  $(document).ready(function() { searchBox.OnSelectItem(0); });
22</script>
23<link href="doxygen.css" rel="stylesheet" type="text/css" />
24</head>
25<body>
26<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
32  <td style="padding-left: 0.5em;">
33   <div id="projectname">Flair
34   </div>
35   <div id="projectbrief">Framework Libre Air</div>
36  </td>
37 </tr>
38 </tbody>
39</table>
40</div>
41<!-- end header part -->
42<!-- Generated by Doxygen 1.8.7 -->
43<script type="text/javascript">
44var searchBox = new SearchBox("searchBox", "search",false,'Search');
45</script>
46  <div id="navrow1" class="tabs">
47    <ul class="tablist">
48      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
50      <li><a href="annotated.html"><span>Classes</span></a></li>
51      <li class="current"><a href="files.html"><span>Files</span></a></li>
52      <li>
53        <div id="MSearchBox" class="MSearchBoxInactive">
54        <span class="left">
55          <img id="MSearchSelect" src="search/mag_sel.png"
56               onmouseover="return searchBox.OnSearchSelectShow()"
57               onmouseout="return searchBox.OnSearchSelectHide()"
58               alt=""/>
59          <input type="text" id="MSearchField" value="Search" accesskey="S"
60               onfocus="searchBox.OnSearchFieldFocus(true)" 
61               onblur="searchBox.OnSearchFieldFocus(false)" 
62               onkeyup="searchBox.OnSearchFieldChange(event)"/>
63          </span><span class="right">
64            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
65          </span>
66        </div>
67      </li>
68    </ul>
69  </div>
70  <div id="navrow2" class="tabs2">
71    <ul class="tablist">
72      <li><a href="files.html"><span>File&#160;List</span></a></li>
73    </ul>
74  </div>
75</div><!-- top -->
76<div id="side-nav" class="ui-resizable side-nav-resizable">
77  <div id="nav-tree">
78    <div id="nav-tree-contents">
79      <div id="nav-sync" class="sync"></div>
80    </div>
81  </div>
82  <div id="splitbar" style="-moz-user-select:none;" 
83       class="ui-resizable-handle">
84  </div>
85</div>
86<script type="text/javascript">
87$(document).ready(function(){initNavTree('_battery_monitor_8h_source.html','');});
88</script>
89<div id="doc-content">
90<!-- window showing the filter options -->
91<div id="MSearchSelectWindow"
92     onmouseover="return searchBox.OnSearchSelectShow()"
93     onmouseout="return searchBox.OnSearchSelectHide()"
94     onkeydown="return searchBox.OnSearchSelectKey(event)">
95<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a></div>
96
97<!-- iframe showing the search results (closed by default) -->
98<div id="MSearchResultsWindow">
99<iframe src="javascript:void(0)" frameborder="0" 
100        name="MSearchResults" id="MSearchResults">
101</iframe>
102</div>
103
104<div class="header">
105  <div class="headertitle">
106<div class="title">BatteryMonitor.h</div>  </div>
107</div><!--header-->
108<div class="contents">
109<a href="_battery_monitor_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// %flair:license{</span></div>
110<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// This file is part of the Flair framework distributed under the</span></div>
111<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// CECILL-C License, Version 1.0.</span></div>
112<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// %flair:license}</span></div>
113<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"></span><span class="preprocessor">#ifndef BATTERYMONITOR_H</span></div>
114<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#define BATTERYMONITOR_H</span></div>
115<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
116<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_group_box_8h.html">GroupBox.h</a>&gt;</span></div>
117<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
118<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="keyword">namespace </span>flair {</div>
119<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="keyword">namespace </span>gui {</div>
120<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">class </span>LayoutPosition;</div>
121<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">class </span>Label;</div>
122<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="keyword">class </span>DoubleSpinBox;</div>
123<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;}</div>
124<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;}</div>
125<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>
126<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">namespace </span>flair {</div>
127<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">namespace </span>sensor {</div>
128<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>
129<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classflair_1_1sensor_1_1_battery_monitor.html">   34</a></span>&#160;<span class="keyword">class </span><a class="code" href="classflair_1_1sensor_1_1_battery_monitor.html">BatteryMonitor</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1gui_1_1_group_box.html">gui::GroupBox</a> {</div>
130<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">public</span>:</div>
131<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  <a class="code" href="classflair_1_1sensor_1_1_battery_monitor.html#aaa282725e3cc93b42f66e1e72c19ecae">BatteryMonitor</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name);</div>
132<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
133<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  <a class="code" href="classflair_1_1sensor_1_1_battery_monitor.html#aefc9c63227a5a0a852ddba24ee7cd4e1">~BatteryMonitor</a>();</div>
134<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
135<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  <span class="keywordtype">bool</span> <a class="code" href="classflair_1_1sensor_1_1_battery_monitor.html#a102998c66cbb48ff71399189cb3371bb">IsBatteryLow</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div>
136<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
137<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1sensor_1_1_battery_monitor.html#a8eed791db4d0f82898e9bb8e3788d818">SetBatteryValue</a>(<span class="keywordtype">float</span> value);</div>
138<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
139<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;  <span class="keywordtype">float</span> <a class="code" href="classflair_1_1sensor_1_1_battery_monitor.html#aaa0c9ae84cba9a3724f1c35ac61791f2">GetVoltage</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div>
140<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>
141<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="keyword">private</span>:</div>
142<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  <span class="keywordtype">float</span> batteryvalue;</div>
143<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;  <a class="code" href="classflair_1_1gui_1_1_double_spin_box.html">gui::DoubleSpinBox</a> *battery_thresh;</div>
144<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  <a class="code" href="classflair_1_1gui_1_1_label.html">gui::Label</a> *battery;</div>
145<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;};</div>
146<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;} <span class="comment">// end namespace sensor</span></div>
147<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;} <span class="comment">// end namespace flair</span></div>
148<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
149<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="preprocessor">#endif // BATTERYMONITOR_H</span></div>
150<div class="ttc" id="classflair_1_1gui_1_1_group_box_html"><div class="ttname"><a href="classflair_1_1gui_1_1_group_box.html">flair::gui::GroupBox</a></div><div class="ttdoc">Class displaying a QGroupBox on the ground station. </div><div class="ttdef"><b>Definition:</b> GroupBox.h:27</div></div>
151<div class="ttc" id="classflair_1_1sensor_1_1_battery_monitor_html_a102998c66cbb48ff71399189cb3371bb"><div class="ttname"><a href="classflair_1_1sensor_1_1_battery_monitor.html#a102998c66cbb48ff71399189cb3371bb">flair::sensor::BatteryMonitor::IsBatteryLow</a></div><div class="ttdeci">bool IsBatteryLow(void) const </div><div class="ttdoc">Is batteru low? </div></div>
152<div class="ttc" id="classflair_1_1sensor_1_1_battery_monitor_html_aaa282725e3cc93b42f66e1e72c19ecae"><div class="ttname"><a href="classflair_1_1sensor_1_1_battery_monitor.html#aaa282725e3cc93b42f66e1e72c19ecae">flair::sensor::BatteryMonitor::BatteryMonitor</a></div><div class="ttdeci">BatteryMonitor(const gui::LayoutPosition *position, std::string name)</div><div class="ttdoc">Constructor. </div></div>
153<div class="ttc" id="classflair_1_1gui_1_1_label_html"><div class="ttname"><a href="classflair_1_1gui_1_1_label.html">flair::gui::Label</a></div><div class="ttdoc">Class displaying a QLabel on the ground station. </div><div class="ttdef"><b>Definition:</b> Label.h:28</div></div>
154<div class="ttc" id="classflair_1_1sensor_1_1_battery_monitor_html"><div class="ttname"><a href="classflair_1_1sensor_1_1_battery_monitor.html">flair::sensor::BatteryMonitor</a></div><div class="ttdoc">Base class for battery monitor. </div><div class="ttdef"><b>Definition:</b> BatteryMonitor.h:34</div></div>
155<div class="ttc" id="classflair_1_1gui_1_1_double_spin_box_html"><div class="ttname"><a href="classflair_1_1gui_1_1_double_spin_box.html">flair::gui::DoubleSpinBox</a></div><div class="ttdoc">Class displaying a QDoubleSpinBox on the ground station. </div><div class="ttdef"><b>Definition:</b> DoubleSpinBox.h:28</div></div>
156<div class="ttc" id="_group_box_8h_html"><div class="ttname"><a href="_group_box_8h.html">GroupBox.h</a></div><div class="ttdoc">Class displaying a QGroupBox on the ground station. </div></div>
157<div class="ttc" id="classflair_1_1gui_1_1_layout_position_html"><div class="ttname"><a href="classflair_1_1gui_1_1_layout_position.html">flair::gui::LayoutPosition</a></div><div class="ttdoc">Class to define a position in a layout on the ground station. </div><div class="ttdef"><b>Definition:</b> LayoutPosition.h:28</div></div>
158<div class="ttc" id="classflair_1_1sensor_1_1_battery_monitor_html_a8eed791db4d0f82898e9bb8e3788d818"><div class="ttname"><a href="classflair_1_1sensor_1_1_battery_monitor.html#a8eed791db4d0f82898e9bb8e3788d818">flair::sensor::BatteryMonitor::SetBatteryValue</a></div><div class="ttdeci">void SetBatteryValue(float value)</div><div class="ttdoc">Set battery value. </div></div>
159<div class="ttc" id="classflair_1_1sensor_1_1_battery_monitor_html_aaa0c9ae84cba9a3724f1c35ac61791f2"><div class="ttname"><a href="classflair_1_1sensor_1_1_battery_monitor.html#aaa0c9ae84cba9a3724f1c35ac61791f2">flair::sensor::BatteryMonitor::GetVoltage</a></div><div class="ttdeci">float GetVoltage(void) const </div><div class="ttdoc">Get battery voltage. </div></div>
160<div class="ttc" id="classflair_1_1sensor_1_1_battery_monitor_html_aefc9c63227a5a0a852ddba24ee7cd4e1"><div class="ttname"><a href="classflair_1_1sensor_1_1_battery_monitor.html#aefc9c63227a5a0a852ddba24ee7cd4e1">flair::sensor::BatteryMonitor::~BatteryMonitor</a></div><div class="ttdeci">~BatteryMonitor()</div><div class="ttdoc">Destructor. </div></div>
161</div><!-- fragment --></div><!-- contents -->
162</div><!-- doc-content -->
163<!-- start footer part -->
164<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
165  <ul>
166    <li class="navelem"><a class="el" href="dir_33c2ee9b1665499374b4225c427cf176.html">igep</a></li><li class="navelem"><a class="el" href="dir_f1fe274389177bd7e17de7949c4ffada.html">flair-src</a></li><li class="navelem"><a class="el" href="dir_3ef62148cf94871b4b6ee5d6e3a989c1.html">lib</a></li><li class="navelem"><a class="el" href="dir_6e0f9c50eed172896c55a6e61952176b.html">FlairSensorActuator</a></li><li class="navelem"><a class="el" href="dir_c5d95abdcafe7d1171548eb561d7ce37.html">src</a></li><li class="navelem"><a class="el" href="_battery_monitor_8h.html">BatteryMonitor.h</a></li>
167    <li class="footer">Generated on Wed Apr 20 2016 16:16:00 for Flair by
168    <a href="http://www.doxygen.org/index.html">
169    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
170  </ul>
171</div>
172</body>
173</html>
Note: See TracBrowser for help on using the repository browser.