cOutputScalarManager Class Reference
[Extension interfaces]
Abstract base class for handling recording of output scalar data. More...
#include <envirext.h>
Public Member Functions | |
Constructor, destructor | |
| cOutputScalarManager () | |
| virtual | ~cOutputScalarManager () |
Controlling the beginning and end of collecting data. | |
| virtual void | startRun ()=0 |
| virtual void | endRun ()=0 |
Scalar statistics. | |
| virtual void | recordScalar (cComponent *component, const char *name, double value, opp_string_map *attributes=NULL)=0 |
| virtual void | recordStatistic (cComponent *component, const char *name, cStatistic *statistic, opp_string_map *attributes=NULL)=0 |
| virtual const char * | getFileName () const =0 |
| virtual void | flush ()=0 |
Detailed Description
Abstract base class for handling recording of output scalar data.
cOutputScalarManagers are plugins into the Envir user interface library (src/envir) that ultimately handle calls to the cComponent::recordScalar() family of functions.
The default output scalar manager is cFileOutputScalarManager, defined in the Envir library.
To change the way scalar results are recorded, subclass cOutputScalarManager, register your new class with the Register_Class() macro, then select it by adding the following to omnetpp.ini:
[General] outputscalarmanager-class="MyClass"
Member Function Documentation
| virtual void cOutputScalarManager::endRun | ( | ) | [pure virtual] |
Closes collecting.
Called at the end of a simulation run.
| virtual const char* cOutputScalarManager::getFileName | ( | ) | const [pure virtual] |
Returns the output scalar file name.
Returns NULL if this object is not producing file output.
| virtual void cOutputScalarManager::recordStatistic | ( | cComponent * | component, | |
| const char * | name, | |||
| cStatistic * | statistic, | |||
| opp_string_map * | attributes = NULL | |||
| ) | [pure virtual] |
Records a histogram or statistic object into the scalar result file.
This operation may invoke the transform() method on the histogram object.
| virtual void cOutputScalarManager::startRun | ( | ) | [pure virtual] |
Opens collecting.
Called at the beginning of a simulation run.
The documentation for this class was generated from the following file:
