MonitorPointNumeric.h

Go to the documentation of this file.

#ifndef CARMA_MONITOR_MONITORPOINTNUMERIC_H
#define CARMA_MONITOR_MONITORPOINTNUMERIC_H


#include "carma/monitor/MonitorPoint.h"
#include "carma/monitor/MonitorPointAverageT.h"

namespace carma {
namespace monitor {


typedef MonitorPointAverageT< double > MonitorPointAverageNumeric;

class MonitorPointNumeric: public MonitorPoint {
public:


    virtual ~MonitorPointNumeric() ;

    void setTimeSeries(bool timeSeries);

    // Override base class
    bool operator==(const MonitorComponent& component) const;

    virtual void  resetAccumulator(MonitorPointAverageNumeric& average) const ;

    virtual enum MonitorPoint::VALIDITY accumulateSample
                       (MonitorPointAverageNumeric& average, int index) const ;

    virtual void   accumulate (MonitorPointAverageNumeric& average) const ;

    virtual void accumulateAverage (MonitorPointAverageNumeric& accumulator) ;

    double getAccumulatedAverageDouble
                             (const MonitorPointAverageNumeric& average) const;

    double getMaxValueDouble (const MonitorPointAverageNumeric& average) const;

    double getMinValueDouble (const MonitorPointAverageNumeric& average) const;

    virtual double getValueNumeric( int sampleIndex ) const = 0;

    virtual double getAveNumeric( ) const = 0;

protected:

    MonitorPointNumeric( const ::std::string & name,
                         MonitorValueType      valuetype,
                         MONITOR_POINT_TYPE    monitorPointType = MONITOR );

    // Also stores numValidSamples and aveValidity
    double computeFrameAverage( MonitorPointAverageNumeric & scratchAvg );

    VALIDITY getAveValidityNumeric( ) const;

    BLANKING_FLAGGING getBlankingFlaggingNumeric( ) const;

private:
    MonitorPointNumeric( );

    double              sum_;
    int                 nValidSamples_;
    VALIDITY            aveValidity_;
    BLANKING_FLAGGING   aveBlankingFlagging_;
};


}  // namespace carma::monitor
}  // namespace carma


inline void
carma::monitor::MonitorPointNumeric::setTimeSeries( const bool timeSeries )
{
    timeSeries_ = timeSeries;
}


inline double
carma::monitor::MonitorPointNumeric::getMaxValueDouble(
    const MonitorPointAverageNumeric & avg ) const
{
    return ((avg.getNumValidSamples() > 0) ? avg.getMaxValue() : 0.0);
}


inline double
carma::monitor::MonitorPointNumeric::getMinValueDouble(
    const MonitorPointAverageNumeric & avg ) const
{
    return ((avg.getNumValidSamples() > 0) ? avg.getMinValue() : 0.0);
}


inline carma::monitor::MonitorPoint::VALIDITY
carma::monitor::MonitorPointNumeric::getAveValidityNumeric( ) const
{
    return aveValidity_;
}


inline carma::monitor::MonitorPoint::BLANKING_FLAGGING
carma::monitor::MonitorPointNumeric::getBlankingFlaggingNumeric( ) const
{
    return aveBlankingFlagging_;
}


#endif