clistener.h

//==========================================================================
//  CLISTENER.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_CLISTENER_H
#define __OMNETPP_CLISTENER_H

#include "simtime_t.h"
#include "cobject.h"

namespace omnetpp {

class cComponent;

typedef int simsignal_t;

#define SIMSIGNAL_NULL   ((omnetpp::simsignal_t)-1)

enum SimsignalType
{
    SIMSIGNAL_UNDEF,
    SIMSIGNAL_BOOL,
    SIMSIGNAL_LONG,
    SIMSIGNAL_ULONG,
    SIMSIGNAL_DOUBLE,
    SIMSIGNAL_SIMTIME,
    SIMSIGNAL_STRING,
    SIMSIGNAL_OBJECT
};

class SIM_API cIListener
{
    friend class cComponent; // for subscribecount
    friend class cResultFilter; // for subscribecount
  private:
    int subscribeCount;
  public:
    cIListener();
    virtual ~cIListener();

    virtual void receiveSignal(cComponent *source, simsignal_t signalID, bool b, cObject *details) = 0;

    virtual void receiveSignal(cComponent *source, simsignal_t signalID, long l, cObject *details) = 0;

    virtual void receiveSignal(cComponent *source, simsignal_t signalID, unsigned long l, cObject *details) = 0;

    virtual void receiveSignal(cComponent *source, simsignal_t signalID, double d, cObject *details) = 0;

    virtual void receiveSignal(cComponent *source, simsignal_t signalID, const SimTime& t, cObject *details) = 0;

    virtual void receiveSignal(cComponent *source, simsignal_t signalID, const char *s, cObject *details) = 0;

    virtual void receiveSignal(cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) = 0;

    virtual void finish(cComponent *component, simsignal_t signalID) {}

    virtual void subscribedTo(cComponent *component, simsignal_t signalID) {}

    virtual void unsubscribedFrom(cComponent *component, simsignal_t signalID) {}

    int getSubscribeCount() const  { return subscribeCount; }
};

class SIM_API cListener : public cIListener
{
  protected:
    virtual void unsupportedType(simsignal_t signalID, const char *dataType);

#ifdef WITH_OMNETPP4x_LISTENER_SUPPORT
    virtual void receiveSignal(cComponent *source, simsignal_t signalID, bool b);
    virtual void receiveSignal(cComponent *source, simsignal_t signalID, long l);
    virtual void receiveSignal(cComponent *source, simsignal_t signalID, unsigned long l);
    virtual void receiveSignal(cComponent *source, simsignal_t signalID, double d);
    virtual void receiveSignal(cComponent *source, simsignal_t signalID, const SimTime& t);
    virtual void receiveSignal(cComponent *source, simsignal_t signalID, const char *s);
    virtual void receiveSignal(cComponent *source, simsignal_t signalID, cObject *obj);
#endif

  public:
    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& t, 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;
};

}  // namespace omnetpp

#endif