5G-LENA nr-v3.1-69-g2dd513a7
The 5G/NR module for the ns-3 simulator
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ns3::IdealBeamformingHelper Class Reference
Helpers

The IdealBeamformingHelper class. More...

#include "ideal-beamforming-helper.h"

+ Inheritance diagram for ns3::IdealBeamformingHelper:
+ Collaboration diagram for ns3::IdealBeamformingHelper:

Public Member Functions

 IdealBeamformingHelper ()
 IdealBeamformingHelper.
 
 ~IdealBeamformingHelper () override
 ~IdealBeamformingHelper
 
void AddBeamformingTask (const Ptr< NrGnbNetDevice > &gNbDev, const Ptr< NrUeNetDevice > &ueDev) override
 Specify among which devices the beamforming algorithm should be performed.
 
Time GetPeriodicity () const
 GetIdealBeamformingPeriodicity.
 
virtual void Run () const
 Run beamforming task.
 
void SetBeamformingMethod (const TypeId &beamformingMethod) override
 SetBeamformingMethod.
 
void SetPeriodicity (const Time &v)
 SetIdealBeamformingPeriodicity.
 
- 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.
 

Protected Member Functions

void DoInitialize () override
 
virtual void ExpireBeamformingTimer ()
 The beamforming timer has expired; at the next slot, perform beamforming.
 
BeamformingVectorPair GetBeamformingVectors (const Ptr< NrSpectrumPhy > &gnbSpectrumPhy, const Ptr< NrSpectrumPhy > &ueSpectrumPhy) const override
 Function that will call the configured algorithm for the specified devices and obtain the beamforming vectors for each of them.
 
- 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

Ptr< IdealBeamformingAlgorithm > m_beamformingAlgorithm
 The beamforming algorithm that will be used.
 
Time m_beamformingPeriodicity
 
EventId m_beamformingTimer
 
std::list< SpectrumPhyPair > m_spectrumPhyPair
 The list of beamforming tasks to be executed.
 
- Protected Attributes inherited from ns3::BeamformingHelperBase
ObjectFactory m_algorithmFactory
 Object factory that will be used to create beamforming algorithms.
 

Additional Inherited Members

- Protected Types inherited from ns3::BeamformingHelperBase
typedef std::pair< Ptr< NrSpectrumPhy >, Ptr< NrSpectrumPhy > > SpectrumPhyPair
 

Detailed Description

The IdealBeamformingHelper class.

Definition at line 25 of file ideal-beamforming-helper.h.

Constructor & Destructor Documentation

◆ IdealBeamformingHelper()

ns3::IdealBeamformingHelper::IdealBeamformingHelper ( )

IdealBeamformingHelper.

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

◆ ~IdealBeamformingHelper()

ns3::IdealBeamformingHelper::~IdealBeamformingHelper ( )
override

~IdealBeamformingHelper

Definition at line 28 of file ideal-beamforming-helper.cc.

References m_beamformingAlgorithm.

Member Function Documentation

◆ AddBeamformingTask()

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

Specify among which devices the beamforming algorithm should be performed.

Parameters
gNbDevgNB device
ueDevUE device

Implements ns3::BeamformingHelperBase.

Definition at line 67 of file ideal-beamforming-helper.cc.

References ns3::BeamformingHelperBase::m_algorithmFactory, m_beamformingAlgorithm, m_spectrumPhyPair, and ns3::BeamformingHelperBase::RunTask().

+ Here is the call graph for this function:

◆ DoInitialize()

void ns3::IdealBeamformingHelper::DoInitialize ( )
overrideprotected

Definition at line 35 of file ideal-beamforming-helper.cc.

◆ ExpireBeamformingTimer()

void ns3::IdealBeamformingHelper::ExpireBeamformingTimer ( )
protectedvirtual

The beamforming timer has expired; at the next slot, perform beamforming.

Definition at line 117 of file ideal-beamforming-helper.cc.

