cresultrecorder.h

//==========================================================================
//  CRESULTRECORDER.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================
 
/*--------------------------------------------------------------*
  Copyright (C) 1992-2017 Andras Varga
  Copyright (C) 2006-2017 OpenSim Ltd.
 
  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/
 
#ifndef __OMNETPP_CRESULTRECORDER_H
#define __OMNETPP_CRESULTRECORDER_H
 
#include "cresultlistener.h"
#include "ccomponent.h"
#include "onstartup.h"
#include "opp_pooledstring.h"
#include "globals.h"
 
namespace omnetpp {
 
class cResultRecorder;
class cProperty;
 
#define Register_ResultRecorder(NAME, CLASSNAME) \
  __REGISTER_CLASS_X(CLASSNAME, omnetpp::cResultRecorder, "result recorder", omnetpp::internal::resultRecorders.getInstance()->add(new omnetpp::cResultRecorderType(NAME,omnetpp::opp_typename(typeid(CLASSNAME)))) )
 
#define Register_ResultRecorder2(NAME, CLASSNAME, DESCRIPTION) \
  __REGISTER_CLASS_X(CLASSNAME, omnetpp::cResultRecorder, "result recorder", omnetpp::internal::resultRecorders.getInstance()->add(new omnetpp::cResultRecorderType(NAME,omnetpp::opp_typename(typeid(CLASSNAME)),DESCRIPTION)) )
 
 
class SIM_API cResultRecorder : public cResultListener
{
    public:
        struct Context {
            cComponent *component;     
            const char *statisticName; 
            const char *recordingMode; 
            cProperty *attrsProperty;  
            opp_string_map *manualAttrs = nullptr;  // If attrsProperty==nullptr, specifies an alternative source of attributes; the ownership is passed into the  result recorder object.
        };
    private:
        cComponent *component = nullptr;
        opp_pooledstring statisticName = nullptr;
        opp_pooledstring recordingMode = nullptr;
        opp_pooledstring demuxLabel = nullptr;
        cProperty *attrsProperty = nullptr;  // property to take result attributes from (normally @statistic[statisticName])
        opp_string_map *manualAttrs = nullptr; // if non-null, overrides attrsProperty
        bool finishCalled = false; // to prevent double-recording of scalar results based on multiple signals
 
    protected:
        virtual opp_string_map getStatisticAttributes(); // order: manualAttrs, then attrsProperty
        virtual opp_string_map getStatisticAttributesFrom(cProperty *property);
        virtual void tweakTitle(opp_string& title);
        virtual void callFinish(cResultFilter *prev) override;
 
    public:
        cResultRecorder() {}
        virtual ~cResultRecorder() {delete manualAttrs;}
        virtual void init(Context *ctx);
        [[deprecated]] virtual void init(cComponent *component, const char *statisticName, const char *recordingMode, cProperty *attrsProperty, opp_string_map *manualAttrs=nullptr) {} // deprecated, left for backward compatibility
        virtual cResultRecorder *clone() const override;
        virtual const char *getName() const override {return getStatisticName();}
        virtual std::string getFullPath() const override {return getComponent()->getFullPath() + "." + getResultName();}
        virtual cComponent *getComponent() const {return component;}
        virtual const char *getStatisticName() const {return statisticName.c_str();}
        virtual const char *getRecordingMode() const {return recordingMode.c_str();}
        virtual const char *getDemuxLabel() const {return demuxLabel.c_str();}
        virtual void setDemuxLabel(const char *s) {demuxLabel = s;}
        virtual std::string getResultName() const;
};
 
class SIM_API cNumericResultRecorder : public cResultRecorder
{
    protected:
        // all receiveSignal() methods either throw error or delegate here.
        virtual void collect(simtime_t_cref t, double value, cObject *details) = 0;
    protected:
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, bool b, cObject *details) override;
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, intval_t l, cObject *details) override;
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, uintval_t l, cObject *details) override;
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, double d, cObject *details) override;
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, const SimTime& v, cObject *details) override;
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, const char *s, cObject *details) override;
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, cObject *obj, cObject *details) override;
};
 
class SIM_API cResultRecorderType : public cNoncopyableOwnedObject
{
  private:
    std::string description;
    std::string className;
 
  public:
    cResultRecorderType(const char *name, const char *className, const char *description=nullptr);
 
    cResultRecorder *create() const;
 
    const char *getDescription() const {return description.c_str();}
 
    static cResultRecorderType *find(const char *name);
 
    static cResultRecorderType *get(const char *name);
};
 
}  // namespace omnetpp
 
#endif