source: flair-dev/trunk/doc/Flair/classflair_1_1sensor_1_1_battery_monitor.html @ 25

Last change on this file since 25 was 25, checked in by Bayard Gildas, 4 years ago

Plop

File size: 38.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.9.1"/>
7<title>Flair: flair::sensor::BatteryMonitor Class Reference</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="navtreedata.js"></script>
14<script type="text/javascript" src="navtree.js"></script>
15<script type="text/javascript">
16  $(document).ready(initResizable);
17  $(window).load(resizeHeight);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
23  $(document).ready(function() { init_search(); });
24</script>
25<link href="doxygen.css" rel="stylesheet" type="text/css" />
26</head>
27<body>
28<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29<div id="titlearea">
30<table cellspacing="0" cellpadding="0">
31 <tbody>
32 <tr style="height: 56px;">
33  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
34  <td style="padding-left: 0.5em;">
35   <div id="projectname">Flair
36   </div>
37   <div id="projectbrief">Framework Libre Air</div>
38  </td>
39 </tr>
40 </tbody>
41</table>
42</div>
43<!-- end header part -->
44<!-- Generated by Doxygen 1.8.9.1 -->
45<script type="text/javascript">
46var searchBox = new SearchBox("searchBox", "search",false,'Search');
47</script>
48  <div id="navrow1" class="tabs">
49    <ul class="tablist">
50      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
51      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
52      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
53      <li><a href="files.html"><span>Files</span></a></li>
54      <li>
55        <div id="MSearchBox" class="MSearchBoxInactive">
56        <span class="left">
57          <img id="MSearchSelect" src="search/mag_sel.png"
58               onmouseover="return searchBox.OnSearchSelectShow()"
59               onmouseout="return searchBox.OnSearchSelectHide()"
60               alt=""/>
61          <input type="text" id="MSearchField" value="Search" accesskey="S"
62               onfocus="searchBox.OnSearchFieldFocus(true)" 
63               onblur="searchBox.OnSearchFieldFocus(false)" 
64               onkeyup="searchBox.OnSearchFieldChange(event)"/>
65          </span><span class="right">
66            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
67          </span>
68        </div>
69      </li>
70    </ul>
71  </div>
72  <div id="navrow2" class="tabs2">
73    <ul class="tablist">
74      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
75      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
76      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
77      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
78    </ul>
79  </div>
80</div><!-- top -->
81<div id="side-nav" class="ui-resizable side-nav-resizable">
82  <div id="nav-tree">
83    <div id="nav-tree-contents">
84      <div id="nav-sync" class="sync"></div>
85    </div>
86  </div>
87  <div id="splitbar" style="-moz-user-select:none;" 
88       class="ui-resizable-handle">
89  </div>
90</div>
91<script type="text/javascript">
92$(document).ready(function(){initNavTree('classflair_1_1sensor_1_1_battery_monitor.html','');});
93</script>
94<div id="doc-content">
95<!-- window showing the filter options -->
96<div id="MSearchSelectWindow"
97     onmouseover="return searchBox.OnSearchSelectShow()"
98     onmouseout="return searchBox.OnSearchSelectHide()"
99     onkeydown="return searchBox.OnSearchSelectKey(event)">
100</div>
101
102<!-- iframe showing the search results (closed by default) -->
103<div id="MSearchResultsWindow">
104<iframe src="javascript:void(0)" frameborder="0" 
105        name="MSearchResults" id="MSearchResults">
106</iframe>
107</div>
108
109<div class="header">
110  <div class="summary">
111<a href="#pub-methods">Public Member Functions</a> &#124;
112<a href="classflair_1_1sensor_1_1_battery_monitor-members.html">List of all members</a>  </div>
113  <div class="headertitle">
114<div class="title">flair::sensor::BatteryMonitor Class Reference</div>  </div>
115</div><!--header-->
116<div class="contents">
117
118<p>Base class for battery monitor. 
119 <a href="classflair_1_1sensor_1_1_battery_monitor.html#details">More...</a></p>
120
121<p><code>#include &lt;<a class="el" href="_battery_monitor_8h_source.html">BatteryMonitor.h</a>&gt;</code></p>
122<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
123  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::sensor::BatteryMonitor:</div>
124<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
125</div>
126<div id="dynsection-0-content" class="dyncontent" style="display:none;">
127 <div class="center">
128  <img src="classflair_1_1sensor_1_1_battery_monitor.png" usemap="#flair::sensor::BatteryMonitor_map" alt=""/>
129  <map id="flair::sensor::BatteryMonitor_map" name="flair::sensor::BatteryMonitor_map">
130<area href="classflair_1_1gui_1_1_group_box.html" title="Class displaying a QGroupBox on the ground station. " alt="flair::gui::GroupBox" shape="rect" coords="0,168,167,192"/>
131<area href="classflair_1_1gui_1_1_layout.html" title="Abstract class to display a layout on the ground station. " alt="flair::gui::Layout" shape="rect" coords="0,112,167,136"/>
132<area href="classflair_1_1gui_1_1_widget.html" title="Abstract class for all Framework&#39;s widget classes. " alt="flair::gui::Widget" shape="rect" coords="0,56,167,80"/>
133<area href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. " alt="flair::core::Object" shape="rect" coords="0,0,167,24"/>
134</map>
135 </div></div>
136<table class="memberdecls">
137<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
138Public Member Functions</h2></td></tr>
139<tr class="memitem:aaa282725e3cc93b42f66e1e72c19ecae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_battery_monitor.html#aaa282725e3cc93b42f66e1e72c19ecae">BatteryMonitor</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name)</td></tr>
140<tr class="memdesc:aaa282725e3cc93b42f66e1e72c19ecae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aaa282725e3cc93b42f66e1e72c19ecae">More...</a><br /></td></tr>
141<tr class="separator:aaa282725e3cc93b42f66e1e72c19ecae"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<tr class="memitem:aefc9c63227a5a0a852ddba24ee7cd4e1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_battery_monitor.html#aefc9c63227a5a0a852ddba24ee7cd4e1">~BatteryMonitor</a> ()</td></tr>
143<tr class="memdesc:aefc9c63227a5a0a852ddba24ee7cd4e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aefc9c63227a5a0a852ddba24ee7cd4e1">More...</a><br /></td></tr>
144<tr class="separator:aefc9c63227a5a0a852ddba24ee7cd4e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
145<tr class="memitem:a102998c66cbb48ff71399189cb3371bb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_battery_monitor.html#a102998c66cbb48ff71399189cb3371bb">IsBatteryLow</a> (void) const </td></tr>
146<tr class="memdesc:a102998c66cbb48ff71399189cb3371bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is batteru low?  <a href="#a102998c66cbb48ff71399189cb3371bb">More...</a><br /></td></tr>
147<tr class="separator:a102998c66cbb48ff71399189cb3371bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
148<tr class="memitem:a8eed791db4d0f82898e9bb8e3788d818"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_battery_monitor.html#a8eed791db4d0f82898e9bb8e3788d818">SetBatteryValue</a> (float value)</td></tr>
149<tr class="memdesc:a8eed791db4d0f82898e9bb8e3788d818"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set battery value.  <a href="#a8eed791db4d0f82898e9bb8e3788d818">More...</a><br /></td></tr>
150<tr class="separator:a8eed791db4d0f82898e9bb8e3788d818"><td class="memSeparator" colspan="2">&#160;</td></tr>
151<tr class="memitem:aaa0c9ae84cba9a3724f1c35ac61791f2"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_battery_monitor.html#aaa0c9ae84cba9a3724f1c35ac61791f2">GetVoltage</a> (void) const </td></tr>
152<tr class="memdesc:aaa0c9ae84cba9a3724f1c35ac61791f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get battery voltage.  <a href="#aaa0c9ae84cba9a3724f1c35ac61791f2">More...</a><br /></td></tr>
153<tr class="separator:aaa0c9ae84cba9a3724f1c35ac61791f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
154<tr class="inherit_header pub_methods_classflair_1_1gui_1_1_group_box"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1gui_1_1_group_box')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1gui_1_1_group_box.html">flair::gui::GroupBox</a></td></tr>
155<tr class="memitem:afdf8a52639dab292d16cffc286ad1036 inherit pub_methods_classflair_1_1gui_1_1_group_box"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_group_box.html#afdf8a52639dab292d16cffc286ad1036">GroupBox</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">LayoutPosition</a> *position, std::string name)</td></tr>
156<tr class="memdesc:afdf8a52639dab292d16cffc286ad1036 inherit pub_methods_classflair_1_1gui_1_1_group_box"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#afdf8a52639dab292d16cffc286ad1036">More...</a><br /></td></tr>
157<tr class="separator:afdf8a52639dab292d16cffc286ad1036 inherit pub_methods_classflair_1_1gui_1_1_group_box"><td class="memSeparator" colspan="2">&#160;</td></tr>
158<tr class="memitem:a271493c0c9db0cb9e8f542efd281be60 inherit pub_methods_classflair_1_1gui_1_1_group_box"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_group_box.html#a271493c0c9db0cb9e8f542efd281be60">~GroupBox</a> ()</td></tr>
159<tr class="memdesc:a271493c0c9db0cb9e8f542efd281be60 inherit pub_methods_classflair_1_1gui_1_1_group_box"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a271493c0c9db0cb9e8f542efd281be60">More...</a><br /></td></tr>
160<tr class="separator:a271493c0c9db0cb9e8f542efd281be60 inherit pub_methods_classflair_1_1gui_1_1_group_box"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<tr class="inherit_header pub_methods_classflair_1_1gui_1_1_layout"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1gui_1_1_layout')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1gui_1_1_layout.html">flair::gui::Layout</a></td></tr>
162<tr class="memitem:ad6d4a13b128abbd64619fe90cbc44f46 inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_layout.html#ad6d4a13b128abbd64619fe90cbc44f46">Layout</a> (const <a class="el" href="classflair_1_1gui_1_1_widget.html">Widget</a> *parent, std::string name, std::string type)</td></tr>
163<tr class="memdesc:ad6d4a13b128abbd64619fe90cbc44f46 inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ad6d4a13b128abbd64619fe90cbc44f46">More...</a><br /></td></tr>
164<tr class="separator:ad6d4a13b128abbd64619fe90cbc44f46 inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="memSeparator" colspan="2">&#160;</td></tr>
165<tr class="memitem:aafea7ef30ae5a3f3d394559b0f3931b5 inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_layout.html#aafea7ef30ae5a3f3d394559b0f3931b5">~Layout</a> ()</td></tr>
166<tr class="memdesc:aafea7ef30ae5a3f3d394559b0f3931b5 inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aafea7ef30ae5a3f3d394559b0f3931b5">More...</a><br /></td></tr>
167<tr class="separator:aafea7ef30ae5a3f3d394559b0f3931b5 inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="memSeparator" colspan="2">&#160;</td></tr>
168<tr class="memitem:a6040365f1a8f79ad029c5f99e0414c51 inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1gui_1_1_layout_position.html">LayoutPosition</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_layout.html#a6040365f1a8f79ad029c5f99e0414c51">LastRowLastCol</a> (void) const </td></tr>
169<tr class="memdesc:a6040365f1a8f79ad029c5f99e0414c51 inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last Row and Col <a class="el" href="classflair_1_1gui_1_1_layout_position.html" title="Class to define a position in a layout on the ground station. ">LayoutPosition</a><a href="#a6040365f1a8f79ad029c5f99e0414c51">More...</a><br /></td></tr>
170<tr class="separator:a6040365f1a8f79ad029c5f99e0414c51 inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="memSeparator" colspan="2">&#160;</td></tr>
171<tr class="memitem:a7e3724c5fbceb2e24ff0df1ebfedc3ad inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1gui_1_1_layout_position.html">LayoutPosition</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_layout.html#a7e3724c5fbceb2e24ff0df1ebfedc3ad">NewRow</a> (void) const </td></tr>
172<tr class="memdesc:a7e3724c5fbceb2e24ff0df1ebfedc3ad inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="mdescLeft">&#160;</td><td class="mdescRight">New Row <a class="el" href="classflair_1_1gui_1_1_layout_position.html" title="Class to define a position in a layout on the ground station. ">LayoutPosition</a><a href="#a7e3724c5fbceb2e24ff0df1ebfedc3ad">More...</a><br /></td></tr>
173<tr class="separator:a7e3724c5fbceb2e24ff0df1ebfedc3ad inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="memSeparator" colspan="2">&#160;</td></tr>
174<tr class="memitem:a114569847168fa89618e6b09cee23c8e inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1gui_1_1_layout_position.html">LayoutPosition</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_layout.html#a114569847168fa89618e6b09cee23c8e">At</a> (uint16_t row, uint16_t col) const </td></tr>
175<tr class="memdesc:a114569847168fa89618e6b09cee23c8e inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classflair_1_1gui_1_1_layout_position.html" title="Class to define a position in a layout on the ground station. ">LayoutPosition</a> at specified position.  <a href="#a114569847168fa89618e6b09cee23c8e">More...</a><br /></td></tr>
176<tr class="separator:a114569847168fa89618e6b09cee23c8e inherit pub_methods_classflair_1_1gui_1_1_layout"><td class="memSeparator" colspan="2">&#160;</td></tr>
177<tr class="inherit_header pub_methods_classflair_1_1gui_1_1_widget"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1gui_1_1_widget')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1gui_1_1_widget.html">flair::gui::Widget</a></td></tr>
178<tr class="memitem:a7b867cc6c603cbc5e5a2f39f083a9494 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a7b867cc6c603cbc5e5a2f39f083a9494">Widget</a> (const <a class="el" href="classflair_1_1gui_1_1_widget.html">Widget</a> *parent, std::string name, std::string type)</td></tr>
179<tr class="memdesc:a7b867cc6c603cbc5e5a2f39f083a9494 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7b867cc6c603cbc5e5a2f39f083a9494">More...</a><br /></td></tr>
180<tr class="separator:a7b867cc6c603cbc5e5a2f39f083a9494 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
181<tr class="memitem:a81110928e09e909dc1cc90971de4e8a9 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a81110928e09e909dc1cc90971de4e8a9">~Widget</a> ()</td></tr>
182<tr class="memdesc:a81110928e09e909dc1cc90971de4e8a9 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a81110928e09e909dc1cc90971de4e8a9">More...</a><br /></td></tr>
183<tr class="separator:a81110928e09e909dc1cc90971de4e8a9 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
184<tr class="memitem:a814a933622114ad9c8f5d49014262d89 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a814a933622114ad9c8f5d49014262d89">setEnabled</a> (bool status)</td></tr>
185<tr class="memdesc:a814a933622114ad9c8f5d49014262d89 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set enabled.  <a href="#a814a933622114ad9c8f5d49014262d89">More...</a><br /></td></tr>
186<tr class="separator:a814a933622114ad9c8f5d49014262d89 inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
187<tr class="memitem:a299877c38b297ada04542e4dfc5a2f4f inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a299877c38b297ada04542e4dfc5a2f4f">isEnabled</a> (void) const </td></tr>
188<tr class="memdesc:a299877c38b297ada04542e4dfc5a2f4f inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is enabled?  <a href="#a299877c38b297ada04542e4dfc5a2f4f">More...</a><br /></td></tr>
189<tr class="separator:a299877c38b297ada04542e4dfc5a2f4f inherit pub_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
190<tr class="inherit_header pub_methods_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
191<tr class="memitem:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aec92383fd5bf68d9df10414862b7e95c">Object</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent=NULL, std::string name=&quot;&quot;, std::string type=&quot;&quot;)</td></tr>
192<tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
193<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
194<tr class="memitem:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aa2bde0e6677bbef705c96c93cb06ad09">~Object</a> ()</td></tr>
195<tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
196<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
197<tr class="memitem:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a">ObjectName</a> (void) const </td></tr>
198<tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name.  <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
199<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
200<tr class="memitem:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a609a250ec037fbcaf8957c8f1dcbfc53">ObjectType</a> (void) const </td></tr>
201<tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type.  <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
202<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
203<tr class="memitem:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a360c112cc3017a5152ebf6e84d2efa70">Parent</a> (void) const </td></tr>
204<tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent.  <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
205<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
206<tr class="memitem:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#ae22db4d723ec2d50b3ba48f26a6a770c">TypeChilds</a> (void) const </td></tr>
207<tr class="memdesc:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs of the same type.  <a href="#ae22db4d723ec2d50b3ba48f26a6a770c">More...</a><br /></td></tr>
208<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
209<tr class="memitem:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a344f81cd35805a9501098bf727ac1a10">Childs</a> (void) const </td></tr>
210<tr class="memdesc:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs.  <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
211<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
212<tr class="memitem:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#af001feba14fc053aa778e61080a0b4cf">Information</a> (const char *function, int line, const char *format,...) const </td></tr>
213<tr class="memdesc:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted information.  <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
214<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
215<tr class="memitem:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a168b18451b2ee6126e1e81d452005ff6">Warning</a> (const char *function, const char *format,...) const </td></tr>
216<tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted warning.  <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
217<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
218<tr class="memitem:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca">Error</a> (const char *function, const char *format,...) const </td></tr>
219<tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted error.  <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
220<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
221<tr class="memitem:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a36cdd7f556e78b1bddd1d1fe4264bb85">ErrorOccured</a> (bool recursive=true) const </td></tr>
222<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured?  <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
223<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
224</table><table class="memberdecls">
225<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
226Additional Inherited Members</h2></td></tr>
227<tr class="inherit_header pub_types_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
228<tr class="memitem:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
229<b>Red</b> = 31,
230<b>Green</b> = 32,
231<b>Orange</b> = 33
232 }</td></tr>
233<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
234<tr class="inherit_header pro_methods_classflair_1_1gui_1_1_widget"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classflair_1_1gui_1_1_widget')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classflair_1_1gui_1_1_widget.html">flair::gui::Widget</a></td></tr>
235<tr class="memitem:a0e81847db5a84b2e7e26545c9b1b704f inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
236<tr class="memitem:a0e81847db5a84b2e7e26545c9b1b704f inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a0e81847db5a84b2e7e26545c9b1b704f">SetPersistentXmlProp</a> (std::string prop, T value)</td></tr>
237<tr class="memdesc:a0e81847db5a84b2e7e26545c9b1b704f inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a persistent xml property.  <a href="#a0e81847db5a84b2e7e26545c9b1b704f">More...</a><br /></td></tr>
238<tr class="separator:a0e81847db5a84b2e7e26545c9b1b704f inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
239<tr class="memitem:a6404c7f474be994ec4e72a97e45dfffa inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
240<tr class="memitem:a6404c7f474be994ec4e72a97e45dfffa inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a6404c7f474be994ec4e72a97e45dfffa">GetPersistentXmlProp</a> (std::string prop, T &amp;value)</td></tr>
241<tr class="memdesc:a6404c7f474be994ec4e72a97e45dfffa inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a persistent xml property.  <a href="#a6404c7f474be994ec4e72a97e45dfffa">More...</a><br /></td></tr>
242<tr class="separator:a6404c7f474be994ec4e72a97e45dfffa inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
243<tr class="memitem:abe5ab96255919238138527c92fbeb6d8 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
244<tr class="memitem:abe5ab96255919238138527c92fbeb6d8 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#abe5ab96255919238138527c92fbeb6d8">SetVolatileXmlProp</a> (std::string prop, T value, xmlNodePtr node=NULL)</td></tr>
245<tr class="memdesc:abe5ab96255919238138527c92fbeb6d8 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a volatile xml property.  <a href="#abe5ab96255919238138527c92fbeb6d8">More...</a><br /></td></tr>
246<tr class="separator:abe5ab96255919238138527c92fbeb6d8 inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
247<tr class="memitem:ac80f72906580f269b5881c1ef0b35afb inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#ac80f72906580f269b5881c1ef0b35afb">SendXml</a> (void)</td></tr>
248<tr class="memdesc:ac80f72906580f269b5881c1ef0b35afb inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send xml.  <a href="#ac80f72906580f269b5881c1ef0b35afb">More...</a><br /></td></tr>
249<tr class="separator:ac80f72906580f269b5881c1ef0b35afb inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
250<tr class="memitem:a92d4e0613146c9b348b388f3f75cca9e inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1gui_1_1_widget.html#a92d4e0613146c9b348b388f3f75cca9e">XmlEvent</a> (void)</td></tr>
251<tr class="memdesc:a92d4e0613146c9b348b388f3f75cca9e inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="mdescLeft">&#160;</td><td class="mdescRight">Xml event.  <a href="#a92d4e0613146c9b348b388f3f75cca9e">More...</a><br /></td></tr>
252<tr class="separator:a92d4e0613146c9b348b388f3f75cca9e inherit pro_methods_classflair_1_1gui_1_1_widget"><td class="memSeparator" colspan="2">&#160;</td></tr>
253</table>
254<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
255<div class="textblock"><p>Base class for battery monitor. </p>
256</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
257<a class="anchor" id="aaa282725e3cc93b42f66e1e72c19ecae"></a>
258<div class="memitem">
259<div class="memproto">
260      <table class="memname">
261        <tr>
262          <td class="memname">flair::sensor::BatteryMonitor::BatteryMonitor </td>
263          <td>(</td>
264          <td class="paramtype">const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *&#160;</td>
265          <td class="paramname"><em>position</em>, </td>
266        </tr>
267        <tr>
268          <td class="paramkey"></td>
269          <td></td>
270          <td class="paramtype">std::string&#160;</td>
271          <td class="paramname"><em>name</em>&#160;</td>
272        </tr>
273        <tr>
274          <td></td>
275          <td>)</td>
276          <td></td><td></td>
277        </tr>
278      </table>
279</div><div class="memdoc">
280
281<p>Constructor. </p>
282<p>Construct a <a class="el" href="classflair_1_1sensor_1_1_battery_monitor.html" title="Base class for battery monitor. ">BatteryMonitor</a> at given position.</p>
283<dl class="params"><dt>Parameters</dt><dd>
284  <table class="params">
285    <tr><td class="paramname">position</td><td>position </td></tr>
286    <tr><td class="paramname">name</td><td>name </td></tr>
287  </table>
288  </dd>
289</dl>
290
291</div>
292</div>
293<a class="anchor" id="aefc9c63227a5a0a852ddba24ee7cd4e1"></a>
294<div class="memitem">
295<div class="memproto">
296      <table class="memname">
297        <tr>
298          <td class="memname">flair::sensor::BatteryMonitor::~BatteryMonitor </td>
299          <td>(</td>
300          <td class="paramname"></td><td>)</td>
301          <td></td>
302        </tr>
303      </table>
304</div><div class="memdoc">
305
306<p>Destructor. </p>
307
308</div>
309</div>
310<h2 class="groupheader">Member Function Documentation</h2>
311<a class="anchor" id="a102998c66cbb48ff71399189cb3371bb"></a>
312<div class="memitem">
313<div class="memproto">
314      <table class="memname">
315        <tr>
316          <td class="memname">bool flair::sensor::BatteryMonitor::IsBatteryLow </td>
317          <td>(</td>
318          <td class="paramtype">void&#160;</td>
319          <td class="paramname"></td><td>)</td>
320          <td> const</td>
321        </tr>
322      </table>
323</div><div class="memdoc">
324
325<p>Is batteru low? </p>
326<dl class="section return"><dt>Returns</dt><dd>true if battery is below threshold </dd></dl>
327
328</div>
329</div>
330<a class="anchor" id="a8eed791db4d0f82898e9bb8e3788d818"></a>
331<div class="memitem">
332<div class="memproto">
333      <table class="memname">
334        <tr>
335          <td class="memname">void flair::sensor::BatteryMonitor::SetBatteryValue </td>
336          <td>(</td>
337          <td class="paramtype">float&#160;</td>
338          <td class="paramname"><em>value</em></td><td>)</td>
339          <td></td>
340        </tr>
341      </table>
342</div><div class="memdoc">
343
344<p>Set battery value. </p>
345<dl class="params"><dt>Parameters</dt><dd>
346  <table class="params">
347    <tr><td class="paramname">battery</td><td>value </td></tr>
348  </table>
349  </dd>
350</dl>
351
352</div>
353</div>
354<a class="anchor" id="aaa0c9ae84cba9a3724f1c35ac61791f2"></a>
355<div class="memitem">
356<div class="memproto">
357      <table class="memname">
358        <tr>
359          <td class="memname">float flair::sensor::BatteryMonitor::GetVoltage </td>
360          <td>(</td>
361          <td class="paramtype">void&#160;</td>
362          <td class="paramname"></td><td>)</td>
363          <td> const</td>
364        </tr>
365      </table>
366</div><div class="memdoc">
367
368<p>Get battery voltage. </p>
369<dl class="section return"><dt>Returns</dt><dd>battery voltage </dd></dl>
370
371</div>
372</div>
373</div><!-- contents -->
374</div><!-- doc-content -->
375<!-- start footer part -->
376<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
377  <ul>
378    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1sensor.html">sensor</a></li><li class="navelem"><a class="el" href="classflair_1_1sensor_1_1_battery_monitor.html">BatteryMonitor</a></li>
379    <li class="footer">Generated on Wed Jun 22 2016 15:34:01 for Flair by
380    <a href="http://www.doxygen.org/index.html">
381    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
382  </ul>
383</div>
384</body>
385</html>
Note: See TracBrowser for help on using the repository browser.