cresultfilter.h

//==========================================================================
//  CRESULTFILTER.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_CRESULTFILTER_H
#define __OMNETPP_CRESULTFILTER_H

#include "simkerneldefs.h"
#include "cresultlistener.h"
#include "onstartup.h"
#include "globals.h"
#include "cownedobject.h"

namespace omnetpp {

class cResultFilter;
class cProperty;

#define Register_ResultFilter(NAME, CLASSNAME) \
  static omnetpp::cResultFilter *__FILEUNIQUENAME__() {return new CLASSNAME;} \
  EXECUTE_ON_STARTUP(omnetpp::resultFilters.getInstance()->add(new omnetpp::cResultFilterType(NAME,__FILEUNIQUENAME__));)


#define Register_ResultFilter2(NAME, CLASSNAME, DESCRIPTION) \
  static omnetpp::cResultFilter *__FILEUNIQUENAME__() {return new CLASSNAME;} \
  EXECUTE_ON_STARTUP(omnetpp::resultFilters.getInstance()->add(new omnetpp::cResultFilterType(NAME,__FILEUNIQUENAME__,DESCRIPTION));)

class SIM_API cResultFilter : public cResultListener
{
    private:
        cResultListener **delegates; // nullptr-terminated array
    protected:
        // methods for invoking the delegates
        void fire(cResultFilter *prev, simtime_t_cref t, bool b, cObject *details);
        void fire(cResultFilter *prev, simtime_t_cref t, long l, cObject *details);
        void fire(cResultFilter *prev, simtime_t_cref t, unsigned long l, cObject *details);
        void fire(cResultFilter *prev, simtime_t_cref t, double d, cObject *details);
        void fire(cResultFilter *prev, simtime_t_cref t, const SimTime& v, cObject *details);
        void fire(cResultFilter *prev, simtime_t_cref t, const char *s, cObject *details);
        void fire(cResultFilter *prev, simtime_t_cref t, cObject *obj, cObject *details);
        virtual void callFinish(cResultFilter *prev) override;
        virtual void forEachChild(cVisitor *v) override;
    public:
        cResultFilter();
        ~cResultFilter();
        virtual void init(cComponent *component, cProperty *attrsProperty) {}
        virtual double getInitialDoubleValue() const {return NAN;}
        virtual void addDelegate(cResultListener *delegate);
        virtual int getNumDelegates() const;
        cResultListener *getDelegate(int k) const {return delegates[k];}  // unsafe
        std::vector<cResultListener*> getDelegates() const;

};

class SIM_API cNumericResultFilter : public cResultFilter
{
    protected:
        // all receiveSignal() methods either throw error or delegate here;
        // return value: whether to invoke chained listeners (true) or to swallow the value (false)
        virtual bool process(simtime_t& 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 cObjectResultFilter : public cResultFilter
{
    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;
};

class SIM_API cResultFilterType : public cNoncopyableOwnedObject
{
  private:
    std::string description;
    cResultFilter *(*factory)();

  public:
    cResultFilterType(const char *name, cResultFilter *(*f)(), const char *description=nullptr);

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

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

    static cResultFilterType *find(const char *name);

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

}  // namespace omnetpp

#endif