A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::LteFfrEnhancedAlgorithm Class Reference

Enhanced Fractional Frequency Reuse algorithm implementation. More...

#include "lte-ffr-enhanced-algorithm.h"

+ Inheritance diagram for ns3::LteFfrEnhancedAlgorithm:
+ Collaboration diagram for ns3::LteFfrEnhancedAlgorithm:

Public Member Functions

 LteFfrEnhancedAlgorithm ()
 Creates a trivial ffr algorithm instance.
 
 ~LteFfrEnhancedAlgorithm () override
 
LteFfrRrcSapProviderGetLteFfrRrcSapProvider () override
 Export the "provider" part of the LteFfrRrcSap interface.
 
LteFfrSapProviderGetLteFfrSapProvider () override
 Export the "provider" part of the LteFfrSap interface.
 
void SetLteFfrRrcSapUser (LteFfrRrcSapUser *s) override
 Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will interact with.
 
void SetLteFfrSapUser (LteFfrSapUser *s) override
 Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will interact with.
 
- Public Member Functions inherited from ns3::LteFfrAlgorithm
 LteFfrAlgorithm ()
 
 ~LteFfrAlgorithm () override
 
uint16_t GetDlBandwidth () const
 
uint8_t GetFrCellTypeId () const
 
uint16_t GetUlBandwidth () const
 
void SetDlBandwidth (uint16_t bw)
 
void SetFrCellTypeId (uint8_t cellTypeId)
 
void SetUlBandwidth (uint16_t bw)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::LteFfrAlgorithm
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Protected Member Functions

void DoDispose () override
 Destructor implementation.
 
std::vector< bool > DoGetAvailableDlRbg () override
 Implementation of LteFfrSapProvider::GetAvailableDlRbg.
 
std::vector< bool > DoGetAvailableUlRbg () override
 Implementation of LteFfrSapProvider::GetAvailableUlRbg.
 
uint16_t DoGetMinContinuousUlBandwidth () override
 DoGetMinContinuousUlBandwidth in number of RB.
 
uint8_t DoGetTpc (uint16_t rnti) override
 DoGetTpc for UE.
 
void DoInitialize () override
 Initialize() implementation.
 
bool DoIsDlRbgAvailableForUe (int i, uint16_t rnti) override
 Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.
 
bool DoIsUlRbgAvailableForUe (int i, uint16_t rnti) override
 Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.
 
void DoRecvLoadInformation (EpcX2Sap::LoadInformationParams params) override
 DoRecvLoadInformation.
 
void DoReportDlCqiInfo (const FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params) override
 DoReportDlCqiInfo.
 
void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults) override
 Implementation of LteFfrRrcSapProvider::ReportUeMeas.
 
void DoReportUlCqiInfo (const FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params) override
 DoReportUlCqiInfo.
 
void DoReportUlCqiInfo (std::map< uint16_t, std::vector< double > > ulCqiMap) override
 DoReportUlCqiInfo.
 
void Reconfigure () override
 Automatic FR reconfiguration.
 
- Protected Member Functions inherited from ns3::LteFfrAlgorithm
virtual void DoSetBandwidth (uint16_t ulBandwidth, uint16_t dlBandwidth)
 Implementation of LteFfrRrcSapProvider::SetBandwidth.
 
virtual void DoSetCellId (uint16_t cellId)
 SetCellId.
 
int GetRbgSize (int dlbandwidth)
 Get RBG size for DL Bandwidth according to table 7.1.6.1-1 of 36.213.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Private Types

enum  UePosition { AreaUnset , CenterArea , EdgeArea }
 UE Position enumeration. More...
 

Private Member Functions

double EstimateUlSinr (uint16_t rnti, uint16_t rb, std::map< uint16_t, std::vector< double > > ulCqiMap)
 Initialize uplink RBG maps.
 
int GetCqiFromSpectralEfficiency (double s)
 Get CQI from spectral efficiency.
 
void InitializeDownlinkRbgMaps ()
 Initialize downlink RBG maps.
 
void InitializeUplinkRbgMaps ()
 Initialize uplink RBG maps.
 
void SetDownlinkConfiguration (uint16_t cellId, uint8_t bandwidth)
 Set downlink configuration.
 
void SetUplinkConfiguration (uint16_t cellId, uint8_t bandwidth)
 Set uplink configuration.
 

Private Attributes

uint8_t m_centerAreaPowerOffset
 Center area power offset.
 
uint8_t m_centerAreaTpc
 Center area TPC.
 
std::map< uint16_t, SbMeasResult_sm_dlCqi
 Map of UE's DL CQI A30 received.
 
uint8_t m_dlCqiThreshold
 DL CQI threshold.
 
std::vector< bool > m_dlPrimarySegmentRbgMap
 DL primary segment RBG map.
 
std::map< uint16_t, std::vector< bool > > m_dlRbgAvailableforUe
 DL RBG available for UE.
 
std::vector< bool > m_dlRbgMap
 DL RBG map.
 
std::vector< bool > m_dlReuse1RbgMap
 DL reuse 1 RBG map.
 
uint8_t m_dlReuse1SubBandwidth
 DL reuse 1 subband bandwidth.
 
std::vector< bool > m_dlReuse3RbgMap
 DL reuse 3 RBG map.
 
uint8_t m_dlReuse3SubBandwidth
 DL reuse 3 subband bandwidth.
 
std::vector< bool > m_dlSecondarySegmentRbgMap
 DL secondary segment RBG map.
 
uint8_t m_dlSubBandOffset
 DL subband offset.
 
uint8_t m_edgeAreaPowerOffset
 Edge area power offset.
 
uint8_t m_edgeAreaTpc
 Edge are TPC.
 
LteFfrRrcSapProviderm_ffrRrcSapProvider
 FFR RRC SAP provider.
 
LteFfrRrcSapUserm_ffrRrcSapUser
 FFR RRC SAP user.
 
LteFfrSapProviderm_ffrSapProvider
 FFR SAP provider.
 
LteFfrSapUserm_ffrSapUser
 FFR SAP user.
 
uint8_t m_measId
 The expected measurement identity.
 
uint8_t m_rsrqThreshold
 RSRQ threshold.
 
std::map< uint16_t, uint8_t > m_ues
 UEs.
 
std::map< uint16_t, std::vector< int > > m_ulCqi
 UL CQI.
 
uint8_t m_ulCqiThreshold
 UL CQI threshold.
 
std::vector< bool > m_ulPrimarySegmentRbgMap
 UL primary segment RBG map.
 
std::map< uint16_t, std::vector< bool > > m_ulRbAvailableforUe
 UL RB available for UE.
 
std::vector< bool > m_ulRbgMap
 UL RBG Map.
 
std::vector< bool > m_ulReuse1RbgMap
 UL reuse 1 RBG map.
 
uint8_t m_ulReuse1SubBandwidth
 UL reuse 1 subbandwidth.
 
std::vector< bool > m_ulReuse3RbgMap
 UL reuse 3 RBG map.
 
uint8_t m_ulReuse3SubBandwidth
 UL reuse 3 subbandwidth.
 
std::vector< bool > m_ulSecondarySegmentRbgMap
 UL secondary segment RBG map.
 
uint8_t m_ulSubBandOffset
 UL subband offset.
 

Friends

class MemberLteFfrRrcSapProvider< LteFfrEnhancedAlgorithm >
 let the forwarder class access the protected and private members
 
class MemberLteFfrSapProvider< LteFfrEnhancedAlgorithm >
 let the forwarder class access the protected and private members
 

Additional Inherited Members

- Protected Attributes inherited from ns3::LteFfrAlgorithm
uint16_t m_cellId
 cell ID
 
uint8_t m_dlBandwidth
 downlink bandwidth in RBs
 
bool m_enabledInUplink
 If true FR algorithm will also work in Uplink.
 
uint8_t m_frCellTypeId
 FFR cell type ID for automatic configuration.
 
bool m_needReconfiguration
 If true FR algorithm will be reconfigured.
 
uint8_t m_ulBandwidth
 uplink bandwidth in RBs
 

Detailed Description

Enhanced Fractional Frequency Reuse algorithm implementation.

Config Paths

ns3::LteFfrEnhancedAlgorithm is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteFfrAlgorithm/$ns3::LteFfrEnhancedAlgorithm"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/ComponentCarrierMap/[i]/LteFfrAlgorithm/$ns3::LteFfrEnhancedAlgorithm"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteFfrAlgorithm/$ns3::LteFfrEnhancedAlgorithm"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/ComponentCarrierMap/[i]/LteFfrAlgorithm/$ns3::LteFfrEnhancedAlgorithm"

