cIEventlogManager Class Reference

API: cIEventlogManager Class Reference
API
cIEventlogManager Class Referenceabstract
Inheritance diagram for cIEventlogManager:
[legend]

Public Member Functions

Constructor, destructor
 cIEventlogManager ()
virtual ~cIEventlogManager ()
Controlling the beginning and end of collecting data.
virtual void resume ()=0
virtual void suspend ()=0
virtual void flush ()=0
virtual const char * getFileName () const =0
Functions called from cEnvir's similar functions
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 cObjectgetThisPtr () const
virtual std::string str () const
virtual std::ostream & printOn (std::ostream &os) const
virtual cObjectdup () const
virtual void parsimPack (cCommBuffer *buffer) const
virtual void parsimUnpack (cCommBuffer *buffer)
virtual cObjectgetOwner () const
virtual bool isOwnedObject () const
virtual bool isSoftOwner () const
virtual void forEachChild (cVisitor *v)
cObjectfindObject (const char *name, bool deep=true)
virtual cClassDescriptorgetDescriptor () 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)

Description

Abstract base class for eventlog managers for cEnvir.

cIEventlogManagers are plugins into the Envir user interface library (src/envir) that handle the recording of simulation history into an event log.

The default eventlog manager is EventlogFileManager, defined in the Envir library.

To change the way event logs are written, subclass cIEventlogManager, register your new class with the Register_Class() macro, then select it by adding the following to omnetpp.ini:

[General]
eventlogmanager-class="MyClass"

Constructor & Destructor Documentation

◆ cIEventlogManager()

cIEventlogManager ( )
inlineexplicit

Constructor.

◆ ~cIEventlogManager()

virtual ~cIEventlogManager ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ resume()

virtual void resume ( )
pure virtual

(Re)starts eventlog recording. Whether eventlog recording is enabled by default depends on the eventlog manager (e.g. omnetpp.ini configuration options). This function may be called several times (from the user interface) during the simulation, but only between events. The eventlog manager is expected to produce output starting from the next event.

◆ suspend()

virtual void suspend ( )
pure virtual

Temporarily stops eventlog recording. See resume() for more details.

◆ flush()

virtual void flush ( )
pure virtual

Forces writing out all buffered output.

◆ getFileName()

virtual const char * getFileName ( ) const
pure virtual

Returns the output scalar file name. Returns nullptr if this object is not producing file output.