OMNeT++ Simulation Library  5.6.1
cResultRecorder Class Reference

#include <cresultrecorder.h>

Description

Abstract base class for result recorders.

See also
Register_ResultRecorder()
Inheritance diagram for cResultRecorder:
cResultListener cObject cIListener cNumericResultRecorder TotalCountRecorder AverageRecorder ErrorNanRecorder LastValueRecorder MaxRecorder MeanRecorder MinRecorder StatisticsRecorder SumRecorder TimeAverageRecorder VectorRecorder CountRecorder

Public Member Functions

virtual void init (cComponent *component, const char *statisticName, const char *recordingMode, cProperty *attrsProperty, opp_string_map *manualAttrs=nullptr)
 
virtual const char * getName () const override
 
virtual std::string getFullPath () const override
 
- Public Member Functions inherited from cObject
 cObject ()
 
 cObject (const cObject &other)
 
virtual ~cObject ()
 
virtual const char * getClassName () const
 
bool isName (const char *s) const
 
virtual const char * getFullName () const
 
const cObjectgetThisPtr () const
 
virtual std::string str () const
 
virtual _OPPDEPRECATED std::string info () const
 
virtual _OPPDEPRECATED std::string detailedInfo () const
 
virtual cObjectdup () const
 
virtual void parsimPack (cCommBuffer *buffer) const
 
virtual void parsimUnpack (cCommBuffer *buffer)
 
virtual cObjectgetOwner () const
 
virtual bool isOwnedObject () const
 
virtual void forEachChild (cVisitor *v)
 
cObjectfindObject (const char *name, bool deep=true)
 
void copyNotSupported () const
 
- Public Member Functions inherited from cIListener
int getSubscribeCount () const
 

Additional Inherited Members

- Protected Member Functions inherited from cResultListener
virtual void receiveSignal (cComponent *source, simsignal_t signalID, bool b, cObject *details) override
 
virtual void receiveSignal (cComponent *source, simsignal_t signalID, long l, cObject *details) override
 
virtual void receiveSignal (cComponent *source, simsignal_t signalID, unsigned long l, cObject *details) override
 
virtual void receiveSignal (cComponent *source, simsignal_t signalID, double d, cObject *details) override
 
virtual void receiveSignal (cComponent *source, simsignal_t signalID, const SimTime &v, cObject *details) override
 
virtual void receiveSignal (cComponent *source, simsignal_t signalID, const char *s, cObject *details) override
 
virtual void receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
 
virtual void subscribedTo (cComponent *component, simsignal_t signalID) override
 
virtual void unsubscribedFrom (cComponent *component, simsignal_t signalID) override
 
virtual void finish (cComponent *component, simsignal_t signalID) override
 
- Protected Member Functions inherited from cObject
virtual void take (cOwnedObject *obj)
 
virtual void drop (cOwnedObject *obj)
 
void dropAndDelete (cOwnedObject *obj)
 

Member Function Documentation

◆ init()

virtual void init ( cComponent component,
const char *  statisticName,
const char *  recordingMode,
cProperty attrsProperty,
opp_string_map manualAttrs = nullptr 
)
virtual

Sets contextual information on the result recorder: it will record a (scalar, vector, etc) result for the given component, with a name composed of statisticName and recordingMode, result attributes taken either from the keys and values of the attrsProperty NED property, or from the manualAttrs string map (exactly one of the two must be non-nullptr). manualAttrs, when specified, will be owned (i.e. deleted) by the result recorder object.

Reimplemented in MeanRecorder.

◆ getName()

virtual const char* getName ( ) const
inlineoverridevirtual

Returns pointer to the object's name. It should never return nullptr. This default implementation just returns an empty string ("").

Reimplemented from cObject.

◆ getFullPath()

virtual std::string getFullPath ( ) const
inlineoverridevirtual

Returns the full path of the object in the object hierarchy, like "net.host[2].tcp.winsize". This method relies on getOwner(): if there is an owner object, this method returns the owner's fullPath plus this object's fullName, separated by a dot; otherwise it simply returns fullName.

Reimplemented from cObject.


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