Attributes

  • CenterAreaPowerOffset: PdschConfigDedicated::Pa value for Center Sub-band, default value dB0
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 5
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • CenterAreaTpc: TPC value which will be set in DL-DCI for UEs in center areaAbsolute mode is used, default value 1 is mapped to -1 according toTS36.213 Table 5.1.1.1-2
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 1
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • DlCqiThreshold: If the DL-CQI for RBG of is higher than this threshold, transmission on RBG is possible
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 15
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • DlReuse1SubBandwidth: Downlink Reuse 1 SubBandwidth Configuration in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 4
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • DlReuse3SubBandwidth: Downlink Reuse 3 SubBandwidth Configuration in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 4
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • DlSubBandOffset: Downlink SubBand Offset for this cell in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • EdgeAreaPowerOffset: PdschConfigDedicated::Pa value for Edge Sub-band, default value dB0
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 5
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • EdgeAreaTpc: TPC value which will be set in DL-DCI for UEs in edge areaAbsolute mode is used, default value 1 is mapped to -1 according toTS36.213 Table 5.1.1.1-2
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 1
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • RsrqThreshold: If the RSRQ of is worse than this threshold, UE should be served in Edge sub-band
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 26
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • UlCqiThreshold: If the UL-CQI for RBG of is higher than this threshold, transmission on RBG is possible
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 15
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • UlReuse1SubBandwidth: Uplink Reuse 1 SubBandwidth Configuration in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 4
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • UlReuse3SubBandwidth: Uplink Reuse 3 SubBandwidth Configuration in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 4
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • UlSubBandOffset: Uplink SubBand Offset for this cell in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: constructwriteread
    • Support level: SUPPORTED

Attributes defined in parent class ns3::LteFfrAlgorithm

  • EnabledInUplink: If FR algorithm will also work in Uplink, default value true
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • FrCellTypeId: Downlink FR cell type ID for automatic configuration,default value is 0 and it means that user needs to configure FR algorithm manually,if it is set to 1,2 or 3 FR algorithm will be configured automatically
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: constructwriteread
    • Support level: SUPPORTED

No TraceSources are defined for this type.
Group: Lte

Size of this type is 768 bytes (on a 64-bit architecture).

Definition at line 30 of file lte-ffr-enhanced-algorithm.h.

Member Enumeration Documentation

◆ UePosition

UE Position enumeration.

Enumerator
AreaUnset 
CenterArea 
EdgeArea 

Definition at line 154 of file lte-ffr-enhanced-algorithm.h.

Constructor & Destructor Documentation

◆ LteFfrEnhancedAlgorithm()

ns3::LteFfrEnhancedAlgorithm::LteFfrEnhancedAlgorithm ( )

◆ ~LteFfrEnhancedAlgorithm()

ns3::LteFfrEnhancedAlgorithm::~LteFfrEnhancedAlgorithm ( )
override

Definition at line 117 of file lte-ffr-enhanced-algorithm.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::LteFfrEnhancedAlgorithm::DoDispose ( )
overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::LteFfrAlgorithm.

Definition at line 123 of file lte-ffr-enhanced-algorithm.cc.

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

◆ DoGetAvailableDlRbg()

std::vector< bool > ns3::LteFfrEnhancedAlgorithm::DoGetAvailableDlRbg ( )
overrideprotectedvirtual

Implementation of LteFfrSapProvider::GetAvailableDlRbg.

Returns
vector of size (m_dlBandwidth/RbgSize); false indicates that RBG is free to use, true otherwise

Implements ns3::LteFfrAlgorithm.

Definition at line 454 of file lte-ffr-enhanced-algorithm.cc.

References InitializeDownlinkRbgMaps(), m_dlRbgAvailableforUe, m_dlRbgMap, ns3::LteFfrAlgorithm::m_needReconfiguration, NS_LOG_FUNCTION, NS_LOG_INFO, and Reconfigure().

+ Here is the call graph for this function:

◆ DoGetAvailableUlRbg()

std::vector< bool > ns3::LteFfrEnhancedAlgorithm::DoGetAvailableUlRbg ( )
overrideprotectedvirtual

Implementation of LteFfrSapProvider::GetAvailableUlRbg.

Returns
vector of size m_ulBandwidth; false indicates that RB is free to use, true otherwise

Implements ns3::LteFfrAlgorithm.

Definition at line 549 of file lte-ffr-enhanced-algorithm.cc.

References InitializeUplinkRbgMaps(), ns3::LteFfrAlgorithm::m_enabledInUplink, m_ulRbAvailableforUe, m_ulRbgMap, NS_LOG_FUNCTION, and NS_LOG_INFO.

+ Here is the call graph for this function:

◆ DoGetMinContinuousUlBandwidth()

uint16_t ns3::LteFfrEnhancedAlgorithm::DoGetMinContinuousUlBandwidth ( )
overrideprotectedvirtual

DoGetMinContinuousUlBandwidth in number of RB.

Returns
number of RB in min continuous UL Bandwidth

Implements ns3::LteFfrAlgorithm.

Definition at line 849 of file lte-ffr-enhanced-algorithm.cc.

References ns3::LteFfrAlgorithm::m_enabledInUplink, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulReuse1SubBandwidth, m_ulReuse3SubBandwidth, NS_LOG_FUNCTION, and NS_LOG_INFO.

◆ DoGetTpc()

uint8_t ns3::LteFfrEnhancedAlgorithm::DoGetTpc ( uint16_t rnti)
overrideprotectedvirtual

DoGetTpc for UE.

