Public Member Functions | Private Attributes | List of all members
power_monitor::BatteryObservation Class Reference

#include <observation.h>

Public Member Functions

 BatteryObservation (const ros::Time &stamp, bool ac_present, float voltage, float current, unsigned int relative_state_of_charge, float remaining_capacity, const ros::Duration &time_to_empty, const ros::Duration &time_to_full)
 
float getCurrent () const
 
float getPower () const
 
unsigned int getRelativeStateOfCharge () const
 
float getRemainingCapacity () const
 
const ros::TimegetStamp () const
 
const ros::DurationgetTimeToEmpty () const
 
const ros::DurationgetTimeToFull () const
 
float getVoltage () const
 
bool isAcPresent () const
 

Private Attributes

bool ac_present_
 
float current_
 
unsigned int relative_state_of_charge_
 
float remaining_capacity_
 
ros::Time stamp_
 
ros::Duration time_to_empty_
 
ros::Duration time_to_full_
 
float voltage_
 

Detailed Description

Stores information reported by a single battery.

Definition at line 78 of file observation.h.

Constructor & Destructor Documentation

◆ BatteryObservation()

BatteryObservation::BatteryObservation ( const ros::Time stamp,
bool  ac_present,
float  voltage,
float  current,
unsigned int  relative_state_of_charge,
float  remaining_capacity,
const ros::Duration time_to_empty,
const ros::Duration time_to_full 
)

Definition at line 176 of file observation.cpp.

Member Function Documentation

◆ getCurrent()

float BatteryObservation::getCurrent ( ) const

Definition at line 188 of file observation.cpp.

◆ getPower()

float BatteryObservation::getPower ( ) const

Definition at line 194 of file observation.cpp.

◆ getRelativeStateOfCharge()

unsigned int BatteryObservation::getRelativeStateOfCharge ( ) const

Definition at line 189 of file observation.cpp.

◆ getRemainingCapacity()

float BatteryObservation::getRemainingCapacity ( ) const

Definition at line 190 of file observation.cpp.

◆ getStamp()

const ros::Time & BatteryObservation::getStamp ( ) const

Definition at line 184 of file observation.cpp.

◆ getTimeToEmpty()

const ros::Duration & BatteryObservation::getTimeToEmpty ( ) const

Definition at line 191 of file observation.cpp.

◆ getTimeToFull()

const ros::Duration & BatteryObservation::getTimeToFull ( ) const

Definition at line 192 of file observation.cpp.

◆ getVoltage()

float BatteryObservation::getVoltage ( ) const

Definition at line 187 of file observation.cpp.

◆ isAcPresent()

bool BatteryObservation::isAcPresent ( ) const

Definition at line 186 of file observation.cpp.

Member Data Documentation

◆ ac_present_

bool power_monitor::BatteryObservation::ac_present_
private

Definition at line 98 of file observation.h.

◆ current_

float power_monitor::BatteryObservation::current_
private

Definition at line 100 of file observation.h.

◆ relative_state_of_charge_

unsigned int power_monitor::BatteryObservation::relative_state_of_charge_
private

Definition at line 101 of file observation.h.

◆ remaining_capacity_

float power_monitor::BatteryObservation::remaining_capacity_
private

Definition at line 102 of file observation.h.

◆ stamp_

ros::Time power_monitor::BatteryObservation::stamp_
private

Definition at line 97 of file observation.h.

◆ time_to_empty_

ros::Duration power_monitor::BatteryObservation::time_to_empty_
private

Definition at line 103 of file observation.h.

◆ time_to_full_

ros::Duration power_monitor::BatteryObservation::time_to_full_
private

Definition at line 104 of file observation.h.

◆ voltage_

float power_monitor::BatteryObservation::voltage_
private

Definition at line 99 of file observation.h.


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


power_monitor
Author(s): Tim Field, Curt Meyers
autogenerated on Wed Mar 8 2023 03:37:50