cdataratechannel.h

//==========================================================================
//   CDATARATECHANNEL.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_CDATARATECHANNEL_H
#define __OMNETPP_CDATARATECHANNEL_H

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

namespace omnetpp {


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

  private:
    enum {
      FL_ISDISABLED = 1 << 9,
      FL_DELAY_NONZERO = 1 << 10,
      FL_DATARATE_NONZERO = 1 << 11,
      FL_BER_NONZERO = 1 << 12,
      FL_PER_NONZERO = 1 << 13,
    };

    // cached values of parameters (note: parameters are non-volatile)
    simtime_t delay; // propagation delay
    double datarate; // data rate
    double ber;      // bit error rate
    double per;      // packet error rate

    // stores the end of the last transmission; used if there is a datarate
    simtime_t txFinishTime;

  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();

    // internal: react to parameter changes
    virtual void handleParameterChange(const char *parname) override;

    // internal: emits last busy signal
    virtual void finish() override;

  public:

    explicit cDatarateChannel(const char *name=nullptr);

    virtual ~cDatarateChannel();

    static cDatarateChannel *create(const char *name);

    virtual std::string str() const override;

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

    virtual void setDelay(double d);

    virtual void setDatarate(double d);

    virtual void setBitErrorRate(double d);

    virtual void setPacketErrorRate(double d);

    virtual void setDisabled(bool d);

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

    virtual double getDatarate() const  {checkState(); return datarate;}

    virtual double getBitErrorRate() const  {checkState(); return ber;}

    virtual double getPacketErrorRate() const  {checkState(); return per;}

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

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

    virtual simtime_t calculateDuration(cMessage *msg) const override;

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

    virtual bool isBusy() const override {return simTime() < txFinishTime;}

    virtual void forceTransmissionFinishTime(simtime_t t) override;

    virtual void initialize() override;

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

}  // namespace omnetpp

#endif