cSnapshotManager Class Reference
[Extension interfaces]
Abstract base class for snapshot managers. More...
#include <envirext.h>
Inheritance diagram for cSnapshotManager:
Public Member Functions | |
Constructor, destructor | |
| cSnapshotManager () | |
| virtual | ~cSnapshotManager () |
Controlling the beginning and end of collecting data. | |
| virtual void | startRun ()=0 |
| virtual void | endRun ()=0 |
Snapshot management | |
| virtual std::ostream * | getStreamForSnapshot ()=0 |
| virtual void | releaseStreamForSnapshot (std::ostream *os)=0 |
| virtual const char * | getFileName () const =0 |
Detailed Description
Abstract base class for snapshot managers.
cSnapshotManagers are plugins into the Envir user interface library (src/envir) that provide an output stream into which snapshots are written (see cSimulation::snapshot()).
The default output snapshot manager is cFileSnapshotManager, defined in the Envir library.
To create your own snaphot manager class, subclass cSnapshotManager, register your new class with the Register_Class() macro, then select it by adding the following to omnetpp.ini:
[General] snapshotmanager-class="MyClass"
Member Function Documentation
| virtual const char* cSnapshotManager::getFileName | ( | ) | const [pure virtual] |
Returns the snapshot file name.
Returns NULL if this object is not producing file output.
The documentation for this class was generated from the following file:
