LteFeedback.h Source File¶

Simu5G: LteFeedback.h Source File
Simu5G
//
//                  Simu5G
//
// Copyright (C) 2012-2021 Giovanni Nardini, Giovanni Stea, Antonio Virdis et al. (University of Pisa)
// Copyright (C) 2022-2026 Giovanni Nardini, Giovanni Stea et al. (University of Pisa)
//
// This file is part of a software released under the license included in file
// "license.pdf". Please read LICENSE and README files before using it.
// The above files and the present reference are part of the software itself,
// and cannot be removed from it.
//
 
#ifndef _LTE_LTEFEEDBACK_H_
#define _LTE_LTEFEEDBACK_H_
 
#include <map>
#include <vector>
 
#include "simu5g/common/LteCommon.h"
#include "simu5g/stack/mac/amc/UserTxParams.h"
#include "simu5g/stack/phy/feedback/LteSummaryFeedback.h"
 
namespace simu5g {
 
class LteFeedback;
typedef std::vector<LteFeedback> LteFeedbackVector;
typedef std::vector<LteFeedbackVector> LteFeedbackDoubleVector;
class LteFeedback
{
  protected:
    enum
    {
        EMPTY           = 0x0000,
        RANK_INDICATION = 0x0001,
        WB_CQI          = 0x0002,
        WB_PMI          = 0x0004, // unused, PMI not modeled
        BAND_CQI        = 0x0008,
        BAND_PMI        = 0x0010, // unused, PMI not modeled
        PREFERRED_CQI   = 0x0020,
        PREFERRED_PMI   = 0x0040  // unused, PMI not modeled
    };
    Rank rank_;
    CqiVector wideBandCqi_;
    std::vector<CqiVector> perBandCqi_;
    CqiVector preferredCqi_;
    BandSet preferredBands_;
    unsigned int status_ = EMPTY;
    TxMode txMode_ = UNKNOWN_TX_MODE;
    bool periodicFeedback_ = true;
    Remote remoteAntennaId_ = MACRO;
 
  public:
    void reset();
    bool isEmptyFeedback() const
    {
        return txMode_ == UNKNOWN_TX_MODE || status_ == EMPTY;
    }
    bool isPeriodicFeedback() const
    {
        return periodicFeedback_;
    }
    bool hasRankIndicator() const
    {
        return status_ & RANK_INDICATION;
    }
 
    bool hasWbCqi() const
    {
        return status_ & WB_CQI;
    }
 
    bool hasBandCqi() const
    {
        return status_ & BAND_CQI;
    }
 
    bool hasPreferredCqi() const
    {
        return status_ & PREFERRED_CQI;
    }
 
    // **************** GETTERS ****************
    Rank getRankIndicator() const
    {
        return rank_;
    }
    CqiVector getWbCqi() const
    {
        return wideBandCqi_;
    }
    Cqi getWbCqi(Codeword cw) const
    {
        return wideBandCqi_[cw];
    }
 
    std::vector<CqiVector> getBandCqi() const
    {
        return perBandCqi_;
    }
    CqiVector getBandCqi(Codeword cw) const
    {
        return perBandCqi_[cw];
    }
 
    CqiVector getPreferredCqi() const
    {
        return preferredCqi_;
    }
    Cqi getPreferredCqi(Codeword cw) const
    {
        return preferredCqi_[cw];
    }
 
    BandSet getPreferredBands() const
    {
        return preferredBands_;
    }
    TxMode getTxMode() const
    {
        return txMode_;
    }
    Remote getAntennaId() const
    {
        return remoteAntennaId_;
    }
 
    // *****************************************
 
    // **************** SETTERS ****************
    void setRankIndicator(const Rank rank)
    {
        rank_ = rank;
        status_ |= RANK_INDICATION;
    }
    void setWideBandCqi(const CqiVector wbCqi)
    {
        wideBandCqi_ = wbCqi;
        status_ |= WB_CQI;
    }
    void setWideBandCqi(const Cqi cqi, const Codeword cw)
    {
        if (wideBandCqi_.size() == cw)
            wideBandCqi_.push_back(cqi);
        else
            wideBandCqi_[cw] = cqi;
 
        status_ |= WB_CQI;
    }
 
    void setPerBandCqi(const std::vector<CqiVector> bandCqi)
    {
        perBandCqi_ = bandCqi;
        status_ |= BAND_CQI;
    }
    void setPerBandCqi(const CqiVector bandCqi, const Codeword cw)
    {
        if (perBandCqi_.size() == cw)
            perBandCqi_.push_back(bandCqi);
        else
            perBandCqi_[cw] = bandCqi;
 
        status_ |= BAND_CQI;
    }
 
    void setPreferredCqi(const CqiVector preferredCqi)
    {
        preferredCqi_ = preferredCqi;
        status_ |= PREFERRED_CQI;
    }
    void setPreferredCqi(const Cqi preferredCqi, const Codeword cw)
    {
        if (preferredCqi_.size() == cw)
            preferredCqi_.push_back(preferredCqi);
        else
            preferredCqi_[cw] = preferredCqi;
 
        status_ |= PREFERRED_CQI;
    }
 
    void setPreferredBands(const BandSet preferredBands)
    {
        preferredBands_ = preferredBands;
    }
    void setTxMode(const TxMode txMode)
    {
        txMode_ = txMode;
    }
    void setAntenna(const Remote antenna)
    {
        remoteAntennaId_ = antenna;
    }
    void setPeriodicity(const bool type)
    {
        periodicFeedback_ = type;
    }
 
    // *****************************************
    void print(MacCellId cellId, MacNodeId nodeId, Direction dir, const char *s) const;
};
 
} //namespace
 
#endif