rem-beam-example.cc

Go to the documentation of this file.

// Copyright (c) 2020 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#include "ns3/antenna-module.h"
#include "ns3/config-store.h"
#include "ns3/core-module.h"
#include "ns3/internet-module.h"
#include "ns3/log.h"
#include "ns3/mobility-module.h"
#include "ns3/network-module.h"
#include "ns3/nr-helper.h"
#include "ns3/nr-module.h"
 
using namespace ns3;
 
int
main(int argc, char* argv[])
{
    // gnb antenna parameters
    uint32_t numRowsGnb = 1;
    uint32_t numColumnsGnb = 1;
    uint16_t sector = 0;
    double theta = 60;
    double simTime = 1;
 
    // Rem parameters
    double xMin = -1000.0;
    double xMax = 1000.0;
    uint16_t xRes = 100;
    double yMin = -1000.0;
    double yMax = 1000.0;
    uint16_t yRes = 100;
    std::string simTag = "";
 
    CommandLine cmd(__FILE__);
    cmd.AddValue("simTag", "The simTag to be used for REM files creation", simTag);
    cmd.AddValue("numRowsGnb", "Number of rows for the gNB antenna", numRowsGnb);
    cmd.AddValue("numColumnsGnb", "Number of columns for the gNB antenna", numColumnsGnb);
    cmd.AddValue("sector", "sector to be configured for", sector);
    cmd.AddValue("theta", "thea angle to be configured", theta);
    cmd.AddValue("xMin", "The min x coordinate of the rem map", xMin);
    cmd.AddValue("xMax", "The max x coordinate of the rem map", xMax);
    cmd.AddValue("xRes", "The resolution on the x axis of the rem map", xRes);
    cmd.AddValue("yMin", "The min y coordinate of the rem map", yMin);
    cmd.AddValue("yMax", "The max y coordinate of the rem map", yMax);
    cmd.AddValue("yRes", "The resolution on the y axis of the rem map", yRes);
 
    cmd.Parse(argc, argv);
 
    // create gNB and UE
    NodeContainer gnbNodes;
    NodeContainer ueNodes;
    gnbNodes.Create(1);
    ueNodes.Create(1);
 
    // install mobility and initialize positions
    MobilityHelper mobility;
    mobility.SetMobilityModel("ns3::ConstantPositionMobilityModel");
    mobility.Install(gnbNodes);
    gnbNodes.Get(0)->GetObject<MobilityModel>()->SetPosition(Vector(0, 0, 10));
    mobility.Install(ueNodes);
    ueNodes.Get(0)->GetObject<MobilityModel>()->SetPosition(Vector(10, 10, 1.5));
 
    // Create and configure helpers
    Ptr<NrPointToPointEpcHelper> nrEpcHelper = CreateObject<NrPointToPointEpcHelper>();
    Ptr<IdealBeamformingHelper> idealBeamformingHelper = CreateObject<IdealBeamformingHelper>();
    idealBeamformingHelper->SetAttribute("BeamformingMethod",
                                         TypeIdValue(DirectPathQuasiOmniBeamforming::GetTypeId()));
    Ptr<NrHelper> nrHelper = CreateObject<NrHelper>();
 
    nrHelper->SetBeamformingHelper(idealBeamformingHelper);
    nrHelper->SetEpcHelper(nrEpcHelper);
 
    /*
     *  Create spectrum configuration: a single operational band with 1 CC and 1 BWP.
     *
     * |---------------Band---------------|
     * |---------------CC-----------------|
     * |---------------BWP----------------|
     */
    BandwidthPartInfoPtrVector singleBwp;
    CcBwpCreator ccBwpCreator;
    const uint8_t numCcPerBand = 1;
 
    CcBwpCreator::SimpleOperationBandConf bandConf(2e9, 20e6, numCcPerBand);
    OperationBandInfo band = ccBwpCreator.CreateOperationBandContiguousCc(bandConf);
    Ptr<NrChannelHelper> channelHelper = CreateObject<NrChannelHelper>();
    // Use the default spectrum channel: RMa - Default - ThreeGpp
    channelHelper->ConfigureFactories();
    // Set attributes to the spectrum channel and set it to the band.
    channelHelper->SetChannelConditionModelAttribute("UpdatePeriod", TimeValue(MilliSeconds(0)));
    channelHelper->SetPathlossAttribute("ShadowingEnabled", BooleanValue(false));
    channelHelper->AssignChannelsToBands({band});
    singleBwp = CcBwpCreator::GetAllBwps({band});
 
    // Antennas for the UEs
    nrHelper->SetUeAntennaAttribute("NumRows", UintegerValue(1));
    nrHelper->SetUeAntennaAttribute("NumColumns", UintegerValue(1));
    nrHelper->SetUeAntennaAttribute("AntennaElement",
                                    PointerValue(CreateObject<IsotropicAntennaModel>()));
 
    // Configuration of phy and antenna for the gNbs
    nrHelper->SetGnbPhyAttribute("TxPower", DoubleValue(10));
    nrHelper->SetGnbPhyAttribute("Numerology", UintegerValue(0));
    nrHelper->SetGnbAntennaAttribute("NumRows", UintegerValue(numRowsGnb));
    nrHelper->SetGnbAntennaAttribute("NumColumns", UintegerValue(numColumnsGnb));
    nrHelper->SetGnbAntennaAttribute("AntennaElement",
                                     PointerValue(CreateObject<ThreeGppAntennaModel>()));
 
    // install nr net devices
    NetDeviceContainer gnbNetDev = nrHelper->InstallGnbDevice(gnbNodes, singleBwp);
    NetDeviceContainer ueNetDev = nrHelper->InstallUeDevice(ueNodes, singleBwp);
 
    int64_t randomStream = 1;
    randomStream += nrHelper->AssignStreams(gnbNetDev, randomStream);
    randomStream += nrHelper->AssignStreams(ueNetDev, randomStream);
 
    // install the IP stack on the UEs, this is needed to allow attachment
    InternetStackHelper internet;
    internet.Install(ueNodes);
    nrEpcHelper->AssignUeIpv4Address(NetDeviceContainer(ueNetDev));
 
    // we need to attach UEs to gNB so that they obtain the same configuration of channel as gNB
    nrHelper->AttachToGnb(ueNetDev.Get(0), gnbNetDev.Get(0));
 
    // configure REM parameters
    Ptr<NrRadioEnvironmentMapHelper> remHelper = CreateObject<NrRadioEnvironmentMapHelper>();
    remHelper->SetMinX(xMin);
    remHelper->SetMaxX(xMax);
    remHelper->SetResX(xRes);
    remHelper->SetMinY(yMin);
    remHelper->SetMaxY(yMax);
    remHelper->SetResY(yRes);
    remHelper->SetSimTag(simTag);
    remHelper->SetRemMode(NrRadioEnvironmentMapHelper::BEAM_SHAPE);
 
    // configure beam that will be shown in REM map
    DynamicCast<NrGnbNetDevice>(gnbNetDev.Get(0))
        ->GetPhy(0)
        ->GetSpectrumPhy()
        ->GetBeamManager()
        ->SetSector(sector, theta);
    DynamicCast<NrUeNetDevice>(ueNetDev.Get(0))
        ->GetPhy(0)
        ->GetSpectrumPhy()
        ->GetBeamManager()
        ->ChangeToQuasiOmniBeamformingVector();
    remHelper->CreateRem(gnbNetDev, ueNetDev.Get(0), 0);
 
    Simulator::Stop(Seconds(simTime));
    Simulator::Run();
    Simulator::Destroy();
    return 0;
}