cIEventlogManager Class Reference

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"

Inheritance diagram for cIEventlogManager:

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
virtual void	endRun (bool isError, int resultCode, const char *message)=0
Functions called from cEnvir's similar functions
virtual void	simulationEvent (cEvent *event)=0
virtual void	bubble (cComponent *component, const char *text)=0
virtual void	messageScheduled (cMessage *msg)=0
virtual void	messageCancelled (cMessage *msg)=0
virtual void	beginSend (cMessage *msg, const SendOptions &options)=0
virtual void	messageSendDirect (cMessage *msg, cGate *toGate, const ChannelResult &result)=0
virtual void	messageSendHop (cMessage *msg, cGate *srcGate)=0
virtual void	messageSendHop (cMessage *msg, cGate *srcGate, const ChannelResult &result)=0
virtual void	endSend (cMessage *msg)=0
virtual void	messageCreated (cMessage *msg)=0
virtual void	messageCloned (cMessage *msg, cMessage *clone)=0
virtual void	messageDeleted (cMessage *msg)=0
virtual void	moduleReparented (cModule *module, cModule *oldparent, int oldId)=0
virtual void	componentMethodBegin (cComponent *from, cComponent *to, const char *methodFmt, va_list va)=0
virtual void	componentMethodEnd ()=0
virtual void	moduleCreated (cModule *newmodule)=0
virtual void	moduleDeleted (cModule *module)=0
virtual void	gateCreated (cGate *newgate)=0
virtual void	gateDeleted (cGate *gate)=0
virtual void	connectionCreated (cGate *srcgate)=0
virtual void	connectionDeleted (cGate *srcgate)=0
virtual void	displayStringChanged (cComponent *component)=0
virtual void	logLine (const char *prefix, const char *line, int lineLength)=0
virtual void	stoppedWithException (bool isError, int resultCode, const char *message)=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)

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.

---

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

• envirext.h