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;
 
  public:
    enum Mode {
        SINGLE,
 
        MULTI,
 
        UNCHECKED
    };
 
  private:
    enum {
      FL_ISDISABLED =       1 << 10,
      FL_DELAY_NONZERO =    1 << 11,
      FL_DATARATE_PRESENT = 1 << 12,
      FL_BER_NONZERO =      1 << 13,
      FL_PER_NONZERO =      1 << 14,
    };
 
    // cached values of parameters (note: parameters are non-volatile)
    simtime_t delay = 0; // propagation delay
    double datarate = 0; // data rate
    double ber = 0;      // bit error rate
    double per = 0;      // packet error rate
 
    Mode mode = SINGLE;
 
    // data of the last/ongoing transmission (only for mode=SINGLE)
    struct Tx {
        simtime_t startTime;
        simtime_t finishTime;
        txid_t transmissionId = -1;
    };
    Tx singleTx; // for SINGLE
    std::vector<Tx> txList; // for MULTI
    simtime_t channelFinishTime; // for both SINGLE and MULTI
 
  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: helper to processMessage()
    virtual void processPacket(cPacket *pkt, const SendOptions& options, simtime_t t, Result& inoutResult);
 
    // 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 setMode(Mode mode);
 
    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 Mode getMode() const {return mode;}
 
    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 override  {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;
 
    virtual bool isBusy() const override;
 
    [[deprecated]] virtual void forceTransmissionFinishTime(simtime_t t) override;
 
    virtual void initialize() override;
 
    virtual Result processMessage(cMessage *msg, const SendOptions& options, simtime_t t) override;
};
 
}  // namespace omnetpp
 
#endif