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

Static Public Member Functions

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

Protected Member Functions

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

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. More...
 
int GetCqiFromSpectralEfficiency (double s)
 Get CQI from spectral efficiency. More...
 
void InitializeDownlinkRbgMaps ()
 Initialize downlink RBG maps. More...
 
void InitializeUplinkRbgMaps ()
 Initialize uplink RBG maps. More...
 
void SetDownlinkConfiguration (uint16_t cellId, uint8_t bandwidth)
 Set downlink configuration. More...
 
void SetUplinkConfiguration (uint16_t cellId, uint8_t bandwidth)
 Set uplink configuration. More...
 

Private Attributes

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

Friends

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

Additional Inherited Members

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

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::LteNetDevice/$ns3::LteEnbNetDevice/LteFfrAlgorithm/$ns3::LteFfrEnhancedAlgorithm"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/ComponentCarrierMap/[i]/LteFfrAlgorithm/$ns3::LteFfrEnhancedAlgorithm"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteFfrAlgorithm/$ns3::LteFfrEnhancedAlgorithm"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/ComponentCarrierMap/[i]/LteFfrAlgorithm/$ns3::LteFfrEnhancedAlgorithm"

Attributes

  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read

Attributes defined in parent class ns3::LteFfrAlgorithm

  • 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: construct write read
  • EnabledInUplink: If FR algorithm will also work in Uplink, default value true
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 744 bytes (on a 64-bit architecture).

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

Member Enumeration Documentation

◆ UePosition

UE Position enumeration.

Enumerator
AreaUnset 
CenterArea 
EdgeArea 

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

Constructor & Destructor Documentation

◆ LteFfrEnhancedAlgorithm()

ns3::LteFfrEnhancedAlgorithm::LteFfrEnhancedAlgorithm ( )

Creates a trivial ffr algorithm instance.

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

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

◆ ~LteFfrEnhancedAlgorithm()

ns3::LteFfrEnhancedAlgorithm::~LteFfrEnhancedAlgorithm ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::LteFfrEnhancedAlgorithm::DoDispose ( void  )
protectedvirtual

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 115 of file lte-ffr-enhanced-algorithm.cc.

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

◆ DoGetAvailableDlRbg()

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

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 440 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 ( )
protectedvirtual

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 536 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()

uint8_t ns3::LteFfrEnhancedAlgorithm::DoGetMinContinuousUlBandwidth ( )
protectedvirtual

DoGetMinContinuousUlBandwidth in number of RB.

Returns
number of RB in min continuous UL Bandwidth

Implements ns3::LteFfrAlgorithm.

Definition at line 835 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)
protectedvirtual

DoGetTpc for UE.

Parameters
rnti
Returns
TPC value

Implements ns3::LteFfrAlgorithm.

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

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

◆ DoInitialize()

◆ DoIsDlRbgAvailableForUe()

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

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 475 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 
)
protectedvirtual

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 571 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)
protectedvirtual

DoRecvLoadInformation.

Parameters
params

Implements ns3::LteFfrAlgorithm.

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

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ DoReportDlCqiInfo()

◆ DoReportUeMeas()

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

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 859 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, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_WARN, ns3::LteRrcSap::PdschConfigDedicated::pa, ns3::LteRrcSap::MeasResults::rsrpResult, ns3::LteRrcSap::MeasResults::rsrqResult, and ns3::LteFfrRrcSapUser::SetPdschConfigDedicated().

+ Here is the call graph for this function:

◆ DoReportUlCqiInfo() [1/2]

void ns3::LteFfrEnhancedAlgorithm::DoReportUlCqiInfo ( const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters params)
protectedvirtual

◆ DoReportUlCqiInfo() [2/2]

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

DoReportUlCqiInfo.

Parameters
ulCqiMap

Implements ns3::LteFfrAlgorithm.

Definition at line 760 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 767 of file lte-ffr-enhanced-algorithm.cc.

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

◆ GetCqiFromSpectralEfficiency()

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

Get CQI from spectral efficiency.

Parameters
sspectral efficiency
Returns
CQI

Definition at line 308 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 call graph for this function:
+ Here is the caller graph for this function:

◆ GetLteFfrRrcSapProvider()

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

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 228 of file lte-ffr-enhanced-algorithm.cc.

References m_ffrRrcSapProvider, and NS_LOG_FUNCTION.

◆ GetLteFfrSapProvider()

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

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 213 of file lte-ffr-enhanced-algorithm.cc.

References m_ffrSapProvider, and NS_LOG_FUNCTION.

◆ GetTypeId()

◆ InitializeDownlinkRbgMaps()

void ns3::LteFfrEnhancedAlgorithm::InitializeDownlinkRbgMaps ( )
private

Initialize downlink RBG maps.

Definition at line 322 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

◆ Reconfigure()

void ns3::LteFfrEnhancedAlgorithm::Reconfigure ( )
protectedvirtual

◆ SetDownlinkConfiguration()

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

◆ SetLteFfrRrcSapUser()

void ns3::LteFfrEnhancedAlgorithm::SetLteFfrRrcSapUser ( LteFfrRrcSapUser s)
virtual

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 220 of file lte-ffr-enhanced-algorithm.cc.

References m_ffrRrcSapUser, and NS_LOG_FUNCTION.

◆ SetLteFfrSapUser()

void ns3::LteFfrEnhancedAlgorithm::SetLteFfrSapUser ( LteFfrSapUser s)
virtual

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 205 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

Friends And Related Function Documentation

◆ MemberLteFfrRrcSapProvider< LteFfrEnhancedAlgorithm >

let the forwarder class access the protected and private members

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

◆ MemberLteFfrSapProvider< LteFfrEnhancedAlgorithm >

let the forwarder class access the protected and private members

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

Member Data Documentation

◆ m_centerAreaPowerOffset

uint8_t ns3::LteFfrEnhancedAlgorithm::m_centerAreaPowerOffset
private

Center area power offset.

Definition at line 171 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 174 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 182 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 178 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 151 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 183 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 146 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 150 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 140 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 149 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 139 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 152 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 138 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 172 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 175 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 136 of file lte-ffr-enhanced-algorithm.h.

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

◆ m_ffrRrcSapUser

LteFfrRrcSapUser* ns3::LteFfrEnhancedAlgorithm::m_ffrRrcSapUser
private

FFR RRC SAP user.

Definition at line 135 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 132 of file lte-ffr-enhanced-algorithm.h.

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

◆ m_ffrSapUser

LteFfrSapUser* ns3::LteFfrEnhancedAlgorithm::m_ffrSapUser
private

FFR SAP user.

Definition at line 131 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 190 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 169 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 186 of file lte-ffr-enhanced-algorithm.h.

◆ m_ulCqiThreshold

uint8_t ns3::LteFfrEnhancedAlgorithm::m_ulCqiThreshold
private

UL CQI threshold.

Definition at line 185 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 156 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 187 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 147 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 155 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 144 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 154 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 143 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 157 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 142 of file lte-ffr-enhanced-algorithm.h.

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


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