<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GearBox Project</title>
<link rel="icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link rel="shortcut icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<!-- Google Analytics -->
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3583782-1");
pageTracker._initData();
pageTracker._trackPageview();
</script>
<!-- Returning you to your regular programming -->
</head><body>
<!-- Header -->
<table border="0" cellspacing="0" cellpadding="0">
<tr><!-- create row -->
<!-- spacer cell -->
<!-- #CC CC CC -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- menu cell -->
<td width="170" rowspan="1" colspan="1" align="left" valign="top" bgcolor="#EEEEEE">
<p> </p>
<p align="center"><a href="index.html"><img src="gbx_logo_cardbox_sky_150x150.png"></a></p><br>
<strong>INTRODUCTION</strong><br>
<strong><a href="gbx_doc_overview.html" style="text-decoration:none">Overview</a></strong><br>
<strong><a href="gbx_doc_getting.html" style="text-decoration:none">Download and Install</a></strong><br>
<!-- <strong><a href="gbx_doc_quickstart.html" style="text-decoration:none">Quick Start</a></strong><br> -->
<strong><a href="gbx_doc_documentation.html" style="text-decoration:none">Documentation</a></strong><br>
<strong><a href="gbx_doc_publications.html" style="text-decoration:none">Publications</a></strong><br>
<br>
<strong>REPOSITORY</strong><br>
<strong><a href="group__gbx__libs.html" style="text-decoration:none">Libraries</a></strong><br>
<!-- <strong><a href="group__gbx__utils.html" style="text-decoration:none">Utilities</a></strong><br> -->
<br>
<strong>DEVELOPER</strong><br>
<!--<strong><a href="gbx_doc_tutorials.html" style="text-decoration:none">Tutorials</a></strong><br>
<strong><a href="group__gbx__examples.html" style="text-decoration:none">Examples</a></strong><br>-->
<strong><a href="gbx_doc_devguide.html" style="text-decoration:none">Dev Guide</a></strong><br>
<!--
<strong><a href="gbx_doc_faq.html" style="text-decoration:none">FAQ</a></strong><br>
-->
<strong><a href="http://cdash.acfr.usyd.edu.au/index.php?project=Gearbox" style="text-decoration:none">Dashboard</a></strong><br>
<!--<strong><a href="http://wiki2.cas.edu.au/orca">Wiki</a></strong><br>
login/pass: orca/orca<br>-->
<br>
<strong>PEOPLE</strong><br>
<strong><a href="gbx_doc_contributors.html" style="text-decoration:none">Contributors</a></strong><br>
<strong><a href="gbx_doc_users.html" style="text-decoration:none">Users</a></strong><br>
<br>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=216468&type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a><br>
<strong><a href="http://sourceforge.net/projects/gearbox">Project</a></strong><br>
<strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468">Download</a></strong><br>
<!--<strong><a href="http://sourceforge.net/tracker/?group_id=216468">Bugs/Feedback</a></strong><br>-->
<strong><a href="http://sourceforge.net/mail/?group_id=216468">Mailing lists</a></strong></p>
<p> </p>
</td><!-- /menu cell -->
<!-- one grey spacer cells -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- one white spacer cells -->
<td rowspan="1" colspan="1"> </td>
<!-- main content cell -->
<td rowspan="1" colspan="1" align="left" valign="top">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_b8ba9ebcb71a95a44c4fd60b7d348fe1.html">src</a> » <a class="el" href="dir_d518df460b1b32d20efa9b08a7432143.html">gbxsmartbatteryacfr</a>
</div>
</div>
<div class="contents">
<h1>oceanserverhealthchecks.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * GearBox Project: Peer-Reviewed Open-Source Libraries for Robotics</span>
<a name="l00003"></a>00003 <span class="comment"> * http://gearbox.sf.net/</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (c) 2004-2009 Tobias Kaupp</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This distribution is licensed to you under the terms described in</span>
<a name="l00007"></a>00007 <span class="comment"> * the LICENSE file included in this distribution.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> */</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="preprocessor">#ifndef GBX_OCEANSERVER_HEALTH_CHECKS</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span><span class="preprocessor">#define GBX_OCEANSERVER_HEALTH_CHECKS</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span>
<a name="l00014"></a>00014 <span class="preprocessor">#include <gbxsmartbatteryacfr/oceanserversystem.h></span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="keyword">namespace </span>gbxsmartbatteryacfr
<a name="l00017"></a>00017 {
<a name="l00018"></a>00018
<a name="l00022"></a>00022 <span class="keywordtype">bool</span> checkNumCycles( <span class="keyword">const</span> OceanServerSystem &batteryData,
<a name="l00023"></a>00023 std::vector<std::string> &warnShort,
<a name="l00024"></a>00024 std::vector<std::string> &warnVerbose,
<a name="l00025"></a>00025 <span class="keywordtype">int</span> numCyclesThreshhold,
<a name="l00026"></a>00026 <span class="keywordtype">bool</span> printRawRecord = <span class="keyword">false</span> );
<a name="l00027"></a>00027
<a name="l00031"></a>00031 <span class="keywordtype">bool</span> checkTemperatures(<span class="keyword">const</span> OceanServerSystem &batteryData,
<a name="l00032"></a>00032 std::vector<std::string> &warnShort,
<a name="l00033"></a>00033 std::vector<std::string> &warnVerbose,
<a name="l00034"></a>00034 <span class="keywordtype">double</span> chargeTempThreshhold,
<a name="l00035"></a>00035 <span class="keywordtype">double</span> dischargeTempThreshhold,
<a name="l00036"></a>00036 <span class="keywordtype">bool</span> printRawRecord = <span class="keyword">false</span> );
<a name="l00037"></a>00037
<a name="l00040"></a>00040 <span class="keywordtype">bool</span> checkCharges(<span class="keyword">const</span> OceanServerSystem &batteryData,
<a name="l00041"></a>00041 std::vector<std::string> &warnShort,
<a name="l00042"></a>00042 std::vector<std::string> &warnVerbose,
<a name="l00043"></a>00043 <span class="keywordtype">int</span> chargeWarnThreshhold,
<a name="l00044"></a>00044 <span class="keywordtype">int</span> chargeDeviationThreshold );
<a name="l00045"></a>00045
<a name="l00048"></a>00048 <span class="keywordtype">bool</span> checkModuleHealth( <span class="keyword">const</span> OceanServerSystem &batteryData,
<a name="l00049"></a>00049 std::vector<std::string> &warnShort,
<a name="l00050"></a>00050 std::vector<std::string> &warnVerbose );
<a name="l00051"></a>00051
<a name="l00054"></a>00054 <span class="keywordtype">bool</span> <a class="code" href="namespacegbxsmartbatteryacfr.html#aabf773bbf3dab56b2d63c435d3bf6360">checkNumberOfBatteries</a>( <span class="keyword">const</span> OceanServerSystem &batteryData,
<a name="l00055"></a>00055 std::vector<std::string> &warnShort,
<a name="l00056"></a>00056 std::vector<std::string> &warnVerbose,
<a name="l00057"></a>00057 <span class="keywordtype">int</span> expectedNumBatteries );
<a name="l00058"></a>00058
<a name="l00061"></a><a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html">00061</a> <span class="keyword">struct </span><a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html">BatteryHealthWarningConfig</a>
<a name="l00062"></a>00062 {
<a name="l00064"></a><a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a0cc2e1d1789cb30d07cdd57ef4605543">00064</a> <span class="keywordtype">int</span> <a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a0cc2e1d1789cb30d07cdd57ef4605543" title="Expected number of battery modules installed.">expectedNumBatteries</a>;
<a name="l00066"></a><a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a42fa169e45d5584c888cfb293713e328">00066</a> <span class="keywordtype">int</span> <a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a42fa169e45d5584c888cfb293713e328" title="Maximum number of battery recharge cycles before a warning is issued.">numCyclesThreshhold</a>;
<a name="l00068"></a><a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a47dffa20311aefc0e06bd8c7c98959f1">00068</a> <span class="keywordtype">double</span> <a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a47dffa20311aefc0e06bd8c7c98959f1" title="Maximum charging temperature before a warning is issued.">chargeTempThreshhold</a>;
<a name="l00070"></a><a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a676462c6c1e281ad81551595d1315b76">00070</a> <span class="keywordtype">double</span> <a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a676462c6c1e281ad81551595d1315b76" title="Maximum discharging temperature before a warning is issued.">dischargeTempThreshhold</a>;
<a name="l00072"></a><a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a2da66fcac13a4755da52e4e4439b2a1c">00072</a> <span class="keywordtype">int</span> <a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a2da66fcac13a4755da52e4e4439b2a1c" title="Minimum charge in percent before a warning is issued.">chargeWarnThreshhold</a>;
<a name="l00074"></a><a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a96d729d6630cde7a0d56ee038a278654">00074</a> <span class="keywordtype">int</span> <a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html#a96d729d6630cde7a0d56ee038a278654" title="Minimum deviation of a single battery from the average of all batteries before a...">chargeDeviationThreshold</a>;
<a name="l00075"></a>00075 };
<a name="l00076"></a>00076
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> <a class="code" href="namespacegbxsmartbatteryacfr.html#ac41979a9a2ffda7ad1a004977428a51e">conductAllHealthChecks</a>( <span class="keyword">const</span> <a class="code" href="classgbxsmartbatteryacfr_1_1OceanServerSystem.html">OceanServerSystem</a> &batteryData,
<a name="l00082"></a>00082 <span class="keyword">const</span> <a class="code" href="structgbxsmartbatteryacfr_1_1BatteryHealthWarningConfig.html">BatteryHealthWarningConfig</a> &batteryCheckConfig,
<a name="l00083"></a>00083 std::vector<std::string> &warnShort,
<a name="l00084"></a>00084 std::vector<std::string> &warnVerbose,
<a name="l00085"></a>00085 <span class="keywordtype">bool</span> printRawRecord = <span class="keyword">false</span> );
<a name="l00086"></a>00086
<a name="l00087"></a>00087
<a name="l00088"></a>00088
<a name="l00089"></a>00089
<a name="l00090"></a>00090 } <span class="comment">// namespace</span>
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="preprocessor">#endif</span>
</pre></div></div>
</td>
<td colspan="1"> </td>
</tr>
</table>
<!-- end of table -->
<hr size="1"><address style="align: right;"><small>Generated for GearBox by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