Parameters
rnti
Returns
TPC value

Implements ns3::LteFfrAlgorithm.

Definition at line 810 of file lte-ffr-enhanced-algorithm.cc.

References EdgeArea, m_centerAreaTpc, m_edgeAreaTpc, ns3::LteFfrAlgorithm::m_enabledInUplink, m_ues, and NS_LOG_FUNCTION.

◆ DoInitialize()

void ns3::LteFfrEnhancedAlgorithm::DoInitialize ( )
overrideprotectedvirtual

◆ DoIsDlRbgAvailableForUe()

bool ns3::LteFfrEnhancedAlgorithm::DoIsDlRbgAvailableForUe ( int rbId,
uint16_t rnti )
overrideprotectedvirtual

Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.

Parameters
rbId
rntiRadio Network Temporary Identity, an integer identifying the UE where the report originates from
Returns
true if UE can be served on i-th RB, false otherwise

Implements ns3::LteFfrAlgorithm.

Definition at line 488 of file lte-ffr-enhanced-algorithm.cc.

References AreaUnset, CenterArea, EdgeArea, m_dlPrimarySegmentRbgMap, m_dlRbgAvailableforUe, m_dlReuse1RbgMap, m_dlReuse3RbgMap, m_dlSecondarySegmentRbgMap, m_ues, NS_LOG_FUNCTION, and NS_LOG_INFO.

◆ DoIsUlRbgAvailableForUe()

bool ns3::LteFfrEnhancedAlgorithm::DoIsUlRbgAvailableForUe ( int rbId,
uint16_t rnti )
overrideprotectedvirtual

Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.

Parameters
rbId
rntiRadio Network Temporary Identity, an integer identifying the UE where the report originates from
Returns
true if UE can be served on i-th RB, false otherwise

Implements ns3::LteFfrAlgorithm.

Definition at line 583 of file lte-ffr-enhanced-algorithm.cc.

References AreaUnset, CenterArea, EdgeArea, ns3::LteFfrAlgorithm::m_enabledInUplink, m_ues, m_ulPrimarySegmentRbgMap, m_ulRbAvailableforUe, m_ulReuse1RbgMap, m_ulReuse3RbgMap, m_ulSecondarySegmentRbgMap, NS_LOG_FUNCTION, and NS_LOG_INFO.

◆ DoRecvLoadInformation()

void ns3::LteFfrEnhancedAlgorithm::DoRecvLoadInformation ( EpcX2Sap::LoadInformationParams params)
overrideprotectedvirtual

DoRecvLoadInformation.

Parameters
params

Implements ns3::LteFfrAlgorithm.

Definition at line 924 of file lte-ffr-enhanced-algorithm.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ DoReportDlCqiInfo()

void ns3::LteFfrEnhancedAlgorithm::DoReportDlCqiInfo ( const FfMacSchedSapProvider::SchedDlCqiInfoReqParameters & params)
overrideprotectedvirtual

DoReportDlCqiInfo.

Parameters
params

Implements ns3::LteFfrAlgorithm.

Definition at line 648 of file lte-ffr-enhanced-algorithm.cc.

References ns3::CqiListElement_s::A30, CenterArea, ns3::LteFfrAlgorithm::GetRbgSize(), ns3::LteFfrAlgorithm::m_dlBandwidth, m_dlCqi, m_dlCqiThreshold, m_dlRbgAvailableforUe, m_dlSecondarySegmentRbgMap, m_ues, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulRbAvailableforUe, NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_INFO.

+ Here is the call graph for this function:

◆ DoReportUeMeas()

void ns3::LteFfrEnhancedAlgorithm::DoReportUeMeas ( uint16_t rnti,
LteRrcSap::MeasResults measResults )
overrideprotectedvirtual

Implementation of LteFfrRrcSapProvider::ReportUeMeas.

Parameters
rntiRadio Network Temporary Identity, an integer identifying the UE where the report originates from
measResultsa single report of one measurement identity

Implements ns3::LteFfrAlgorithm.

Definition at line 876 of file lte-ffr-enhanced-algorithm.cc.

References AreaUnset, CenterArea, EdgeArea, m_centerAreaPowerOffset, m_edgeAreaPowerOffset, m_ffrRrcSapUser, m_measId, m_rsrqThreshold, m_ues, ns3::LteRrcSap::MeasResults::measId, ns3::LteRrcSap::MeasResults::measResultPCell, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, ns3::LteRrcSap::PdschConfigDedicated::pa, ns3::LteRrcSap::MeasResultPCell::rsrpResult, ns3::LteRrcSap::MeasResultPCell::rsrqResult, and ns3::LteFfrRrcSapUser::SetPdschConfigDedicated().

+ Here is the call graph for this function:

◆ DoReportUlCqiInfo() [1/2]

void ns3::LteFfrEnhancedAlgorithm::DoReportUlCqiInfo ( const FfMacSchedSapProvider::SchedUlCqiInfoReqParameters & params)
overrideprotectedvirtual

DoReportUlCqiInfo.

Parameters
params

Implements ns3::LteFfrAlgorithm.

Definition at line 751 of file lte-ffr-enhanced-algorithm.cc.

References ns3::LteFfConverter::fpS11dot3toDouble(), GetCqiFromSpectralEfficiency(), ns3::LteFfrAlgorithm::m_ulBandwidth, NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::UlCqi_s::SRS.

+ Here is the call graph for this function:

◆ DoReportUlCqiInfo() [2/2]

void ns3::LteFfrEnhancedAlgorithm::DoReportUlCqiInfo ( std::map< uint16_t, std::vector< double > > ulCqiMap)
overrideprotectedvirtual

DoReportUlCqiInfo.

Parameters
ulCqiMap

Implements ns3::LteFfrAlgorithm.

Definition at line 771 of file lte-ffr-enhanced-algorithm.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ EstimateUlSinr()

double ns3::LteFfrEnhancedAlgorithm::EstimateUlSinr ( uint16_t rnti,
uint16_t rb,
std::map< uint16_t, std::vector< double > > ulCqiMap )
private

Initialize uplink RBG maps.

Parameters
rntithe RNTI
rbRB
ulCqiMapUL CQI map
Returns
UL SINR

Definition at line 778 of file lte-ffr-enhanced-algorithm.cc.

References ns3::LteFfrAlgorithm::m_ulBandwidth, and ns3::NO_SINR.

◆ GetCqiFromSpectralEfficiency()

int ns3::LteFfrEnhancedAlgorithm::GetCqiFromSpectralEfficiency ( double s)
private

Get CQI from spectral efficiency.

Parameters
sspectral efficiency
Returns
CQI

Definition at line 324 of file lte-ffr-enhanced-algorithm.cc.

References NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::SpectralEfficiencyForCqi.

Referenced by DoReportUlCqiInfo().

+ Here is the caller graph for this function:

◆ GetLteFfrRrcSapProvider()

LteFfrRrcSapProvider * ns3::LteFfrEnhancedAlgorithm::GetLteFfrRrcSapProvider ( )
overridevirtual

Export the "provider" part of the LteFfrRrcSap interface.

Returns
the reference to the "provider" part of the interface, typically to be kept by an LteEnbRrc instance

Implements ns3::LteFfrAlgorithm.

Definition at line 240 of file lte-ffr-enhanced-algorithm.cc.

References m_ffrRrcSapProvider, and NS_LOG_FUNCTION.

◆ GetLteFfrSapProvider()

LteFfrSapProvider * ns3::LteFfrEnhancedAlgorithm::GetLteFfrSapProvider ( )
overridevirtual

Export the "provider" part of the LteFfrSap interface.

Returns
the reference to the "provider" part of the interface, typically to be kept by an Scheduler instance

Implements ns3::LteFfrAlgorithm.

Definition at line 226 of file lte-ffr-enhanced-algorithm.cc.

References m_ffrSapProvider, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::LteFfrEnhancedAlgorithm::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 131 of file lte-ffr-enhanced-algorithm.cc.

References m_centerAreaPowerOffset, m_centerAreaTpc, m_dlCqiThreshold, m_dlReuse1SubBandwidth, m_dlReuse3SubBandwidth, m_dlSubBandOffset, m_edgeAreaPowerOffset, m_edgeAreaTpc, m_rsrqThreshold, m_ulCqiThreshold, m_ulReuse1SubBandwidth, m_ulReuse3SubBandwidth, m_ulSubBandOffset, ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ InitializeDownlinkRbgMaps()

void ns3::LteFfrEnhancedAlgorithm::InitializeDownlinkRbgMaps ( )
private

Initialize downlink RBG maps.

Definition at line 338 of file lte-ffr-enhanced-algorithm.cc.

References ns3::LteFfrAlgorithm::GetRbgSize(), ns3::LteFfrAlgorithm::m_dlBandwidth, m_dlPrimarySegmentRbgMap, m_dlRbgMap, m_dlReuse1RbgMap, m_dlReuse1SubBandwidth, m_dlReuse3RbgMap, m_dlReuse3SubBandwidth, m_dlSecondarySegmentRbgMap, m_dlSubBandOffset, and NS_ASSERT_MSG.

Referenced by DoGetAvailableDlRbg(), and Reconfigure().

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

◆ InitializeUplinkRbgMaps()

void ns3::LteFfrEnhancedAlgorithm::InitializeUplinkRbgMaps ( )
private

Initialize uplink RBG maps.

