Monitors::FuelLevel::BatteryData Class Reference

Detailed Description

Battery data for Fuel Level.

Public Types
enum	BatteryMeasures { BM_VOLTAGE, BM_CURRENT, BM_TEMPERATURE, BM_TOTAL }

Public Member Functions
	BatteryData (unsigned window_size[BM_TOTAL])
	~BatteryData (void)
void	setEntities (unsigned eids[])
bool	update (BatteryMeasures bm, uint8_t entity, float value)
bool	update (const IMC::Voltage *msg)
bool	update (const IMC::Current *msg)
bool	update (const IMC::Temperature *msg)
float	getEnergyDrop (float timestep) const
float	getVoltage (void) const
float	getCurrent (void) const
float	getTemperature (void) const
bool	gotMeasurements (void) const

Member Enumeration Documentation

enum Monitors::FuelLevel::BatteryData::BatteryMeasures

Enumerator
BM_VOLTAGE	Voltage measures.
BM_CURRENT	Current measures.
BM_TEMPERATURE	Temperature measures.
BM_TOTAL	Number of measures.

Constructor & Destructor Documentation

Monitors::FuelLevel::BatteryData::BatteryData ( unsigned  window_size[BM_TOTAL] )

inline

Constructor.

Parameters

[in]

window_size

moving averages window sizes

References BM_TOTAL.

Monitors::FuelLevel::BatteryData::~BatteryData ( void  )

inline

Destructor.

References BM_TOTAL.

Member Function Documentation

float Monitors::FuelLevel::BatteryData::getCurrent ( void  ) const

inline

Get current value.

Returns

current estimate

References BM_CURRENT, and DUNE::Math::MovingAverage< T >::mean().

Referenced by Monitors::FuelLevel::Task::computeInitialEstimate(), Monitors::FuelLevel::Task::getMergedEstimate(), and Monitors::FuelLevel::Task::task().

float Monitors::FuelLevel::BatteryData::getEnergyDrop ( float  timestep ) const

inline

Compute energy drop.

Parameters

[in]

timestep

elapsed time to use in computation

Returns

computed energy drop

References BM_CURRENT, BM_VOLTAGE, and DUNE::Math::MovingAverage< T >::mean().

Referenced by Monitors::FuelLevel::Task::consume().

float Monitors::FuelLevel::BatteryData::getTemperature ( void  ) const

inline

Get temperature value.

Returns

temperature estimate

References BM_TEMPERATURE, and DUNE::Math::MovingAverage< T >::mean().

Referenced by Monitors::FuelLevel::Task::computeInitialEstimate(), Monitors::FuelLevel::Task::getMergedEstimate(), and Monitors::FuelLevel::Task::task().

float Monitors::FuelLevel::BatteryData::getVoltage ( void  ) const

inline

Get voltage value.

Returns

voltage estimate

References BM_VOLTAGE, and DUNE::Math::MovingAverage< T >::mean().

Referenced by Monitors::FuelLevel::Task::getMapEstimate(), and Monitors::FuelLevel::Task::getModelEstimate().

bool Monitors::FuelLevel::BatteryData::gotMeasurements ( void  ) const

inline

Check if we have measurements.

Returns

false if some measurement has not been received yet

References BM_CURRENT, BM_TEMPERATURE, and BM_VOLTAGE.

Referenced by Monitors::FuelLevel::Task::task().

void Monitors::FuelLevel::BatteryData::setEntities ( unsigned  eids[] )

inline

Set message entities.

Parameters

[in]

eids

array of entity ids

Referenced by Monitors::FuelLevel::Task::onResourceAcquisition().

bool Monitors::FuelLevel::BatteryData::update ( BatteryMeasures  bm, uint8_t  entity, float  value  )

inline

Update a measurement.

Parameters

[in]	bm	battery measure type
[in]	entity	entity id to set
[in]	value	measure value to update with

Returns

true if the value has been updated

References DUNE::Math::MovingAverage< T >::update().

Referenced by Monitors::FuelLevel::Task::consume(), and update().

bool Monitors::FuelLevel::BatteryData::update ( const IMC::Voltage *  msg )

inline

Update Voltage.

Parameters

[in]

msg

voltage message pointer

Returns

true if value was updated

References BM_VOLTAGE, and update().

bool Monitors::FuelLevel::BatteryData::update ( const IMC::Current *  msg )

inline

Update Current.

Parameters

[in]

msg

current message pointer

Returns

true if value was updated

References BM_CURRENT, and update().

bool Monitors::FuelLevel::BatteryData::update ( const IMC::Temperature *  msg )

inline

Update Temperature.

Parameters

[in]

msg

temperature message pointer

Returns

true if value was updated

References BM_TEMPERATURE, and update().

Collaboration diagram for Monitors::FuelLevel::BatteryData: