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 "globals.h"

namespace omnetpp {

class cResultRecorder;
class cProperty;

#define Register_ResultRecorder(NAME, CLASSNAME) \
  static omnetpp::cResultRecorder *__FILEUNIQUENAME__() {return new CLASSNAME;} \
  EXECUTE_ON_STARTUP(omnetpp::resultRecorders.getInstance()->add(new omnetpp::cResultRecorderType(NAME,__FILEUNIQUENAME__));)

#define Register_ResultRecorder2(NAME, CLASSNAME, DESCRIPTION) \
  static omnetpp::cResultRecorder *__FILEUNIQUENAME__() {return new CLASSNAME;} \
  EXECUTE_ON_STARTUP(omnetpp::resultRecorders.getInstance()->add(new omnetpp::cResultRecorderType(NAME,__FILEUNIQUENAME__,DESCRIPTION));)


class SIM_API cResultRecorder : public cResultListener
{
    private:
        cComponent *component;
        const char *statisticName;
        const char *recordingMode;
        cProperty *attrsProperty;  // property to take result attributes from (normally @statistic[statisticName])
        opp_string_map *manualAttrs; // if non-null, overrides attrsProperty
        bool finishCalled; // 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:
        virtual void init(cComponent *component, const char *statisticName, const char *recordingMode, cProperty *attrsProperty, opp_string_map *manualAttrs=nullptr);
        virtual ~cResultRecorder() {delete manualAttrs;}
        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;}
        virtual const char *getRecordingMode() const {return recordingMode;}
        virtual std::string getResultName() const {return std::string(getStatisticName())+":"+getRecordingMode();}
};

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, long l, cObject *details) override;
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, unsigned long 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;
    cResultRecorder *(*factory)();

  public:
    cResultRecorderType(const char *name, cResultRecorder *(*f)(), const char *description=nullptr);

    cResultRecorder *create() const  {return factory();}

    const char *getDescription() const {return description.c_str();}

    static cResultRecorderType *find(const char *name);

    static cResultRecorderType *get(const char *name);
};

}  // namespace omnetpp

#endif