nr-channel-helper.h

// Copyright (c) 2024 LASSE / Universidade Federal do Pará (UFPA)
// Copyright (c) 2024 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
// Author: João Albuquerque <joao.barbosa.albuquerque@itec.ufpa.br>
 
#ifndef NR_CHANNEL_HELPER_H
#define NR_CHANNEL_HELPER_H
 
#include "cc-bwp-helper.h"
 
#include "ns3/object-factory.h"
#include "ns3/object.h"
#include "ns3/spectrum-channel.h"
 
namespace ns3
{
 
class NrChannelHelper : public Object
{
  public:
    enum InitFlags : uint8_t
    {
        INIT_PROPAGATION = 0x01, 
        INIT_FADING = 0x02,      
    };
 
    NrChannelHelper() = default;
 
    static TypeId GetTypeId();
 
    void ConfigureFactories(std::string Scenario = "RMa",
                            std::string Condition = "Default",
                            std::string ChannelModel = "ThreeGpp");
 
    void ConfigureSpectrumFactory(TypeId specTypeId);
 
    void ConfigurePropagationFactory(TypeId pathLossTypeId);
 
    Ptr<SpectrumChannel> CreateChannel(uint8_t flags = INIT_PROPAGATION | INIT_FADING);
 
    void SetPhasedArraySpectrumPropagationLossModelAttribute(const std::string& n,
                                                             const AttributeValue& v);
 
    void SetChannelConditionModelAttribute(const std::string& n, const AttributeValue& v);
 
    void SetPathlossAttribute(const std::string& n, const AttributeValue& v);
 
    void AssignChannelsToBands(
        const std::vector<std::reference_wrapper<OperationBandInfo>>& bandInfos,
        uint8_t flags = INIT_PROPAGATION | INIT_FADING);
 
  private:
    enum class Scenario
    {
        RMa,             
        UMa,             
        InH_OfficeOpen,  
        InH_OfficeMixed, 
        V2V_Highway,     
        V2V_Urban,       
        UMi,             
        InH,             
        InF,             
        NTN_DenseUrban,  
        NTN_Urban,       
        NTN_Suburban,    
        NTN_Rural,       
        Custom           
    } m_scenario{Scenario::RMa};
 
    enum class ChannelModel
    {
        ThreeGpp, 
        TwoRay,   
        NYU,      
    } m_channelModel{ChannelModel::ThreeGpp};
 
    enum class Condition
    {
        LOS,       
        NLOS,      
        Buildings, 
        Default,   
 
    } m_condition{Condition::Default};
 
    std::string GetScenario() const;
 
    std::tuple<TypeId, TypeId, TypeId> GetBandTypeIdInfo() const;
 
    std::set<std::tuple<ChannelModel, Scenario>> m_supportedCombinations = {
        // NYU-RMA
        {ChannelModel::NYU, Scenario::RMa},
        // NYU-UMA
        {ChannelModel::NYU, Scenario::UMa},
        // NYU-UMi
        {ChannelModel::NYU, Scenario::UMi},
        // NYU-InH
        {ChannelModel::NYU, Scenario::InH},
        // NYU-InF
        {ChannelModel::NYU, Scenario::InF},
        // 3GPP-RMa
        {ChannelModel::ThreeGpp, Scenario::RMa},
        // 3GPP-UMi
        {ChannelModel::ThreeGpp, Scenario::UMi},
        // 3GPP-UMa
        {ChannelModel::ThreeGpp, Scenario::UMa},
        // 3GPP-UMi
        {ChannelModel::ThreeGpp, Scenario::UMi},
        // 3GPP-UMa
        {ChannelModel::ThreeGpp, Scenario::UMa},
        // 3GPP-InH - OfficeMixed
        {ChannelModel::ThreeGpp, Scenario::InH_OfficeMixed},
        // 3GPP-InH - OfficeOpen
        {ChannelModel::ThreeGpp, Scenario::InH_OfficeOpen},
        // 3GPP-V2V - Highway
        {ChannelModel::ThreeGpp, Scenario::V2V_Highway},
        // 3GPP-V2V - Urban
        {ChannelModel::ThreeGpp, Scenario::V2V_Urban},
        // 3GPP-NTN - DenseUrban
        {ChannelModel::ThreeGpp, Scenario::NTN_DenseUrban},
        // 3GPP-NTN - Urban
        {ChannelModel::ThreeGpp, Scenario::NTN_Urban},
        // 3GPP-NTN - Suburban
        {ChannelModel::ThreeGpp, Scenario::NTN_Suburban},
        // 3GPP-NTN - Rural
        {ChannelModel::ThreeGpp, Scenario::NTN_Rural}};
 
    TypeId GetConditionTypeId() const;
 
    TypeId GetChannelModelTypeId() const;
 
    std::pair<TypeId, TypeId> GetPropagationTypeId() const;
 
    void AddNrCsiRsFilter(Ptr<SpectrumChannel> channel);
 
    ObjectFactory m_pathLossModel;         
    ObjectFactory m_spectrumModel;         
    ObjectFactory m_channelConditionModel; 
};
} // namespace ns3
#endif /* NR_CHANNEL_HELPER_H */