ERC CISST - cisst software

---

mtsIntervalStatistics Class Reference
[Multi Task Support]

#include <mtsIntervalStatistics.h>

Inheritance diagram for mtsIntervalStatistics:

[legend]Collaboration diagram for mtsIntervalStatistics:

[legend]List of all members.

---

Detailed Description

Calculate the statistics (avg,std,min,max) on the vector of data that is added one sample at time. AddSample checks if the statistics need to be recalculated after a given period elapses (eg 1sec).

Definition at line 46 of file mtsIntervalStatistics.h.

Public Types

• typedef unsigned long long int TimeTicksType
• typedef mtsGenericObject BaseType

Public Member Functions

• double GetAvg (void)
• double GetStdDev (void)
• double GetMax (void)
• double GetMin (void)
• void SetStatisticsUpdatePeriod (const double &time)
• double GetStatisticsUpdatePeriod (void)
• void AddSample (const double &sample)
• ~mtsIntervalStatistics ()
• virtual void ToStream (std::ostream &outputStream) const
• virtual void ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
• void SerializeRaw (std::ostream &outputStream) const
• virtual void DeSerializeRaw (std::istream &inputStream)

---

Member Typedef Documentation

typedef unsigned long long int mtsIntervalStatistics::TimeTicksType

TimeTicks are typedef'ed as unsigned long long (64 bits)

Definition at line 52 of file mtsIntervalStatistics.h.

typedef mtsGenericObject mtsIntervalStatistics::BaseType

Base type

Definition at line 55 of file mtsIntervalStatistics.h.

---

Member Function Documentation

double mtsIntervalStatistics::GetAvg

(

void

)

[inline]

The measured sample average.

Definition at line 58 of file mtsIntervalStatistics.h.

double mtsIntervalStatistics::GetStdDev

(

void

)

[inline]

The measured minimum period of the task

Definition at line 62 of file mtsIntervalStatistics.h.

double mtsIntervalStatistics::GetMax

(

void

)

[inline]

The measured maximum period of the task

Definition at line 67 of file mtsIntervalStatistics.h.

double mtsIntervalStatistics::GetMin

(

void

)

[inline]

The measured task period (difference between current Tic and previous Tic).

Definition at line 73 of file mtsIntervalStatistics.h.

void mtsIntervalStatistics::SetStatisticsUpdatePeriod

(

const double &

time

)

[inline]

Time period between period statistics calculations

Definition at line 78 of file mtsIntervalStatistics.h.

double mtsIntervalStatistics::GetStatisticsUpdatePeriod

(

void

)

[inline]

Get time period between period statistics calculations

Definition at line 82 of file mtsIntervalStatistics.h.

virtual void mtsIntervalStatistics::ToStream

(

std::ostream &

outputStream

)

const [virtual]

Human readable text output

Reimplemented from mtsGenericObject.

virtual void mtsIntervalStatistics::ToStreamRaw	(	std::ostream &	outputStream,
		const char	delimiter = ' ',
		bool	headerOnly = false,
		const std::string &	headerPrefix = ""
	)			const [virtual]

Machine reabable text output

Reimplemented from mtsGenericObject.

void mtsIntervalStatistics::SerializeRaw

(

std::ostream &

outputStream

)

const [virtual]

Serialize the content of the object without any extra information, i.e. no class type nor format version. The "receiver" is supposed to already know what to expect.

Reimplemented from mtsGenericObject.

virtual void mtsIntervalStatistics::DeSerializeRaw

(

std::istream &

inputStream

)

[virtual]

De-serialize the content of the object without any extra information, i.e. no class type nor format version.

Reimplemented from mtsGenericObject.

---

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

• mtsIntervalStatistics.h

---