Loading...
Searching...
No Matches
ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic Class Referenceabstract

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

#include <ignition/math/SignalStats.hh>

Inheritance diagram for ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic:

Public Member Functions

 SignalStatistic ()
 Constructor.
 
 SignalStatistic (const SignalStatistic &_ss)
 Copy constructor.
 
virtual ~SignalStatistic ()
 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.
 
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

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

Detailed Description

Statistical properties of a discrete time scalar signal.

Constructor & Destructor Documentation

◆ SignalStatistic() [1/2]

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

Constructor.

◆ ~SignalStatistic()

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

Destructor.

◆ SignalStatistic() [2/2]

ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic::SignalStatistic ( const SignalStatistic & _ss)

Copy constructor.

Parameters
[in]_ssSignalStatistic to copy

Member Function Documentation

◆ Count()

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

Get number of data points in measurement.

Returns
Number of data points in measurement.

◆ InsertData()

◆ Reset()

virtual void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic::Reset ( )
virtual

Forget all previous data.

◆ ShortName()

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

◆ Value()

Member Data Documentation

◆ dataPtr

std::unique_ptr<SignalStatisticPrivate> ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic::dataPtr
protected

Pointer to private data.


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