nr-error-model.h

// Copyright (c) 2018 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef NRERRORMODEL_H
#define NRERRORMODEL_H
 
#include "nr-mimo-chunk-processor.h"
 
#include "ns3/object.h"
#include "ns3/spectrum-value.h"
 
#include <vector>
 
namespace ns3
{
 
struct NrErrorModelOutput : public SimpleRefCount<NrErrorModelOutput>
{
    NrErrorModelOutput() = delete;
 
    NrErrorModelOutput(double tbler)
        : m_tbler(tbler)
    {
    }
 
    virtual ~NrErrorModelOutput()
    {
    }
 
    double m_tbler{0.0}; 
};
 
class NrErrorModel : public Object
{
  public:
    static TypeId GetTypeId();
 
    NrErrorModel();
 
    ~NrErrorModel() override;
 
    enum Mode
    {
        DL, 
        UL  
    };
 
    typedef std::vector<Ptr<NrErrorModelOutput>> NrErrorModelHistory;
 
    virtual Ptr<NrErrorModelOutput> GetTbDecodificationStats(
        const SpectrumValue& sinr,
        const std::vector<int>& map,
        uint32_t size,
        uint8_t mcs,
        const NrErrorModelHistory& history) = 0;
 
    virtual double GetSpectralEfficiencyForCqi(uint8_t cqi) = 0;
 
    virtual double GetSpectralEfficiencyForMcs(uint8_t mcs) const = 0;
 
    virtual uint32_t GetPayloadSize(uint32_t usefulSc,
                                    uint8_t mcs,
                                    uint8_t rank,
                                    uint32_t rbNum,
                                    Mode mode) const = 0;
 
    virtual uint32_t GetMaxCbSize(uint32_t tbSize, uint8_t mcs) const = 0;
 
    virtual uint8_t GetMaxMcs() const = 0;
 
    virtual Ptr<NrErrorModelOutput> GetTbDecodificationStatsMimo(
        const std::vector<MimoSinrChunk>& mimoChunks,
        const std::vector<int>& map,
        uint32_t size,
        uint8_t mcs,
        uint8_t rank,
        const NrErrorModelHistory& history);
 
    virtual NrSinrMatrix ComputeAvgSinrMimo(const std::vector<MimoSinrChunk>& sinrChunks);
 
    std::vector<int> CreateVectorizedRbMap(std::vector<int> map, uint8_t rank);
};
 
} // namespace ns3
#endif // NRERRORMODEL_H