SignalStatistic Class Reference

Statistical properties of a discrete time scalar signal. More...

#include <gz/math/SignalStats.hh>

Public Member Functions
	SignalStatistic ()
	Constructor.
	SignalStatistic (const SignalStatistic &_ss)=default
	Copy constructor.
	SignalStatistic (SignalStatistic &&_ss)=default
	Move constructor.
virtual	~SignalStatistic ()=default
	Destructor.
virtual size_t	Count () const
	Get number of data points in measurement.
virtual void	InsertData (const double _data)=0
	Add a new sample to the statistical measure.
SignalStatistic &	operator= (const SignalStatistic &_s)=default
	Assignment operator.
SignalStatistic &	operator= (SignalStatistic &&_s)=default
	Move assignment operator.
virtual void	Reset ()
	Forget all previous data.
virtual std::string	ShortName () const =0
	Get a short version of the name of this statistical measure.
virtual double	Value () const =0
	Get the current value of the statistical measure.

Protected Attributes
::gz::utils::ImplPtr< Implementation >	dataPtr

Detailed Description

Statistical properties of a discrete time scalar signal.

Constructor & Destructor Documentation

SignalStatistic() [1/3]

SignalStatistic

(

)

Constructor.

~SignalStatistic()

virtual ~SignalStatistic ( )

virtualdefault

Destructor.

SignalStatistic() [2/3]

SignalStatistic ( const SignalStatistic &  _ss )

default

Copy constructor.

Parameters

[in]

_ss

SignalStatistic to copy

SignalStatistic() [3/3]

SignalStatistic ( SignalStatistic &&  _ss )

default

Move constructor.

Parameters

[in]

_ss

SignalStatistic to move

Member Function Documentation

Count()

virtual size_t Count ( ) const

virtual

Get number of data points in measurement.

Returns

Number of data points in measurement.

InsertData()

virtual void InsertData ( const double  _data )

pure virtual

Add a new sample to the statistical measure.

Parameters

[in]

_data

New signal data point.

Implemented in SignalMaximum, SignalMean, SignalMinimum, SignalRootMeanSquare, SignalMaxAbsoluteValue, and SignalVariance.

operator=() [1/2]

SignalStatistic & operator= ( const SignalStatistic &  _s )

default

Assignment operator.

Parameters

[in]

_s

A SignalStatistic to copy

Returns

this

operator=() [2/2]

SignalStatistic & operator= ( SignalStatistic &&  _s )

default

Move assignment operator.

Parameters

[in]

_s

A SignalStatistic to copy

Returns

this

Reset()

virtual void Reset ( )

virtual

Forget all previous data.

ShortName()

virtual std::string ShortName ( ) const

pure virtual

Get a short version of the name of this statistical measure.

Returns

Short name of the statistical measure.

Implemented in SignalMaximum, SignalMean, SignalMinimum, SignalRootMeanSquare, SignalMaxAbsoluteValue, and SignalVariance.

Value()

virtual double Value ( ) const

pure virtual

Get the current value of the statistical measure.

Returns

Current value of the statistical measure.

Implemented in SignalMaximum, SignalMean, SignalMinimum, SignalRootMeanSquare, SignalMaxAbsoluteValue, and SignalVariance.

Member Data Documentation

dataPtr

::gz::utils::ImplPtr<Implementation> dataPtr

protected

---

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

• SignalStats.hh