Loading...
Searching...
No Matches
ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalMinimum Class Reference

Computing the minimum value of a discretely sampled signal. More...

#include <ignition/math/SignalStats.hh>

Inheritance diagram for ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalMinimum:

Public Member Functions

virtual void InsertData (const double _data)
 Add a new sample to the statistical measure.
 
virtual std::string ShortName () const
 Get a short version of the name of this statistical measure.
 
virtual double Value () const
 Get the current value of the statistical measure.
 
- Public Member Functions inherited from ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic
 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 Reset ()
 Forget all previous data.
 

Additional Inherited Members

- Protected Attributes inherited from ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic
std::unique_ptr< SignalStatisticPrivate > dataPtr
 Pointer to private data.
 

Detailed Description

Computing the minimum value of a discretely sampled signal.

Member Function Documentation

◆ InsertData()

virtual void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalMinimum::InsertData ( const double _data)
virtual

Add a new sample to the statistical measure.

Parameters
[in]_dataNew signal data point.

Implements ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic.

◆ ShortName()

virtual std::string ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalMinimum::ShortName ( ) const
virtual

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

Returns
"min"

Implements ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic.

◆ Value()

virtual double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalMinimum::Value ( ) const
virtual

Get the current value of the statistical measure.

Returns
Current value of the statistical measure.

Implements ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic.


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