Definition at line 394 of file lte-ffr-enhanced-algorithm.cc.

References ns3::LteFfrAlgorithm::m_enabledInUplink, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulPrimarySegmentRbgMap, m_ulRbgMap, m_ulReuse1RbgMap, m_ulReuse1SubBandwidth, m_ulReuse3RbgMap, m_ulReuse3SubBandwidth, m_ulSecondarySegmentRbgMap, m_ulSubBandOffset, and NS_ASSERT_MSG.

Referenced by DoGetAvailableUlRbg(), and Reconfigure().

+ Here is the caller graph for this function:

◆ Reconfigure()

void ns3::LteFfrEnhancedAlgorithm::Reconfigure ( )
overrideprotectedvirtual

Automatic FR reconfiguration.

Implements ns3::LteFfrAlgorithm.

Definition at line 274 of file lte-ffr-enhanced-algorithm.cc.

References InitializeDownlinkRbgMaps(), InitializeUplinkRbgMaps(), ns3::LteFfrAlgorithm::m_dlBandwidth, ns3::LteFfrAlgorithm::m_frCellTypeId, ns3::LteFfrAlgorithm::m_needReconfiguration, ns3::LteFfrAlgorithm::m_ulBandwidth, NS_LOG_FUNCTION, SetDownlinkConfiguration(), and SetUplinkConfiguration().

Referenced by DoGetAvailableDlRbg().

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

◆ SetDownlinkConfiguration()

void ns3::LteFfrEnhancedAlgorithm::SetDownlinkConfiguration ( uint16_t cellId,
uint8_t bandwidth )
private

Set downlink configuration.

Parameters
cellIdthe cell ID
bandwidththe bandwidth

Definition at line 288 of file lte-ffr-enhanced-algorithm.cc.

References ns3::FfrEnhancedDownlinkDefaultConfiguration::dlReuse1SubBandwidth, ns3::FfrEnhancedDownlinkDefaultConfiguration::dlReuse3SubBandwidth, ns3::FfrEnhancedDownlinkDefaultConfiguration::dlSubBandOffset, ns3::g_ffrEnhancedDownlinkDefaultConfiguration, ns3::LteFfrAlgorithm::m_dlBandwidth, m_dlReuse1SubBandwidth, m_dlReuse3SubBandwidth, m_dlSubBandOffset, NS_LOG_FUNCTION, and ns3::NUM_DOWNLINK_CONFS().

Referenced by DoInitialize(), and Reconfigure().

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

◆ SetLteFfrRrcSapUser()

void ns3::LteFfrEnhancedAlgorithm::SetLteFfrRrcSapUser ( LteFfrRrcSapUser * s)
overridevirtual

Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will interact with.

Parameters
sa reference to the "user" part of the interface, typically a member of an LteEnbRrc instance

Implements ns3::LteFfrAlgorithm.

Definition at line 233 of file lte-ffr-enhanced-algorithm.cc.

References m_ffrRrcSapUser, and NS_LOG_FUNCTION.

◆ SetLteFfrSapUser()

void ns3::LteFfrEnhancedAlgorithm::SetLteFfrSapUser ( LteFfrSapUser * s)
overridevirtual

Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will interact with.

Parameters
sa reference to the "user" part of the interface, typically a member of an Scheduler instance

Implements ns3::LteFfrAlgorithm.

Definition at line 219 of file lte-ffr-enhanced-algorithm.cc.

References m_ffrSapUser, and NS_LOG_FUNCTION.

◆ SetUplinkConfiguration()

void ns3::LteFfrEnhancedAlgorithm::SetUplinkConfiguration ( uint16_t cellId,
uint8_t bandwidth )
private

Set uplink configuration.

Parameters
cellIdthe cell ID
bandwidththe bandwidth

Definition at line 306 of file lte-ffr-enhanced-algorithm.cc.

References ns3::g_ffrEnhancedUplinkDefaultConfiguration, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulReuse1SubBandwidth, m_ulReuse3SubBandwidth, m_ulSubBandOffset, NS_LOG_FUNCTION, ns3::NUM_UPLINK_CONFS(), ns3::FfrEnhancedUplinkDefaultConfiguration::ulReuse1SubBandwidth, ns3::FfrEnhancedUplinkDefaultConfiguration::ulReuse3SubBandwidth, and ns3::FfrEnhancedUplinkDefaultConfiguration::ulSubBandOffset.

Referenced by DoInitialize(), and Reconfigure().

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

Friends And Related Symbol Documentation

◆ MemberLteFfrRrcSapProvider< LteFfrEnhancedAlgorithm >

let the forwarder class access the protected and private members

Definition at line 50 of file lte-ffr-enhanced-algorithm.h.

Referenced by LteFfrEnhancedAlgorithm().