References ExpireBeamformingTimer(), m_beamformingPeriodicity, m_beamformingTimer, and Run().

Referenced by ExpireBeamformingTimer().

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

◆ GetBeamformingVectors()

BeamformingVectorPair ns3::IdealBeamformingHelper::GetBeamformingVectors ( const Ptr< NrSpectrumPhy > &  gnbSpectrumPhy,
const Ptr< NrSpectrumPhy > &  ueSpectrumPhy 
) const
overrideprotectedvirtual

Function that will call the configured algorithm for the specified devices and obtain the beamforming vectors for each of them.

Parameters
gnbSpectrumPhya pointer to SpectrumPhy of gNb device
ueSpectrumPhya pointer to SpectrumPhy of UE device
Returns
the pair of beamforming vectors, one corresponding to the gNB device, and one corresponding to the UE device

Implements ns3::BeamformingHelperBase.

Definition at line 101 of file ideal-beamforming-helper.cc.

References m_beamformingAlgorithm.

◆ GetPeriodicity()

Time ns3::IdealBeamformingHelper::GetPeriodicity ( ) const

GetIdealBeamformingPeriodicity.

Returns

Definition at line 138 of file ideal-beamforming-helper.cc.

References m_beamformingPeriodicity.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::IdealBeamformingHelper::GetTypeId ( )
static

Get the Type ID.

Returns
the TypeId of the instance

Definition at line 44 of file ideal-beamforming-helper.cc.

References GetPeriodicity(), ns3::CellScanBeamforming::GetTypeId(), SetBeamformingMethod(), and SetPeriodicity().

+ Here is the call graph for this function:

◆ Run()

void ns3::IdealBeamformingHelper::Run ( ) const
virtual

Run beamforming task.

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

References m_spectrumPhyPair, and ns3::BeamformingHelperBase::RunTask().

Referenced by ExpireBeamformingTimer().

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

◆ SetBeamformingMethod()

void ns3::IdealBeamformingHelper::SetBeamformingMethod ( const TypeId &  beamformingMethod)
overridevirtual

SetBeamformingMethod.

Parameters
beamformingMethod

Implements ns3::BeamformingHelperBase.

Definition at line 109 of file ideal-beamforming-helper.cc.

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

Referenced by GetTypeId().

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

◆ SetPeriodicity()

void ns3::IdealBeamformingHelper::SetPeriodicity ( const Time &  v)

SetIdealBeamformingPeriodicity.

Parameters
v

Definition at line 130 of file ideal-beamforming-helper.cc.

References m_beamformingPeriodicity.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_beamformingAlgorithm

Ptr<IdealBeamformingAlgorithm> ns3::IdealBeamformingHelper::m_beamformingAlgorithm
protected

The beamforming algorithm that will be used.

Definition at line 93 of file ideal-beamforming-helper.h.

Referenced by ~IdealBeamformingHelper(), AddBeamformingTask(), and GetBeamformingVectors().

◆ m_beamformingPeriodicity

Time ns3::IdealBeamformingHelper::m_beamformingPeriodicity
protected

The beamforming periodicity or how frequently beamforming tasks will be executed

Definition at line 88 of file ideal-beamforming-helper.h.

Referenced by ExpireBeamformingTimer(), GetPeriodicity(), and SetPeriodicity().

◆ m_beamformingTimer

EventId ns3::IdealBeamformingHelper::m_beamformingTimer
protected

Beamforming timer that is used to schedule periodical beamforming vector updates

Definition at line 90 of file ideal-beamforming-helper.h.

Referenced by ExpireBeamformingTimer().

◆ m_spectrumPhyPair

std::list<SpectrumPhyPair> ns3::IdealBeamformingHelper::m_spectrumPhyPair
protected

The list of beamforming tasks to be executed.

Definition at line 95 of file ideal-beamforming-helper.h.

Referenced by AddBeamformingTask(), and Run().

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