ns3::RealisticBeamformingHelper Class Reference

Inheritance diagram for ns3::RealisticBeamformingHelper:

Collaboration diagram for ns3::RealisticBeamformingHelper:

Public Member Functions
void	AddBeamformingTask (const Ptr< NrGnbNetDevice > &gNbDev, const Ptr< NrUeNetDevice > &ueDev) override
	Adds the beamforming task to the list of tasks \gnbDev gNbDev pointer to gNB device \ueDev ueDev pointer to UE device.
void	SaveSrsSinrReport (uint16_t cellId, uint16_t rnti, double srsSinr)
	Function that forwards the SRS SINR to the correct RealisticBeamformingAlgorithm.
void	SetBeamformingMethod (const TypeId &beamformingMethod) override
	SetBeamformingMethod.
void	TriggerBeamformingAlgorithm (uint16_t cellId, uint16_t rnti, double srsSinr)
	When the condition for triggering a beamforming update is fulfilled this function will be triggered.
Public Member Functions inherited from ns3::BeamformingHelperBase
	BeamformingHelperBase ()
	BeamformingHelperBase constructor.
	~BeamformingHelperBase () override
	~BeamformingHelperBase destructor
void	SetBeamformingAlgorithmAttribute (const std::string &n, const AttributeValue &v)
	Set an attribute for the beafmorming algorithm that will be created.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the Type ID.
Static Public Member Functions inherited from ns3::BeamformingHelperBase
static TypeId	GetTypeId ()
	Get the Type ID.

Additional Inherited Members
Protected Types inherited from ns3::BeamformingHelperBase
typedef std::pair< Ptr< NrSpectrumPhy >, Ptr< NrSpectrumPhy > >	SpectrumPhyPair
Protected Member Functions inherited from ns3::BeamformingHelperBase
virtual void	RunTask (const Ptr< NrSpectrumPhy > &gnbSpectrumPhy, const Ptr< NrSpectrumPhy > &ueSpectrumPhy) const
	This function runs the beamforming algorithm among the provided gNB and UE device, and for a specified bwp index.
Protected Attributes inherited from ns3::BeamformingHelperBase
ObjectFactory	m_algorithmFactory
	Object factory that will be used to create beamforming algorithms.

Detailed Description

Definition at line 58 of file realistic-beamforming-helper.h.

Member Function Documentation

AddBeamformingTask()

void ns3::RealisticBeamformingHelper::AddBeamformingTask ( const Ptr< NrGnbNetDevice > &  gNbDev, const Ptr< NrUeNetDevice > &  ueDev  )

overridevirtual

Adds the beamforming task to the list of tasks \gnbDev gNbDev pointer to gNB device \ueDev ueDev pointer to UE device.

Implements ns3::BeamformingHelperBase.

Definition at line 42 of file realistic-beamforming-helper.cc.

References ns3::BeamformingHelperBase::m_algorithmFactory, ns3::RealisticBeamformingAlgorithm::NotifySrsSinrReport(), ns3::RealisticBeamformingAlgorithm::NotifySrsSnrReport(), and ns3::BeamformingHelperBase::RunTask().

Here is the call graph for this function:

GetTypeId()

TypeId ns3::RealisticBeamformingHelper::GetTypeId ( )

static

Get the Type ID.

Returns

the TypeId of the instance

Definition at line 23 of file realistic-beamforming-helper.cc.

SaveSrsSinrReport()

void ns3::RealisticBeamformingHelper::SaveSrsSinrReport	(	uint16_t	cellId,
		uint16_t	rnti,
		double	srsSinr
	)

Function that forwards the SRS SINR to the correct RealisticBeamformingAlgorithm.

Parameters

srsSinr
rnti

SetBeamformingMethod()

void ns3::RealisticBeamformingHelper::SetBeamformingMethod ( const TypeId &  beamformingMethod )

overridevirtual

SetBeamformingMethod.

Parameters

beamformingMethod

Implements ns3::BeamformingHelperBase.

Definition at line 88 of file realistic-beamforming-helper.cc.

References ns3::RealisticBeamformingAlgorithm::GetTypeId(), and ns3::BeamformingHelperBase::m_algorithmFactory.

Here is the call graph for this function:

TriggerBeamformingAlgorithm()

void ns3::RealisticBeamformingHelper::TriggerBeamformingAlgorithm	(	uint16_t	cellId,
		uint16_t	rnti,
		double	srsSinr
	)

When the condition for triggering a beamforming update is fulfilled this function will be triggered.

Parameters

cellId	id that uniquely identifies the gNB phy
rnti	id that uniquely identifies the user of gNb
srsSinr	value of srsSinr to be passed to RealisticBeamformingAlgorithm

---

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

• realistic-beamforming-helper.h
• realistic-beamforming-helper.cc