cOutputVectorManager Class Reference
[Extension interfaces]
Abstract base class for output vector managers for cEnvir. More...
#include <envirext.h>
Public Member Functions | |
Constructor, destructor | |
| cOutputVectorManager () | |
| virtual | ~cOutputVectorManager () |
Controlling the beginning and end of collecting data. | |
| virtual void | startRun ()=0 |
| virtual void | endRun ()=0 |
Output vectors. | |
| virtual void * | registerVector (const char *modulename, const char *vectorname)=0 |
| virtual void | deregisterVector (void *vechandle)=0 |
| virtual void | setVectorAttribute (void *vechandle, const char *name, const char *value)=0 |
| virtual bool | record (void *vechandle, simtime_t t, double value)=0 |
| virtual const char * | getFileName () const =0 |
| virtual void | flush ()=0 |
Detailed Description
Abstract base class for output vector managers for cEnvir.
cOutputVectorManagers are plugins into the Envir user interface library (src/envir) that handle recording the output for cOutVectors.
The default output vector manager is cFileOutputVectorManager, defined in the Envir library.
To change the way output vectors are written, subclass cOutputVectorManager, register your new class with the Register_Class() macro, then select it by adding the following to omnetpp.ini:
[General] outputvectormanager-class="MyClass"
Member Function Documentation
| virtual void cOutputVectorManager::endRun | ( | ) | [pure virtual] |
Closes collecting.
Called at the end of a simulation run.
| virtual const char* cOutputVectorManager::getFileName | ( | ) | const [pure virtual] |
Returns the output vector file name.
Returns NULL if this object is not producing file output.
| virtual bool cOutputVectorManager::record | ( | void * | vechandle, | |
| simtime_t | t, | |||
| double | value | |||
| ) | [pure virtual] |
This method is called internally by the Envir library when a cOutVector object writes a value into the output vector.
The return value should be true if the data was actually recorded, and false if it was not recorded (because of filtering, etc.)
| virtual void* cOutputVectorManager::registerVector | ( | const char * | modulename, | |
| const char * | vectorname | |||
| ) | [pure virtual] |
This method is called internally by the Envir library when a cOutVector object registers itself.
The return value is a handle of type void*; this handle is passed to record() to identify the vector.
| virtual void cOutputVectorManager::startRun | ( | ) | [pure virtual] |
Opens collecting.
Called at the beginning of a simulation run.
The documentation for this class was generated from the following file:
