OMNeT++ API 6.1
Discrete Event Simulation Library
List of all members
cPrecollectionBasedHistogramStrategy Class Referenceabstract
Statistical Result Collection

Description

Base class for histogram strategies that employ a precollection phase in order to gather input for setting up the bins. This class provides storage for the precollected values, and also a built-in algorithm for deciding when to stop precollection.

Inheritance diagram for cPrecollectionBasedHistogramStrategy:
[legend]

Public Member Functions

Constructors, copying.
 cPrecollectionBasedHistogramStrategy ()
 
 cPrecollectionBasedHistogramStrategy (const cPrecollectionBasedHistogramStrategy &other)
 
cPrecollectionBasedHistogramStrategy & operator= (const cPrecollectionBasedHistogramStrategy &other)
 
Configuring.
int getNumToPrecollect () const
 
void setNumToPrecollect (int numToPrecollect)
 
int getNumToCollate () const
 
void setNumToCollate (int numToCollate)
 
int getRangeUnchangedThreshold () const
 
void setRangeUnchangedThreshold (int threshold)
 
Redefined cIHistogramStrategy methods
virtual void setUpBins () override
 
virtual void clear () override
 
- Public Member Functions inherited from cIHistogramStrategy
 cIHistogramStrategy ()
 
 cIHistogramStrategy (const cIHistogramStrategy &other)
 
cIHistogramStrategy & operator= (const cIHistogramStrategy &other)
 
void setHistogram (cHistogram *hist)
 
cHistogram * getHistogram () const
 
virtual void collect (double value)=0
 
virtual void collectWeighted (double value, double weight)=0
 
- Public Member Functions inherited from cObject
 cObject ()
 
 cObject (const cObject &other)=default
 
virtual ~cObject ()
 
virtual const char * getClassName () const
 
virtual const char * getName () const
 
bool isName (const char *s) const
 
virtual const char * getFullName () const
 
virtual std::string getFullPath () const
 
virtual std::string getClassAndFullName () const
 
virtual std::string getClassAndFullPath () const
 
const cObject * getThisPtr () const
 
virtual std::string str () const
 
virtual std::ostream & printOn (std::ostream &os) const
 
virtual cObject * dup () const
 
virtual void parsimPack (cCommBuffer *buffer) const
 
virtual void parsimUnpack (cCommBuffer *buffer)
 
virtual cObject * getOwner () const
 
virtual bool isOwnedObject () const
 
virtual bool isSoftOwner () const
 
virtual void forEachChild (cVisitor *v)
 
cObject * findObject (const char *name, bool deep=true)
 
virtual cClassDescriptor * getDescriptor () const
 
void copyNotSupported () const
 

Additional Inherited Members

- Protected Member Functions inherited from cObject
virtual void take (cOwnedObject *obj)
 
virtual void drop (cOwnedObject *obj)
 
void dropAndDelete (cOwnedObject *obj)
 

Member Function Documentation

◆ setUpBins()

virtual void setUpBins ( )
overridevirtual

cHistogram's setUpBins() method delegates here. Implementations are expected to create bins in the associated histogram by calling its setBinEdges() or createUniformBins() method, and move possibly existing precollected observations into the bins using collectIntoHistogram().

Implements cIHistogramStrategy.

◆ clear()

virtual void clear ( )
overridevirtual

Called from cHistogram's clear() method, to give the strategy object an opportunity to clear its state.

Implements cIHistogramStrategy.

Reimplemented in cAutoRangeHistogramStrategy, and cDefaultHistogramStrategy.

Referenced by cDefaultHistogramStrategy::clear().

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