5G-LENA: ns3::RealisticBeamformingAlgorithm Class Reference

Searching...

No Matches

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

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.

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.

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)

void	NotifySrsSinrReport (uint16_t cellId, uint16_t rnti, double srsSinr)
	Saves SRS SINR report.

void	NotifySrsSnrReport (uint16_t cellId, uint16_t rnti, double srsSnr)
	Saves SRS SNR report.

void	SetBeamSearchAngleStep (double beamSearchAngleStep)
	Sets the value of BeamSearchAngleStep attribute.

void	SetUseSnrSrs (bool v)

bool	UseSnrSrs () const

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type id.

Detailed Description

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." Introspection did not find any typical Config paths. @section attr_529 Attributes <ul> <li>BeamSearchAngleStep: Angle step when searching for the best beam <ul> <li>Set with class: \ref ns3::DoubleValue</li> <li>Underlying type: double -1.79769e+308:1.79769e+308</li> <li>Initial value: 30</li> <li>Flags: construct write read </li> </ul> <li>UseSnrSrs: Denotes whether the SRS measurement will be SNR or SINR. If FalseSINR is used, if True the SNR <ul> <li>Set with class: \ref ns3::BooleanValue</li> <li>Underlying type: bool</li> <li>Initial value: true</li> <li>Flags: construct write read No TraceSources are defined for this type.
Size of this type is 232 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ RealisticBfHelperCallback

typedef Callback<void, const Ptr<NrSpectrumPhy>&, const Ptr<NrSpectrumPhy>&> ns3::RealisticBeamformingAlgorithm::RealisticBfHelperCallback

RunTask callback will be triggered when the event for updating the beamforming vectors occurs The parameters are: gnb spectrum phy, ue spectrum phy.

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

Constructor & Destructor Documentation

◆ RealisticBeamformingAlgorithm()

ns3::RealisticBeamformingAlgorithm::RealisticBeamformingAlgorithm ( )

constructor

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

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

stream the first stream index to use

Returns: the number of stream indices assigned by this model

Definition at line 44 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 278 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 120 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 63 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:

◆ Install()

void ns3::RealisticBeamformingAlgorithm::Install	(	const Ptr< NrSpectrumPhy > &	gnbSpectrumPhy,
		const Ptr< NrSpectrumPhy > &	ueSpectrumPhy,
		const Ptr< NrMacScheduler > &	scheduler
	)