mtsIntervalStatistics.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*
  Author(s):  Marcin Balicki, Anton Deguet
  Created on: 2010-03-31

  (C) Copyright 2010-2014 Johns Hopkins University (JHU), All Rights Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/


#ifndef _mtsIntervalStatistics_h
#define _mtsIntervalStatistics_h

#include <cisstMultiTask/mtsGenericObject.h>
#include <cisstMultiTask/mtsGenericObjectProxy.h>
#include <cisstCommon/cmnSerializer.h>
#include <cisstCommon/cmnDeSerializer.h>
#include <cisstCommon/cmnGenericObjectProxy.h>
#include <cisstOSAbstraction/osaTimeServer.h>
#include <cisstMultiTask/mtsTaskManager.h>

#include <cisstMultiTask/mtsExport.h>

class CISST_EXPORT mtsIntervalStatistics : public mtsGenericObject {

    CMN_DECLARE_SERVICES(CMN_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);

public:
    typedef unsigned long long int TimeTicksType;

    typedef mtsGenericObject BaseType;

    inline double GetAvg(void) const {
        return Avg;
    }
    inline double GetStdDev(void) const {
        return StdDev;
    }

    inline double GetMax(void) const {
        return Max;
    }

    inline double GetMin(void) const {
        return Min;
    }

    inline double MinComputeTime(void) const {
        return mMinComputeTime;
    }

    inline double MaxComputeTime(void) const {
        return mMaxComputeTime;
    }

    inline void SetStatisticsUpdatePeriod(const double & time) {
        StatisticsUpdatePeriod = time;
    }

    inline double GetStatisticsUpdatePeriod(void) const {
        return StatisticsUpdatePeriod;
    }

    void AddSample(const double sample);

    void AddComputeTime(const double computeTime);

private:

    double          Sum;   //name clash with original SumOfPeriods
    double          SumOfSquares;
    unsigned int    NumberOfSamples;
    double          LastUpdateTime;
    double          TempMax;
    double          TempMin;

    const osaTimeServer * TimeServer;

    double         Avg;
    double         StdDev;
    double         Max;
    double         Min;
    double mMinComputeTime;
    double mMaxComputeTime;
    double         StatisticsUpdatePeriod;

public:

    mtsIntervalStatistics();
    inline ~mtsIntervalStatistics() {};

    void ToStream(std::ostream & outputStream) const;

    void ToStreamRaw(std::ostream & outputStream, const char delimiter = ' ',
                     bool headerOnly = false, const std::string & headerPrefix = "") const;

    void SerializeRaw(std::ostream & outputStream) const;

    virtual void DeSerializeRaw(std::istream & inputStream);
};

CMN_DECLARE_SERVICES_INSTANTIATION(mtsIntervalStatistics)

#endif // _mtsIntervalStatistics_h