observation.h
Go to the documentation of this file.
00001 /*********************************************************************
00002  * Software License Agreement (BSD License)
00003  *
00004  *  Copyright (c) 2009, Willow Garage, Inc.
00005  *  All rights reserved.
00006  *
00007  *  Redistribution and use in source and binary forms, with or without
00008  *  modification, are permitted provided that the following conditions
00009  *  are met:
00010  *
00011  *   * Redistributions of source code must retain the above copyright
00012  *     notice, this list of conditions and the following disclaimer.
00013  *   * Redistributions in binary form must reproduce the above
00014  *     copyright notice, this list of conditions and the following
00015  *     disclaimer in the documentation and/or other materials provided
00016  *     with the distribution.
00017  *   * Neither the name of the Willow Garage nor the names of its
00018  *     contributors may be used to endorse or promote products derived
00019  *     from this software without specific prior written permission.
00020  *
00021  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00022  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00023  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00024  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00025  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00026  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00027  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00028  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00031  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00032  *  POSSIBILITY OF SUCH DAMAGE.
00033  *********************************************************************/
00034 
00035 #ifndef POWER_MONITOR_OBSERVATION_H
00036 #define POWER_MONITOR_OBSERVATION_H
00037 
00038 #include <stdlib.h>
00039 
00040 #include "ros/ros.h"
00041 
00042 #include "pr2_msgs/PowerBoardState.h"
00043 
00044 namespace power_monitor {
00045 
00046 class BatteryObservation;
00047 
00051 class PowerObservation
00052 {
00053 public:
00054     PowerObservation();
00055     PowerObservation(const ros::Time& stamp, int8_t master_state, const std::vector<BatteryObservation>& batteries);
00056 
00057     const ros::Time&                       getStamp() const;
00058     int8_t                                 getMasterState() const;
00059     const std::vector<BatteryObservation>& getBatteries() const;
00060 
00061     unsigned int  getAcCount() const;
00062     float         getTotalPower() const;
00063     float         getMinVoltage() const;
00064     unsigned int  getMinRelativeStateOfCharge() const;
00065     float         getTotalRemainingCapacity() const;
00066     ros::Duration getMinTimeToEmpty(const ros::Time& t) const;
00067     ros::Duration getMaxTimeToFull(const ros::Time& t) const;
00068 
00069 private:
00070     ros::Time                       stamp_;
00071     int8_t                          master_state_;
00072     std::vector<BatteryObservation> batteries_;
00073 };
00074 
00078 class BatteryObservation
00079 {
00080 public:
00081     BatteryObservation(const ros::Time& stamp, bool ac_present, float voltage, float current,
00082                        unsigned int relative_state_of_charge, float remaining_capacity, const ros::Duration& time_to_empty, const ros::Duration& time_to_full);
00083 
00084     const ros::Time& getStamp() const;
00085 
00086     bool                 isAcPresent() const;
00087     float                getVoltage() const;
00088     float                getCurrent() const;
00089     unsigned int         getRelativeStateOfCharge() const;
00090     float                getRemainingCapacity() const;
00091     const ros::Duration& getTimeToEmpty() const;
00092     const ros::Duration& getTimeToFull() const;
00093 
00094     float getPower() const;
00095 
00096 private:
00097     ros::Time     stamp_;
00098     bool          ac_present_;
00099     float         voltage_;                   // V
00100     float         current_;                   // A (-ve if discharging)
00101     unsigned int  relative_state_of_charge_;  // % [0-100]
00102     float         remaining_capacity_;        // Ah
00103     ros::Duration time_to_empty_;
00104     ros::Duration time_to_full_;
00105 };
00106 
00107 }
00108 
00109 #endif /* POWER_MONITOR_OBSERVATION_H */


power_monitor
Author(s): Tim Field, Curt Meyers
autogenerated on Tue Apr 22 2014 19:35:04