◆ MemberLteFfrSapProvider< LteFfrEnhancedAlgorithm >

let the forwarder class access the protected and private members

Definition at line 50 of file lte-ffr-enhanced-algorithm.h.

Referenced by LteFfrEnhancedAlgorithm().

Member Data Documentation

◆ m_centerAreaPowerOffset

uint8_t ns3::LteFfrEnhancedAlgorithm::m_centerAreaPowerOffset
private

Center area power offset.

Definition at line 165 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoReportUeMeas(), and GetTypeId().

◆ m_centerAreaTpc

uint8_t ns3::LteFfrEnhancedAlgorithm::m_centerAreaTpc
private

Center area TPC.

Definition at line 168 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoGetTpc(), and GetTypeId().

◆ m_dlCqi

std::map<uint16_t, SbMeasResult_s> ns3::LteFfrEnhancedAlgorithm::m_dlCqi
private

Map of UE's DL CQI A30 received.

Definition at line 175 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoReportDlCqiInfo().

◆ m_dlCqiThreshold

uint8_t ns3::LteFfrEnhancedAlgorithm::m_dlCqiThreshold
private

DL CQI threshold.

Definition at line 171 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoReportDlCqiInfo(), and GetTypeId().

◆ m_dlPrimarySegmentRbgMap

std::vector<bool> ns3::LteFfrEnhancedAlgorithm::m_dlPrimarySegmentRbgMap
private

DL primary segment RBG map.

Definition at line 145 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().

◆ m_dlRbgAvailableforUe

std::map<uint16_t, std::vector<bool> > ns3::LteFfrEnhancedAlgorithm::m_dlRbgAvailableforUe
private

DL RBG available for UE.

Definition at line 176 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoGetAvailableDlRbg(), DoIsDlRbgAvailableForUe(), and DoReportDlCqiInfo().

◆ m_dlRbgMap

std::vector<bool> ns3::LteFfrEnhancedAlgorithm::m_dlRbgMap
private

DL RBG map.

Definition at line 140 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoGetAvailableDlRbg(), and InitializeDownlinkRbgMaps().

◆ m_dlReuse1RbgMap

std::vector<bool> ns3::LteFfrEnhancedAlgorithm::m_dlReuse1RbgMap
private

DL reuse 1 RBG map.

Definition at line 144 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().

◆ m_dlReuse1SubBandwidth

uint8_t ns3::LteFfrEnhancedAlgorithm::m_dlReuse1SubBandwidth
private

DL reuse 1 subband bandwidth.

Definition at line 134 of file lte-ffr-enhanced-algorithm.h.

Referenced by GetTypeId(), InitializeDownlinkRbgMaps(), and SetDownlinkConfiguration().

◆ m_dlReuse3RbgMap

std::vector<bool> ns3::LteFfrEnhancedAlgorithm::m_dlReuse3RbgMap
private

DL reuse 3 RBG map.

Definition at line 143 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().

◆ m_dlReuse3SubBandwidth

uint8_t ns3::LteFfrEnhancedAlgorithm::m_dlReuse3SubBandwidth
private

DL reuse 3 subband bandwidth.

Definition at line 133 of file lte-ffr-enhanced-algorithm.h.

Referenced by GetTypeId(), InitializeDownlinkRbgMaps(), and SetDownlinkConfiguration().

◆ m_dlSecondarySegmentRbgMap

std::vector<bool> ns3::LteFfrEnhancedAlgorithm::m_dlSecondarySegmentRbgMap
private

DL secondary segment RBG map.

Definition at line 146 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoIsDlRbgAvailableForUe(), DoReportDlCqiInfo(), and InitializeDownlinkRbgMaps().

◆ m_dlSubBandOffset

uint8_t ns3::LteFfrEnhancedAlgorithm::m_dlSubBandOffset
private

DL subband offset.

Definition at line 132 of file lte-ffr-enhanced-algorithm.h.

Referenced by GetTypeId(), InitializeDownlinkRbgMaps(), and SetDownlinkConfiguration().

◆ m_edgeAreaPowerOffset

uint8_t ns3::LteFfrEnhancedAlgorithm::m_edgeAreaPowerOffset
private

Edge area power offset.

Definition at line 166 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoReportUeMeas(), and GetTypeId().

◆ m_edgeAreaTpc

uint8_t ns3::LteFfrEnhancedAlgorithm::m_edgeAreaTpc
private

Edge are TPC.

Definition at line 169 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoGetTpc(), and GetTypeId().

◆ m_ffrRrcSapProvider

LteFfrRrcSapProvider* ns3::LteFfrEnhancedAlgorithm::m_ffrRrcSapProvider
private

FFR RRC SAP provider.

Definition at line 130 of file lte-ffr-enhanced-algorithm.h.

