cstatistic.h

//==========================================================================
//  CSTATISTIC.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//
//  Declaration of the following classes:
//    cStatistic : base for statistics
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 1992-2008 Andras Varga
  Copyright (C) 2006-2008 OpenSim Ltd.

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/

#ifndef __CSTATISTIC_H
#define __CSTATISTIC_H

#include <stdio.h>
#include "cownedobject.h"
#include "simtime.h"

NAMESPACE_BEGIN

class cTransientDetection;
class cAccuracyDetection;


class SIM_API cStatistic : public cOwnedObject
{
  public:
    cTransientDetection *td;    // ptr to associated object
    cAccuracyDetection *ra;     // ptr to associated object
    int genk;                   // index of random number generator to use

  private:
    void copy(const cStatistic& other);

  protected:
    // internal: utility function for implementing loadFromFile() functions
    void freadvarsf (FILE *f,  const char *fmt, ...);
    // internal: for collecting the attributes to record into the scalar file
    virtual void getAttributesToRecord(opp_string_map& attributes) {}

  public:

    cStatistic(const cStatistic& r);

    explicit cStatistic(const char *name=NULL);

    virtual ~cStatistic();

    cStatistic& operator=(const cStatistic& res);


    /* Note: No dup() because this is an abstract class! */

    virtual void parsimPack(cCommBuffer *buffer);

    virtual void parsimUnpack(cCommBuffer *buffer);


    virtual void collect(double value) = 0;

    virtual void collect(SimTime value) {collect(value.dbl());}

    virtual bool isWeighted() const = 0;

    virtual void collect2(double value, double weight);

    virtual void merge(const cStatistic *other) = 0;

    virtual void clearResult() = 0;


    virtual long getCount() const = 0;

    virtual double getSum() const = 0;

    virtual double getSqrSum() const = 0;

    virtual double getMin() const = 0;

    virtual double getMax() const = 0;

    virtual double getMean() const = 0;

    virtual double getStddev() const = 0;

    virtual double getVariance() const = 0;

    virtual double getWeights() const = 0;

    virtual double getWeightedSum() const = 0;

    virtual double getSqrSumWeights() const = 0;

    virtual double getWeightedSqrSum() const = 0;


    void addTransientDetection(cTransientDetection *object);

    void addAccuracyDetection(cAccuracyDetection *object);

    cTransientDetection *getTransientDetectionObject() const  {return td;}

    cAccuracyDetection  *getAccuracyDetectionObject() const  {return ra;}


    void setGenK(int gen_nr)   {genk=gen_nr;}

    virtual double random() const = 0;


    virtual void saveToFile(FILE *) const = 0;

    virtual void loadFromFile(FILE *) = 0;

    virtual void record()  {recordAs(NULL, NULL);}

    virtual void recordWithUnit(const char *unit)  {recordAs(NULL, unit);}

    virtual void recordAs(const char *name, const char *unit=NULL);
};

NAMESPACE_END

#endif