Elements stored for managing statistical data. More...

#include <DataReaderImpl.h>

Collaboration diagram for OpenDDS::DCPS::WriterStats:

Public Member Functions
	WriterStats (int amount=0, DataCollector< double >::OnFull type=DataCollector< double >::KeepOldest)
	Default constructor. More...

void	add_stat (const TimeDuration &delay)
	Add a datum to the latency statistics. More...

LatencyStatistics	get_stats () const
	Extract the current latency statistics for this writer. More...

void	reset_stats ()
	Reset the latency statistics for this writer. More...

std::ostream &	raw_data (std::ostream &str) const
	Dump any raw data. More...

Private Attributes
Stats< double >	stats_
	Latency statistics for the DataWriter to this DataReader. More...

Detailed Description

Elements stored for managing statistical data.

Definition at line 84 of file DataReaderImpl.h.

Constructor & Destructor Documentation

◆ WriterStats()

OpenDDS::DCPS::WriterStats::WriterStats	(	int	amount = `0`,
		DataCollector< double >::OnFull	type = `DataCollector<double>::KeepOldest`
	)

Default constructor.

Definition at line 1982 of file DataReaderImpl.cpp.

                                       : stats_(amount, type)
 {
 }

Member Function Documentation

◆ add_stat()

void OpenDDS::DCPS::WriterStats::add_stat ( const TimeDuration & delay )

Add a datum to the latency statistics.

Definition at line 1988 of file DataReaderImpl.cpp.

References OpenDDS::DCPS::Stats< DataType >::add(), ACE_Time_Value::sec(), stats_, ACE_Time_Value::usec(), and OpenDDS::DCPS::TimeDuration::value().

 {
   double datum = static_cast<double>(delay.value().sec());
   datum += delay.value().usec() / 1000000.0;
   this->stats_.add(datum);
 }

◆ get_stats()

OpenDDS::DCPS::LatencyStatistics OpenDDS::DCPS::WriterStats::get_stats ( ) const

Extract the current latency statistics for this writer.

Definition at line 1995 of file DataReaderImpl.cpp.

References OpenDDS::DCPS::GUID_UNKNOWN, OpenDDS::DCPS::LatencyStatistics::maximum, OpenDDS::DCPS::Stats< DataType >::maximum(), OpenDDS::DCPS::LatencyStatistics::mean, OpenDDS::DCPS::Stats< DataType >::mean(), OpenDDS::DCPS::LatencyStatistics::minimum, OpenDDS::DCPS::Stats< DataType >::minimum(), OpenDDS::DCPS::LatencyStatistics::n, OpenDDS::DCPS::Stats< DataType >::n(), OpenDDS::DCPS::LatencyStatistics::publication, stats_, value, OpenDDS::DCPS::Stats< DataType >::var(), and OpenDDS::DCPS::LatencyStatistics::variance.

 {
   LatencyStatistics value;
 
   value.publication = GUID_UNKNOWN;
   value.n           = this->stats_.n();
   value.maximum     = this->stats_.maximum();
   value.minimum     = this->stats_.minimum();
   value.mean        = this->stats_.mean();
   value.variance    = this->stats_.var();
 
   return value;
 }

◆ raw_data()

std::ostream & OpenDDS::DCPS::WriterStats::raw_data ( std::ostream & str ) const

Dump any raw data.

Definition at line 2015 of file DataReaderImpl.cpp.

References OpenDDS::DCPS::Stats< DataType >::n(), OpenDDS::DCPS::DataCollector< DatumType >::size(), and stats_.

 {
   str << std::dec << this->stats_.size()
                               << " samples out of " << this->stats_.n() << std::endl;
   return str << this->stats_;
 }

◆ reset_stats()

void OpenDDS::DCPS::WriterStats::reset_stats ( )

Reset the latency statistics for this writer.

Definition at line 2009 of file DataReaderImpl.cpp.

References OpenDDS::DCPS::Stats< DataType >::reset(), and stats_.

 {
   this->stats_.reset();
 }

Member Data Documentation

◆ stats_

Stats<double> OpenDDS::DCPS::WriterStats::stats_

private

Latency statistics for the DataWriter to this DataReader.

Definition at line 110 of file DataReaderImpl.h.

Referenced by add_stat(), get_stats(), raw_data(), and reset_stats().

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

Public Member Functions

Private Attributes