power_monitor::PowerStateEstimator Class Reference

#include <power_state_estimator.h>

Inheritance diagram for power_monitor::PowerStateEstimator:

[legend]

List of all members.

Public Types
enum	Type { FuelGauge, Advanced }
Public Member Functions
virtual bool	canEstimate (const ros::Time &t) const
virtual PowerStateEstimate	estimate (const ros::Time &t)=0
virtual std::string	getMethodName () const =0
virtual PowerStateEstimator::Type	getMethodType () const =0
	PowerStateEstimator ()
virtual void	recordObservation (const PowerObservation &obs)
Protected Attributes
PowerObservation	obs_

---

Detailed Description

PowerStateEstimator can takes observable power inputs (PowerObservation) and estimates the hidden power state (PowerStateEstimate).

Definition at line 55 of file power_state_estimator.h.

---

Member Enumeration Documentation

enum power_monitor::PowerStateEstimator::Type

Enumerator:

FuelGauge
Advanced

Definition at line 58 of file power_state_estimator.h.

---

Constructor & Destructor Documentation

PowerStateEstimator::PowerStateEstimator

(

)

Definition at line 52 of file power_state_estimator.cpp.

---

Member Function Documentation

bool PowerStateEstimator::canEstimate

(

const ros::Time &

t

)

const [virtual]

Definition at line 59 of file power_state_estimator.cpp.

virtual PowerStateEstimate power_monitor::PowerStateEstimator::estimate

(

const ros::Time &

t

)

[pure virtual]

Implemented in power_monitor::FuelGaugePowerStateEstimator, and power_monitor::AdvancedPowerStateEstimator.

virtual std::string power_monitor::PowerStateEstimator::getMethodName

(

)

const [pure virtual]

Implemented in power_monitor::FuelGaugePowerStateEstimator, and power_monitor::AdvancedPowerStateEstimator.

virtual PowerStateEstimator::Type power_monitor::PowerStateEstimator::getMethodType

(

)

const [pure virtual]

Implemented in power_monitor::FuelGaugePowerStateEstimator, and power_monitor::AdvancedPowerStateEstimator.

void PowerStateEstimator::recordObservation

(

const PowerObservation &

obs

)

[virtual]

Reimplemented in power_monitor::AdvancedPowerStateEstimator.

Definition at line 54 of file power_state_estimator.cpp.

---

Member Data Documentation

PowerObservation power_monitor::PowerStateEstimator::obs_ [protected]

Definition at line 71 of file power_state_estimator.h.

---

The documentation for this class was generated from the following files:

• power_state_estimator.h
• power_state_estimator.cpp