ros2_control::MovingAverageStatisticsData Class Reference

Data structure to store the statistics of a moving average. The data is protected by a mutex and the data can be updated and retrieved. More...

#include <statistics_types.hpp>

Public Member Functions
void	update_statistics (const std::shared_ptr< MovingAverageStatisticsCollector > &statistics)
	Update the statistics data with the new statistics data.
void	set_reset_statistics_sample_count (unsigned int reset_sample_count)
	Set the number of samples to reset the statistics.
void	reset ()
const StatisticData &	get_statistics () const
	Get the statistics data.

Detailed Description

Data structure to store the statistics of a moving average. The data is protected by a mutex and the data can be updated and retrieved.

Member Function Documentation

get_statistics()

const StatisticData & ros2_control::MovingAverageStatisticsData::get_statistics ( ) const

inline

Get the statistics data.

Returns

statistics data.

set_reset_statistics_sample_count()

void ros2_control::MovingAverageStatisticsData::set_reset_statistics_sample_count ( unsigned int  reset_sample_count )

inline

Set the number of samples to reset the statistics.

Parameters

reset_sample_count

number of samples to reset the statistics.

update_statistics()

void ros2_control::MovingAverageStatisticsData::update_statistics ( const std::shared_ptr< MovingAverageStatisticsCollector > &  statistics )

inline

Update the statistics data with the new statistics data.

Parameters

statistics

statistics collector to update the current statistics data.

---

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

• ros2_control/hardware_interface/include/hardware_interface/types/statistics_types.hpp