All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
ignition::math::SignalStatistic Class Referenceabstract

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

#include <ignition/math/SignalStats.hh>

Inheritance diagram for ignition::math::SignalStatistic:
[legend]

Public Member Functions

 SignalStatistic ()
 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

SignalStatisticPrivatedataPtr
 Pointer to private data. More...
 

Detailed Description

Statistical properties of a discrete time scalar signal.

Constructor & Destructor Documentation

ignition::math::SignalStatistic::SignalStatistic ( )

Constructor.

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

Destructor.

Member Function Documentation

virtual size_t ignition::math::SignalStatistic::Count ( ) const
virtual

Get number of data points in measurement.

Returns
Number of data points in measurement.
virtual void ignition::math::SignalStatistic::InsertData ( const double  _data)
pure virtual
virtual void ignition::math::SignalStatistic::Reset ( )
virtual

Forget all previous data.

virtual std::string ignition::math::SignalStatistic::ShortName ( ) const
pure virtual

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

Returns
Short name of the statistical measure.

Implemented in ignition::math::SignalVariance, ignition::math::SignalMaxAbsoluteValue, ignition::math::SignalRootMeanSquare, ignition::math::SignalMinimum, ignition::math::SignalMean, and ignition::math::SignalMaximum.

virtual double ignition::math::SignalStatistic::Value ( ) const
pure virtual

Get the current value of the statistical measure.

Returns
Current value of the statistical measure.

Implemented in ignition::math::SignalVariance, ignition::math::SignalMaxAbsoluteValue, ignition::math::SignalRootMeanSquare, ignition::math::SignalMinimum, ignition::math::SignalMean, and ignition::math::SignalMaximum.

Member Data Documentation

SignalStatisticPrivate* ignition::math::SignalStatistic::dataPtr
protected

Pointer to private data.


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