SignalStatistic Class Referenceabstract

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

#include <math/gzmath.hh>

Inherited by SignalMaxAbsoluteValue, SignalMean, and SignalRootMeanSquare.

Public Member Functions

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

Protected Attributes

std::unique_ptr< SignalStatisticPrivate > dataPtr
 Pointer to private data. More...
 

Detailed Description

Statistical properties of a discrete time scalar signal.

Constructor & Destructor Documentation

Constructor.

Deprecated:
See ignition::math::SignalStatistic
virtual ~SignalStatistic ( )
virtual

Destructor.

SignalStatistic ( const SignalStatistic _ss)

Copy constructor.

Parameters
[in]_ssSignalStatistic to copy
Deprecated:
See ignition::math::SignalStatistic

Member Function Documentation

virtual size_t Count ( ) const
virtual

Get number of data points in measurement.

Returns
Number of data points in measurement.
virtual void InsertData ( const double  _data)
pure virtual

Add a new sample to the statistical measure.

Parameters
[in]_dataNew signal data point.

Implemented in SignalMaxAbsoluteValue, SignalRootMeanSquare, and SignalMean.

virtual void Reset ( )
virtual

Forget all previous data.

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 SignalMaxAbsoluteValue, SignalRootMeanSquare, and SignalMean.

virtual double Value ( ) const
pure virtual

Get the current value of the statistical measure.

Returns
Current value of the statistical measure.

Implemented in SignalMaxAbsoluteValue, SignalRootMeanSquare, and SignalMean.

Member Data Documentation

std::unique_ptr<SignalStatisticPrivate> dataPtr
protected

Pointer to private data.


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