cWeightedStdDev Class Reference
[Statistical data collection]

Statistics class to collect doubles and calculate weighted statistics of them. More...

#include <cstddev.h>

Inheritance diagram for cWeightedStdDev:
cStdDev cStatistic cOwnedObject cNamedObject cObject

List of all members.

Public Member Functions

Constructors, destructor, assignment.

 cWeightedStdDev (const cWeightedStdDev &r)
 cWeightedStdDev (const char *name=NULL)
virtual ~cWeightedStdDev ()
cWeightedStdDevoperator= (const cWeightedStdDev &res)
Redefined cObject member functions.

virtual cWeightedStdDevdup () const
virtual std::string info () const
virtual void parsimPack (cCommBuffer *buffer)
virtual void parsimUnpack (cCommBuffer *buffer)
Redefined cStatistic functions.

virtual void collect (double value)
virtual void collect (SimTime value)
virtual bool isWeighted () const
virtual void collect2 (double value, double weight)
virtual void collect2 (SimTime value, double weight)
virtual void collect2 (double value, SimTime weight)
virtual void collect2 (SimTime value, SimTime weight)
virtual void merge (const cStatistic *other)
virtual void clearResult ()
virtual double getMean () const
virtual double getVariance () const
virtual double getWeights () const
virtual double getWeightedSum () const
virtual double getSqrSumWeights () const
virtual double getWeightedSqrSum () const
virtual void saveToFile (FILE *) const
virtual void loadFromFile (FILE *)

Detailed Description

Statistics class to collect doubles and calculate weighted statistics of them.

It can be used for example to calculate time average.


Member Function Documentation

virtual cWeightedStdDev* cWeightedStdDev::dup (  )  const [inline, virtual]

Creates and returns an exact copy of this object.

See cObject for more details.

Reimplemented from cStdDev.

virtual double cWeightedStdDev::getMean (  )  const [inline, virtual]

Returns the mean of the observations collected.

Returns 0.0 if nothing was collected yet.

Reimplemented from cStdDev.

virtual std::string cWeightedStdDev::info (  )  const [virtual]

Produces a one-line description of the object's contents.

See cObject for more details.

Reimplemented from cStdDev.

cWeightedStdDev& cWeightedStdDev::operator= ( const cWeightedStdDev res  ) 

Assignment operator.

The name member is not copied; see cNamedObject's operator=() for more details.

virtual void cWeightedStdDev::parsimPack ( cCommBuffer buffer  )  [virtual]

Serializes the object into an MPI send buffer.

Used by the simulation kernel for parallel execution. See cObject for more details.

Reimplemented from cStdDev.

virtual void cWeightedStdDev::parsimUnpack ( cCommBuffer buffer  )  [virtual]

Deserializes the object from an MPI receive buffer Used by the simulation kernel for parallel execution.

See cObject for more details.

Reimplemented from cStdDev.


The documentation for this class was generated from the following file:
Generated on Mon Jul 14 12:57:26 2014 for OMNeT++ Simulation Library by  doxygen 1.6.3