5G-LENA  nr-v3.0-29-g83cc959
The 5G/NR module for the ns-3 simulator
ns3::RealisticBeamformingAlgorithm Class Reference

Generate "Real" beamforming vectors This class is inherited by all algorithms that do not assume the perfect knowledge of the channel, but instead are performing the estimation of the channel based on measurements, e.g., based on SRS SINR/SNR measurement. More...

#include "realistic-beamforming-algorithm.h"

+ Inheritance diagram for ns3::RealisticBeamformingAlgorithm:
+ Collaboration diagram for ns3::RealisticBeamformingAlgorithm:

Classes

struct  DelayedUpdateInfo
 
struct  TriggerEventConf
 

Public Types

typedef Callback< void, const Ptr< NrSpectrumPhy > &, const Ptr< NrSpectrumPhy > & > RealisticBfHelperCallback
 RunTask callback will be triggered when the event for updating the beamforming vectors occurs The parameters are: gnb spectrum phy, ue spectrum phy.
 

Public Member Functions

 RealisticBeamformingAlgorithm ()
 constructor
 
 ~RealisticBeamformingAlgorithm () override
 destructor
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned. More...
 
virtual BeamformingVectorPair GetBeamformingVectors ()
 Function that generates the beamforming vectors for a pair of communicating devices by using the direct-path beamforming vector for gNB and quasi-omni beamforming vector for UEs. More...
 
double GetBeamSearchAngleStep () const
 
void Install (const Ptr< NrSpectrumPhy > &gnbSpectrumPhy, const Ptr< NrSpectrumPhy > &ueSpectrumPhy, const Ptr< NrMacScheduler > &scheduler)
 
void NotifySrsReport (uint16_t cellId, uint16_t rnti, double srsReport)
 Saves SRS report (SNR or SINR depending on the configuration) More...
 
void NotifySrsSinrReport (uint16_t cellId, uint16_t rnti, double srsSinr)
 Saves SRS SINR report. More...
 
void NotifySrsSnrReport (uint16_t cellId, uint16_t rnti, double srsSnr)
 Saves SRS SNR report. More...
 
void SetBeamSearchAngleStep (double beamSearchAngleStep)
 Sets the value of BeamSearchAngleStep attribute. More...
 
void SetUseSnrSrs (bool v)
 
bool UseSnrSrs () const
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type id. More...
 

Detailed Description

Generate "Real" beamforming vectors This class is inherited by all algorithms that do not assume the perfect knowledge of the channel, but instead are performing the estimation of the channel based on measurements, e.g., based on SRS SINR/SNR measurement.

RealisticBeamformingAlgorithm purpose is to generate beams for the pair of communicating devices based on the SRS measurements. Differently from IdealBeamformingAlgorithm this type of algorithm does not assume a perfect knowledge of the channel. It instead estimates the long-term fast fading channel component based on the received SRS. Accordingly, this approach could be used with any beamforming algorithm that makes use of the channel estimation, e.g., beam search method (e.g., such as the one implemented in CellScanBeamforming class). Note that the LOS type of method (e.g., such as the one implemented in DirectPathBeamforming class) does not use the channel matrix, but instead the angles of arrival and departure of the LOS path, and so, the proposed method is not valid for it. Currently, it is only compatible with the beam search method."

Definition at line 50 of file realistic-beamforming-algorithm.h.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::RealisticBeamformingAlgorithm::AssignStreams ( int64_t  stream)

Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.

Parameters
streamthe first stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 46 of file realistic-beamforming-algorithm.cc.

◆ GetBeamformingVectors()

BeamformingVectorPair ns3::RealisticBeamformingAlgorithm::GetBeamformingVectors ( )
virtual

Function that generates the beamforming vectors for a pair of communicating devices by using the direct-path beamforming vector for gNB and quasi-omni beamforming vector for UEs.

Returns
the gNB and UE beamforming vectors

Definition at line 273 of file realistic-beamforming-algorithm.cc.

References ns3::RealisticBeamformingAlgorithm::DelayedUpdateInfo::channelMatrix, ns3::RealisticBeamformingAlgorithm::DelayedUpdateInfo::srsSinr, and ns3::RealisticBeamformingAlgorithm::DelayedUpdateInfo::updateTime.

◆ GetBeamSearchAngleStep()

double ns3::RealisticBeamformingAlgorithm::GetBeamSearchAngleStep ( ) const
Returns
Gets value of BeamSearchAngleStep attribute

Definition at line 115 of file realistic-beamforming-algorithm.cc.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::RealisticBeamformingAlgorithm::GetTypeId ( )
static

Get the type id.

Returns
the type id of the class

Definition at line 58 of file realistic-beamforming-algorithm.cc.

References GetBeamSearchAngleStep(), and SetBeamSearchAngleStep().

Referenced by ns3::RealisticBeamformingHelper::SetBeamformingMethod(), and ns3::LenaV2Utils::SetLenaV2SimulatorParameters().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ NotifySrsReport()

void ns3::RealisticBeamformingAlgorithm::NotifySrsReport ( uint16_t  cellId,
uint16_t  rnti,
double  srsReport 
)

Saves SRS report (SNR or SINR depending on the configuration)

Parameters
cellIdthe cell ID
rntithe RNTI
srsReportthe SRS report which can be SNR or SIN depending on the configuration

Definition at line 153 of file realistic-beamforming-algorithm.cc.

References ns3::RealisticBeamformingAlgorithm::DelayedUpdateInfo::channelMatrix, ns3::RealisticBeamformingAlgorithm::DelayedUpdateInfo::srsSinr, and ns3::RealisticBeamformingAlgorithm::DelayedUpdateInfo::updateTime.

Referenced by NotifySrsSinrReport(), and NotifySrsSnrReport().

+ Here is the caller graph for this function:

◆ NotifySrsSinrReport()

void ns3::RealisticBeamformingAlgorithm::NotifySrsSinrReport ( uint16_t  cellId,
uint16_t  rnti,
double  srsSinr 
)

Saves SRS SINR report.

Parameters
cellIdthe cell ID
rntithe RNTI of the UE
srsSinrthe SINR report for the received SRS

Definition at line 133 of file realistic-beamforming-algorithm.cc.

References NotifySrsReport().

Referenced by ns3::RealisticBeamformingHelper::AddBeamformingTask().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ NotifySrsSnrReport()

void ns3::RealisticBeamformingAlgorithm::NotifySrsSnrReport ( uint16_t  cellId,
uint16_t  rnti,
double  srsSnr 
)

Saves SRS SNR report.

Parameters
cellIdthe cell ID
rntithe RNTI
srsSnrthe SRS SNR report

Definition at line 143 of file realistic-beamforming-algorithm.cc.

References NotifySrsReport().

Referenced by ns3::RealisticBeamformingHelper::AddBeamformingTask().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetBeamSearchAngleStep()

void ns3::RealisticBeamformingAlgorithm::SetBeamSearchAngleStep ( double  beamSearchAngleStep)

Sets the value of BeamSearchAngleStep attribute.

Parameters
beamSearchAngleStepthe beam search angle step value

Definition at line 109 of file realistic-beamforming-algorithm.cc.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

The documentation for this class was generated from the following files: