cresultfilter.h

//==========================================================================
//  CRESULTFILTER.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//  Author: Andras Varga
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 1992-2008 Andras Varga
  Copyright (C) 2006-2008 OpenSim Ltd.

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/

#ifndef __CRESULTFILTER_H
#define __CRESULTFILTER_H

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

NAMESPACE_BEGIN

class cResultFilter;

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


class SIM_API cResultFilter : public cResultListener
{
    private:
        cResultListener **delegates; // NULL-terminated array
    protected:
        // methods for invoking the delegates
        void fire(cResultFilter *prev, simtime_t_cref t, bool b);
        void fire(cResultFilter *prev, simtime_t_cref t, long l);
        void fire(cResultFilter *prev, simtime_t_cref t, unsigned long l);
        void fire(cResultFilter *prev, simtime_t_cref t, double d);
        void fire(cResultFilter *prev, simtime_t_cref t, const SimTime& v);
        void fire(cResultFilter *prev, simtime_t_cref t, const char *s);
        void fire(cResultFilter *prev, simtime_t_cref t, cObject *obj);
    public:
        cResultFilter();
        ~cResultFilter();
        virtual void addDelegate(cResultListener *delegate);
        virtual int getNumDelegates() const;
        std::vector<cResultListener*> getDelegates() const;
        virtual void finish(cResultFilter *prev);
};

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) = 0;
    public:
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, bool b);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, long l);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, unsigned long l);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, double d);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, const SimTime& v);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, const char *s);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, cObject *obj);
};

class SIM_API cObjectResultFilter : public cResultFilter
{
    public:
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, bool b);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, long l);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, unsigned long l);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, double d);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, const SimTime& v);
        virtual void receiveSignal(cResultFilter *prev, simtime_t_cref t, const char *s);
};

class SIM_API cResultFilterDescriptor : public cNoncopyableOwnedObject
{
  private:
    cResultFilter *(*creatorfunc)();

  public:
    cResultFilterDescriptor(const char *name, cResultFilter *(*f)());

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

    static cResultFilterDescriptor *find(const char *name);

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

NAMESPACE_END

#endif