cdelaychannel.h

//==========================================================================
//   CDELAYCHANNEL.H  -  header for
//                     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_CDELAYCHANNEL_H
#define __OMNETPP_CDELAYCHANNEL_H

#include "cchannel.h"
#include "csimulation.h"

namespace omnetpp {

class SIM_API cDelayChannel : public cChannel //implies noncopyable
{
  protected:
    static simsignal_t messageSentSignal;
    static simsignal_t messageDiscardedSignal;

  private:
    enum {
      FL_ISDISABLED = 1 << 9,
      FL_DELAY_NONZERO = 1 << 10,
    };

    simtime_t delay; // cached value of propagation delay parameter

  private:
    // internal: checks whether parameters have been set up
    void checkState() const  {if (!parametersFinalized()) throw cRuntimeError(this, E_PARAMSNOTREADY);}

  protected:
    // internal: update cached copies of parameters
    void rereadPars();

    virtual void handleParameterChange(const char *parname) override;

  public:
    explicit cDelayChannel(const char *name=nullptr) : cChannel(name) {}

    virtual ~cDelayChannel() {}

    static cDelayChannel *create(const char *name);

    virtual bool isTransmissionChannel() const override {return false;}

    virtual double getNominalDatarate() const override {return 0;}

    virtual simtime_t calculateDuration(cMessage *msg) const override {return 0;}

    virtual simtime_t getTransmissionFinishTime() const override {return SIMTIME_ZERO;}

    virtual bool isBusy() const override {return false;}

    virtual void forceTransmissionFinishTime(simtime_t t) override {}

    virtual void setDelay(double d);

    virtual void setDisabled(bool d);

    virtual simtime_t getDelay() const {checkState(); return delay;}

    virtual bool isDisabled() const  {checkState(); return flags & FL_ISDISABLED;}

    virtual void initialize() override;

    virtual void processMessage(cMessage *msg, simtime_t t, result_t& result) override;
};

}  // namespace omnetpp


#endif