Referenced by LteFfrEnhancedAlgorithm(), DoDispose(), and GetLteFfrRrcSapProvider().

◆ m_ffrRrcSapUser

LteFfrRrcSapUser* ns3::LteFfrEnhancedAlgorithm::m_ffrRrcSapUser
private

FFR RRC SAP user.

Definition at line 129 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoInitialize(), DoReportUeMeas(), and SetLteFfrRrcSapUser().

◆ m_ffrSapProvider

LteFfrSapProvider* ns3::LteFfrEnhancedAlgorithm::m_ffrSapProvider
private

FFR SAP provider.

Definition at line 126 of file lte-ffr-enhanced-algorithm.h.

Referenced by LteFfrEnhancedAlgorithm(), DoDispose(), and GetLteFfrSapProvider().

◆ m_ffrSapUser

LteFfrSapUser* ns3::LteFfrEnhancedAlgorithm::m_ffrSapUser
private

FFR SAP user.

Definition at line 125 of file lte-ffr-enhanced-algorithm.h.

Referenced by SetLteFfrSapUser().

◆ m_measId

uint8_t ns3::LteFfrEnhancedAlgorithm::m_measId
private

The expected measurement identity.

Definition at line 183 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoInitialize(), and DoReportUeMeas().

◆ m_rsrqThreshold

uint8_t ns3::LteFfrEnhancedAlgorithm::m_rsrqThreshold
private

RSRQ threshold.

Definition at line 163 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoReportUeMeas(), and GetTypeId().

◆ m_ues

std::map<uint16_t, uint8_t> ns3::LteFfrEnhancedAlgorithm::m_ues
private

◆ m_ulCqi

std::map<uint16_t, std::vector<int> > ns3::LteFfrEnhancedAlgorithm::m_ulCqi
private

UL CQI.

Definition at line 179 of file lte-ffr-enhanced-algorithm.h.

◆ m_ulCqiThreshold

uint8_t ns3::LteFfrEnhancedAlgorithm::m_ulCqiThreshold
private

UL CQI threshold.

Definition at line 178 of file lte-ffr-enhanced-algorithm.h.

Referenced by GetTypeId().

◆ m_ulPrimarySegmentRbgMap

std::vector<bool> ns3::LteFfrEnhancedAlgorithm::m_ulPrimarySegmentRbgMap
private

UL primary segment RBG map.

Definition at line 150 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

◆ m_ulRbAvailableforUe

std::map<uint16_t, std::vector<bool> > ns3::LteFfrEnhancedAlgorithm::m_ulRbAvailableforUe
private

UL RB available for UE.

Definition at line 180 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoGetAvailableUlRbg(), DoIsUlRbgAvailableForUe(), and DoReportDlCqiInfo().

◆ m_ulRbgMap

std::vector<bool> ns3::LteFfrEnhancedAlgorithm::m_ulRbgMap
private

UL RBG Map.

Definition at line 141 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoGetAvailableUlRbg(), and InitializeUplinkRbgMaps().

◆ m_ulReuse1RbgMap

std::vector<bool> ns3::LteFfrEnhancedAlgorithm::m_ulReuse1RbgMap
private

UL reuse 1 RBG map.

Definition at line 149 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

◆ m_ulReuse1SubBandwidth

uint8_t ns3::LteFfrEnhancedAlgorithm::m_ulReuse1SubBandwidth
private

UL reuse 1 subbandwidth.

Definition at line 138 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoGetMinContinuousUlBandwidth(), GetTypeId(), InitializeUplinkRbgMaps(), and SetUplinkConfiguration().

◆ m_ulReuse3RbgMap

std::vector<bool> ns3::LteFfrEnhancedAlgorithm::m_ulReuse3RbgMap
private

UL reuse 3 RBG map.

Definition at line 148 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

◆ m_ulReuse3SubBandwidth

uint8_t ns3::LteFfrEnhancedAlgorithm::m_ulReuse3SubBandwidth
private

UL reuse 3 subbandwidth.

Definition at line 137 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoGetMinContinuousUlBandwidth(), GetTypeId(), InitializeUplinkRbgMaps(), and SetUplinkConfiguration().

◆ m_ulSecondarySegmentRbgMap

std::vector<bool> ns3::LteFfrEnhancedAlgorithm::m_ulSecondarySegmentRbgMap
private

UL secondary segment RBG map.

Definition at line 151 of file lte-ffr-enhanced-algorithm.h.

Referenced by DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

◆ m_ulSubBandOffset

uint8_t ns3::LteFfrEnhancedAlgorithm::m_ulSubBandOffset
private

UL subband offset.

Definition at line 136 of file lte-ffr-enhanced-algorithm.h.

Referenced by GetTypeId(), InitializeUplinkRbgMaps(), and SetUplinkConfiguration().


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