oceanserverhealthchecks.h

00001 /*
00002  * GearBox Project: Peer-Reviewed Open-Source Libraries for Robotics
00003  *               http://gearbox.sf.net/
00004  * Copyright (c) 2004-2010 Tobias Kaupp
00005  *
00006  * This distribution is licensed to you under the terms described in
00007  * the LICENSE file included in this distribution.
00008  *
00009  */
00010 
00011 #ifndef GBX_OCEANSERVER_HEALTH_CHECKS
00012 #define GBX_OCEANSERVER_HEALTH_CHECKS
00013 
00014 #include <gbxsmartbatteryacfr/oceanserversystem.h>
00015 
00016 namespace gbxsmartbatteryacfr
00017 {
00018 
00022 bool checkNumCycles( const OceanServerSystem  &batteryData, 
00023                      std::vector<std::string> &warnShort, 
00024                      std::vector<std::string> &warnVerbose,
00025                      int                       numCyclesThreshhold,
00026                      bool                      printRawRecord = false );
00027 
00031 bool checkTemperatures(const OceanServerSystem  &batteryData, 
00032                        std::vector<std::string> &warnShort, 
00033                        std::vector<std::string> &warnVerbose,
00034                        double                    chargeTempThreshhold,
00035                        double                    dischargeTempThreshhold,
00036                        bool                      printRawRecord = false );
00037                        
00040 bool checkCharges(const OceanServerSystem  &batteryData, 
00041                   std::vector<std::string> &warnShort, 
00042                   std::vector<std::string> &warnVerbose,
00043                   int                       chargeWarnThreshhold,
00044                   int                       chargeDeviationThreshold );
00045 
00048 bool checkModuleHealth( const OceanServerSystem  &batteryData, 
00049                         std::vector<std::string> &warnShort, 
00050                         std::vector<std::string> &warnVerbose );
00051 
00054 bool checkNumberOfBatteries( const OceanServerSystem  &batteryData, 
00055                              std::vector<std::string> &warnShort, 
00056                              std::vector<std::string> &warnVerbose,
00057                              int                       expectedNumBatteries );
00058 
00061 struct BatteryHealthWarningConfig 
00062 {
00064     int expectedNumBatteries;
00066     int numCyclesThreshhold;
00068     double chargeTempThreshhold;
00070     double dischargeTempThreshhold;
00072     int chargeWarnThreshhold;
00074     int chargeDeviationThreshold;
00075 };
00076 
00081 bool conductAllHealthChecks( const OceanServerSystem          &batteryData,
00082                              const BatteryHealthWarningConfig &batteryCheckConfig,
00083                              std::vector<std::string>         &warnShort,
00084                              std::vector<std::string>         &warnVerbose,
00085                              bool                              printRawRecord = false );
00086                        
00087 
00088 
00089 
00090 } // namespace
00091 
00092 #endif