A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
ns3::LteFfrSoftAlgorithm Class Reference

Soft Fractional Frequency Reuse algorithm implementation. More...

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

+ Inheritance diagram for ns3::LteFfrSoftAlgorithm:
+ Collaboration diagram for ns3::LteFfrSoftAlgorithm:

Public Member Functions

 LteFfrSoftAlgorithm ()
 Creates a trivial ffr algorithm instance. More...
 
virtual ~LteFfrSoftAlgorithm ()
 
virtual LteFfrRrcSapProvider * GetLteFfrRrcSapProvider ()
 Export the "provider" part of the LteFfrRrcSap interface. More...
 
virtual LteFfrSapProvider * GetLteFfrSapProvider ()
 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 ()
 
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. 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<>
Ptr< Object > GetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCount & operator= ([[maybe_unused]] 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 uint16_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 (uint16_t ulBandwidth, uint16_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 , MediumArea , EdgeArea }
 UE position enumeration. More...
 

Private Member Functions

void InitializeDownlinkRbgMaps ()
 Initialize downlink RBG maps function. More...
 
void InitializeUplinkRbgMaps ()
 Initialize uplink RBG maps function. More...
 
void SetDownlinkConfiguration (uint16_t cellId, uint8_t bandwidth)
 Set downlink configuration function. More...
 
void SetUplinkConfiguration (uint16_t cellId, uint8_t bandwidth)
 Set uplink configuration function. More...
 

Private Attributes

uint8_t m_centerAreaPowerOffset
 center area power offset More...
 
uint8_t m_centerAreaTpc
 center area tpc More...
 
uint8_t m_centerSubBandThreshold
 center subband threshold More...
 
std::vector< bool > m_dlCenterRbgMap
 DL center RBG map. More...
 
uint8_t m_dlCommonSubBandwidth
 DL common subbandwidth. More...
 
std::vector< bool > m_dlEdgeRbgMap
 DL edge RBG map. More...
 
uint8_t m_dlEdgeSubBandOffset
 DL edge subband offset. More...
 
uint8_t m_dlEdgeSubBandwidth
 DL edge subbandwidth. More...
 
std::vector< bool > m_dlMediumRbgMap
 DL medium RBG map. More...
 
std::vector< bool > m_dlRbgMap
 DL RBG Map. More...
 
uint8_t m_edgeAreaPowerOffset
 edge area power offset More...
 
uint8_t m_edgeAreaTpc
 edge area tpc More...
 
uint8_t m_edgeSubBandThreshold
 edge subband threshold More...
 
LteFfrRrcSapProvider * m_ffrRrcSapProvider
 FFR RRC SAP provider. More...
 
LteFfrRrcSapUser * m_ffrRrcSapUser
 FFR RRC SAP user. More...
 
LteFfrSapProvider * m_ffrSapProvider
 FFR SAP provider. More...
 
LteFfrSapUser * m_ffrSapUser
 FFR SAP user. More...
 
uint8_t m_measId
 The expected measurement identity. More...
 
uint8_t m_mediumAreaPowerOffset
 medium area power offset More...
 
uint8_t m_mediumAreaTpc
 medium area tpc More...
 
std::map< uint16_t, uint8_t > m_ues
 UEs. More...
 
std::vector< bool > m_ulCenterRbgMap
 UL center RBG map. More...
 
uint8_t m_ulCommonSubBandwidth
 UL common subbandwidth. More...
 
std::vector< bool > m_ulEdgeRbgMap
 UL edge RBG map. More...
 
uint8_t m_ulEdgeSubBandOffset
 UL edge subband offset. More...
 
uint8_t m_ulEdgeSubBandwidth
 UL edge subbandwidth. More...
 
std::vector< bool > m_ulMediumRbgMap
 UL medium RBG map. More...
 
std::vector< bool > m_ulRbgMap
 UL RBG map. More...
 

Friends

class MemberLteFfrRrcSapProvider< LteFfrSoftAlgorithm >
 let the forwarder class access the protected and private members More...
 
class MemberLteFfrSapProvider< LteFfrSoftAlgorithm >
 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...
 
- Related Functions inherited from ns3::ObjectBase
static TypeId GetObjectIid (void)
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...
 

Detailed Description

Soft Fractional Frequency Reuse algorithm implementation.

Config Paths

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

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

Attributes

  • UlCommonSubBandwidth: Uplink Medium (Common) SubBandwidth Configuration in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 6
    • Flags: construct write read
  • UlEdgeSubBandOffset: Uplink Edge SubBand Offset in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: construct write read
  • UlEdgeSubBandwidth: Uplink Edge SubBandwidth Configuration in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 6
    • Flags: construct write read
  • DlCommonSubBandwidth: Downlink Medium (Common) SubBandwidth Configuration in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 6
    • Flags: construct write read
  • DlEdgeSubBandOffset: Downlink Edge SubBand Offset in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: construct write read
  • DlEdgeSubBandwidth: Downlink Edge SubBandwidth Configuration in number of Resource Block Groups
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: construct write read
  • CenterRsrqThreshold: If the RSRQ of is worse than this threshold, UE should be served in Medium sub-band
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 30
    • Flags: construct write read
  • EdgeRsrqThreshold: 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: 20
    • 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
  • MediumAreaPowerOffset: PdschConfigDedicated::Pa value for Medium 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
  • 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
  • MediumAreaTpc: TPC value which will be set in DL-DCI for UEs in medium 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 464 bytes (on a 64-bit architecture).

Definition at line 37 of file lte-ffr-soft-algorithm.h.

Member Enumeration Documentation

◆ UePosition

enum ns3::LteFfrSoftAlgorithm::UePosition
private

UE position enumeration.

Enumerator
AreaUnset 
CenterArea 
MediumArea 
EdgeArea 

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

Constructor & Destructor Documentation

◆ LteFfrSoftAlgorithm()

ns3::LteFfrSoftAlgorithm::LteFfrSoftAlgorithm ( )

Creates a trivial ffr algorithm instance.

Definition at line 90 of file lte-ffr-soft-algorithm.cc.

References m_ffrRrcSapProvider, m_ffrSapProvider, MemberLteFfrRrcSapProvider< LteFfrSoftAlgorithm >, MemberLteFfrSapProvider< LteFfrSoftAlgorithm >, and NS_LOG_FUNCTION.

◆ ~LteFfrSoftAlgorithm()

ns3::LteFfrSoftAlgorithm::~LteFfrSoftAlgorithm ( )
virtual

Definition at line 105 of file lte-ffr-soft-algorithm.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::LteFfrSoftAlgorithm::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 112 of file lte-ffr-soft-algorithm.cc.

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

◆ DoGetAvailableDlRbg()

std::vector< bool > ns3::LteFfrSoftAlgorithm::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 386 of file lte-ffr-soft-algorithm.cc.

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

+ Here is the call graph for this function:

◆ DoGetAvailableUlRbg()

std::vector< bool > ns3::LteFfrSoftAlgorithm::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 448 of file lte-ffr-soft-algorithm.cc.

References InitializeUplinkRbgMaps(), m_ulRbgMap, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoGetMinContinuousUlBandwidth()

uint16_t ns3::LteFfrSoftAlgorithm::DoGetMinContinuousUlBandwidth ( )
protectedvirtual

DoGetMinContinuousUlBandwidth in number of RB.

Returns
number of RB in min continuous UL Bandwidth

Implements ns3::LteFfrAlgorithm.

Definition at line 573 of file lte-ffr-soft-algorithm.cc.

References ns3::LteFfrAlgorithm::m_enabledInUplink, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulCenterRbgMap, m_ulEdgeRbgMap, m_ulMediumRbgMap, NS_LOG_FUNCTION, and NS_LOG_INFO.

◆ DoGetTpc()

uint8_t ns3::LteFfrSoftAlgorithm::DoGetTpc ( uint16_t  rnti)
protectedvirtual

DoGetTpc for UE.

Parameters
rnti
Returns
TPC value

Implements ns3::LteFfrAlgorithm.

Definition at line 531 of file lte-ffr-soft-algorithm.cc.

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

◆ DoInitialize()

void ns3::LteFfrSoftAlgorithm::DoInitialize ( void  )
protectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

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

References ns3::LteFfrRrcSapUser::AddUeMeasReportConfigForFfr(), ns3::LteRrcSap::ThresholdEutra::choice, ns3::Object::DoInitialize(), ns3::LteRrcSap::ReportConfigEutra::EVENT_A1, ns3::LteRrcSap::ReportConfigEutra::eventId, ns3::LteFfrAlgorithm::m_dlBandwidth, m_ffrRrcSapUser, ns3::LteFfrAlgorithm::m_frCellTypeId, m_measId, ns3::LteFfrAlgorithm::m_ulBandwidth, ns3::LteRrcSap::ReportConfigEutra::MS120, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::LteRrcSap::ThresholdEutra::range, ns3::LteRrcSap::ReportConfigEutra::reportInterval, ns3::LteRrcSap::ReportConfigEutra::RSRQ, SetDownlinkConfiguration(), SetUplinkConfiguration(), ns3::LteRrcSap::ReportConfigEutra::threshold1, ns3::LteRrcSap::ThresholdEutra::THRESHOLD_RSRQ, and ns3::LteRrcSap::ReportConfigEutra::triggerQuantity.

+ Here is the call graph for this function:

◆ DoIsDlRbgAvailableForUe()

bool ns3::LteFfrSoftAlgorithm::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 404 of file lte-ffr-soft-algorithm.cc.

References AreaUnset, CenterArea, EdgeArea, m_dlCenterRbgMap, m_dlEdgeRbgMap, m_dlMediumRbgMap, m_ues, MediumArea, and NS_LOG_FUNCTION.

◆ DoIsUlRbgAvailableForUe()

bool ns3::LteFfrSoftAlgorithm::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 461 of file lte-ffr-soft-algorithm.cc.

References AreaUnset, CenterArea, EdgeArea, ns3::LteFfrAlgorithm::m_enabledInUplink, m_ues, m_ulCenterRbgMap, m_ulEdgeRbgMap, m_ulMediumRbgMap, MediumArea, and NS_LOG_FUNCTION.

◆ DoRecvLoadInformation()

void ns3::LteFfrSoftAlgorithm::DoRecvLoadInformation ( EpcX2Sap::LoadInformationParams  params)
protectedvirtual

DoRecvLoadInformation.

Parameters
params

Implements ns3::LteFfrAlgorithm.

Definition at line 692 of file lte-ffr-soft-algorithm.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ DoReportDlCqiInfo()

void ns3::LteFfrSoftAlgorithm::DoReportDlCqiInfo ( const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &  params)
protectedvirtual

DoReportDlCqiInfo.

Parameters
params

Implements ns3::LteFfrAlgorithm.

Definition at line 510 of file lte-ffr-soft-algorithm.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ DoReportUeMeas()

void ns3::LteFfrSoftAlgorithm::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 627 of file lte-ffr-soft-algorithm.cc.

References AreaUnset, CenterArea, EdgeArea, m_centerAreaPowerOffset, m_centerSubBandThreshold, m_edgeAreaPowerOffset, m_edgeSubBandThreshold, m_ffrRrcSapUser, m_measId, m_mediumAreaPowerOffset, m_ues, ns3::LteRrcSap::MeasResults::measId, ns3::LteRrcSap::MeasResults::measResultPCell, MediumArea, NS_ASSERT_MSG, 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::LteFfrSoftAlgorithm::DoReportUlCqiInfo ( const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &  params)
protectedvirtual

DoReportUlCqiInfo.

Parameters
params

Implements ns3::LteFfrAlgorithm.

Definition at line 517 of file lte-ffr-soft-algorithm.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ DoReportUlCqiInfo() [2/2]

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

DoReportUlCqiInfo.

Parameters
ulCqiMap

Implements ns3::LteFfrAlgorithm.

Definition at line 524 of file lte-ffr-soft-algorithm.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ GetLteFfrRrcSapProvider()

LteFfrRrcSapProvider * ns3::LteFfrSoftAlgorithm::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 232 of file lte-ffr-soft-algorithm.cc.

References m_ffrRrcSapProvider, and NS_LOG_FUNCTION.

◆ GetLteFfrSapProvider()

LteFfrSapProvider * ns3::LteFfrSoftAlgorithm::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 217 of file lte-ffr-soft-algorithm.cc.

References m_ffrSapProvider, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::LteFfrSoftAlgorithm::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 121 of file lte-ffr-soft-algorithm.cc.

References m_centerAreaPowerOffset, m_centerAreaTpc, m_centerSubBandThreshold, m_dlCommonSubBandwidth, m_dlEdgeSubBandOffset, m_dlEdgeSubBandwidth, m_edgeAreaPowerOffset, m_edgeAreaTpc, m_edgeSubBandThreshold, m_mediumAreaPowerOffset, m_mediumAreaTpc, m_ulCommonSubBandwidth, m_ulEdgeSubBandOffset, m_ulEdgeSubBandwidth, ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ InitializeDownlinkRbgMaps()

void ns3::LteFfrSoftAlgorithm::InitializeDownlinkRbgMaps ( )
private

Initialize downlink RBG maps function.

Definition at line 312 of file lte-ffr-soft-algorithm.cc.

References ns3::LteFfrAlgorithm::GetRbgSize(), ns3::LteFfrAlgorithm::m_dlBandwidth, m_dlCenterRbgMap, m_dlCommonSubBandwidth, m_dlEdgeRbgMap, m_dlEdgeSubBandOffset, m_dlEdgeSubBandwidth, m_dlMediumRbgMap, m_dlRbgMap, 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::LteFfrSoftAlgorithm::InitializeUplinkRbgMaps ( )
private

Initialize uplink RBG maps function.

Definition at line 350 of file lte-ffr-soft-algorithm.cc.

References ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulCenterRbgMap, m_ulCommonSubBandwidth, m_ulEdgeRbgMap, m_ulEdgeSubBandOffset, m_ulEdgeSubBandwidth, m_ulMediumRbgMap, m_ulRbgMap, and NS_ASSERT_MSG.

Referenced by DoGetAvailableUlRbg(), and Reconfigure().

+ Here is the caller graph for this function:

◆ Reconfigure()

void ns3::LteFfrSoftAlgorithm::Reconfigure ( )
protectedvirtual

Automatic FR reconfiguration.

Implements ns3::LteFfrAlgorithm.

Definition at line 266 of file lte-ffr-soft-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::LteFfrSoftAlgorithm::SetDownlinkConfiguration ( uint16_t  cellId,
uint8_t  bandwidth 
)
private

Set downlink configuration function.

Parameters
cellIdthe cell ID
bandwidththe bandwidth

Definition at line 280 of file lte-ffr-soft-algorithm.cc.

References ns3::FfrSoftDownlinkDefaultConfiguration::dlCommonSubBandwidth, ns3::FfrSoftDownlinkDefaultConfiguration::dlEdgeSubBandOffset, ns3::FfrSoftDownlinkDefaultConfiguration::dlEdgeSubBandwidth, ns3::g_ffrSoftDownlinkDefaultConfiguration, ns3::LteFfrAlgorithm::m_dlBandwidth, m_dlCommonSubBandwidth, m_dlEdgeSubBandOffset, m_dlEdgeSubBandwidth, 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::LteFfrSoftAlgorithm::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 224 of file lte-ffr-soft-algorithm.cc.

References m_ffrRrcSapUser, and NS_LOG_FUNCTION.

◆ SetLteFfrSapUser()

void ns3::LteFfrSoftAlgorithm::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 209 of file lte-ffr-soft-algorithm.cc.

References m_ffrSapUser, and NS_LOG_FUNCTION.

◆ SetUplinkConfiguration()

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

Set uplink configuration function.

Parameters
cellIdthe cell ID
bandwidththe bandwidth

Definition at line 296 of file lte-ffr-soft-algorithm.cc.

References ns3::g_ffrSoftUplinkDefaultConfiguration, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulCommonSubBandwidth, m_ulEdgeSubBandOffset, m_ulEdgeSubBandwidth, NS_LOG_FUNCTION, ns3::NUM_UPLINK_CONFS(), ns3::FfrSoftUplinkDefaultConfiguration::ulCommonSubBandwidth, ns3::FfrSoftUplinkDefaultConfiguration::ulEdgeSubBandOffset, and ns3::FfrSoftUplinkDefaultConfiguration::ulEdgeSubBandwidth.

Referenced by DoInitialize(), and Reconfigure().

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

Friends And Related Function Documentation

◆ MemberLteFfrRrcSapProvider< LteFfrSoftAlgorithm >

friend class MemberLteFfrRrcSapProvider< LteFfrSoftAlgorithm >
friend

let the forwarder class access the protected and private members

Definition at line 58 of file lte-ffr-soft-algorithm.h.

Referenced by LteFfrSoftAlgorithm().

◆ MemberLteFfrSapProvider< LteFfrSoftAlgorithm >

friend class MemberLteFfrSapProvider< LteFfrSoftAlgorithm >
friend

let the forwarder class access the protected and private members

Definition at line 58 of file lte-ffr-soft-algorithm.h.

Referenced by LteFfrSoftAlgorithm().

Member Data Documentation

◆ m_centerAreaPowerOffset

uint8_t ns3::LteFfrSoftAlgorithm::m_centerAreaPowerOffset
private

center area power offset

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

Referenced by DoReportUeMeas(), and GetTypeId().

◆ m_centerAreaTpc

uint8_t ns3::LteFfrSoftAlgorithm::m_centerAreaTpc
private

center area tpc

Definition at line 158 of file lte-ffr-soft-algorithm.h.

Referenced by DoGetTpc(), and GetTypeId().

◆ m_centerSubBandThreshold

uint8_t ns3::LteFfrSoftAlgorithm::m_centerSubBandThreshold
private

center subband threshold

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

Referenced by DoReportUeMeas(), and GetTypeId().

◆ m_dlCenterRbgMap

std::vector<bool> ns3::LteFfrSoftAlgorithm::m_dlCenterRbgMap
private

DL center RBG map.

Definition at line 131 of file lte-ffr-soft-algorithm.h.

Referenced by DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().

◆ m_dlCommonSubBandwidth

uint8_t ns3::LteFfrSoftAlgorithm::m_dlCommonSubBandwidth
private

DL common subbandwidth.

Definition at line 120 of file lte-ffr-soft-algorithm.h.

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

◆ m_dlEdgeRbgMap

std::vector<bool> ns3::LteFfrSoftAlgorithm::m_dlEdgeRbgMap
private

DL edge RBG map.

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

Referenced by DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().

◆ m_dlEdgeSubBandOffset

uint8_t ns3::LteFfrSoftAlgorithm::m_dlEdgeSubBandOffset
private

DL edge subband offset.

Definition at line 121 of file lte-ffr-soft-algorithm.h.

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

◆ m_dlEdgeSubBandwidth

uint8_t ns3::LteFfrSoftAlgorithm::m_dlEdgeSubBandwidth
private

DL edge subbandwidth.

Definition at line 122 of file lte-ffr-soft-algorithm.h.

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

◆ m_dlMediumRbgMap

std::vector<bool> ns3::LteFfrSoftAlgorithm::m_dlMediumRbgMap
private

DL medium RBG map.

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

Referenced by DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().

◆ m_dlRbgMap

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

DL RBG Map.

Definition at line 128 of file lte-ffr-soft-algorithm.h.

Referenced by DoGetAvailableDlRbg(), and InitializeDownlinkRbgMaps().

◆ m_edgeAreaPowerOffset

uint8_t ns3::LteFfrSoftAlgorithm::m_edgeAreaPowerOffset
private

edge area power offset

Definition at line 156 of file lte-ffr-soft-algorithm.h.

Referenced by DoReportUeMeas(), and GetTypeId().

◆ m_edgeAreaTpc

uint8_t ns3::LteFfrSoftAlgorithm::m_edgeAreaTpc
private

edge area tpc

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

Referenced by DoGetTpc(), and GetTypeId().

◆ m_edgeSubBandThreshold

uint8_t ns3::LteFfrSoftAlgorithm::m_edgeSubBandThreshold
private

edge subband threshold

Definition at line 152 of file lte-ffr-soft-algorithm.h.

Referenced by DoReportUeMeas(), and GetTypeId().

◆ m_ffrRrcSapProvider

LteFfrRrcSapProvider* ns3::LteFfrSoftAlgorithm::m_ffrRrcSapProvider
private

FFR RRC SAP provider.

Definition at line 118 of file lte-ffr-soft-algorithm.h.

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

◆ m_ffrRrcSapUser

LteFfrRrcSapUser* ns3::LteFfrSoftAlgorithm::m_ffrRrcSapUser
private

FFR RRC SAP user.

Definition at line 117 of file lte-ffr-soft-algorithm.h.

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

◆ m_ffrSapProvider

LteFfrSapProvider* ns3::LteFfrSoftAlgorithm::m_ffrSapProvider
private

FFR SAP provider.

Definition at line 114 of file lte-ffr-soft-algorithm.h.

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

◆ m_ffrSapUser

LteFfrSapUser* ns3::LteFfrSoftAlgorithm::m_ffrSapUser
private

FFR SAP user.

Definition at line 113 of file lte-ffr-soft-algorithm.h.

Referenced by SetLteFfrSapUser().

◆ m_measId

uint8_t ns3::LteFfrSoftAlgorithm::m_measId
private

The expected measurement identity.

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

Referenced by DoInitialize(), and DoReportUeMeas().

◆ m_mediumAreaPowerOffset

uint8_t ns3::LteFfrSoftAlgorithm::m_mediumAreaPowerOffset
private

medium area power offset

Definition at line 155 of file lte-ffr-soft-algorithm.h.

Referenced by DoReportUeMeas(), and GetTypeId().

◆ m_mediumAreaTpc

uint8_t ns3::LteFfrSoftAlgorithm::m_mediumAreaTpc
private

medium area tpc

Definition at line 159 of file lte-ffr-soft-algorithm.h.

Referenced by DoGetTpc(), and GetTypeId().

◆ m_ues

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

UEs.

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

Referenced by DoGetTpc(), DoIsDlRbgAvailableForUe(), DoIsUlRbgAvailableForUe(), and DoReportUeMeas().

◆ m_ulCenterRbgMap

std::vector<bool> ns3::LteFfrSoftAlgorithm::m_ulCenterRbgMap
private

UL center RBG map.

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

Referenced by DoGetMinContinuousUlBandwidth(), DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

◆ m_ulCommonSubBandwidth

uint8_t ns3::LteFfrSoftAlgorithm::m_ulCommonSubBandwidth
private

UL common subbandwidth.

Definition at line 124 of file lte-ffr-soft-algorithm.h.

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

◆ m_ulEdgeRbgMap

std::vector<bool> ns3::LteFfrSoftAlgorithm::m_ulEdgeRbgMap
private

UL edge RBG map.

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

Referenced by DoGetMinContinuousUlBandwidth(), DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

◆ m_ulEdgeSubBandOffset

uint8_t ns3::LteFfrSoftAlgorithm::m_ulEdgeSubBandOffset
private

UL edge subband offset.

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

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

◆ m_ulEdgeSubBandwidth

uint8_t ns3::LteFfrSoftAlgorithm::m_ulEdgeSubBandwidth
private

UL edge subbandwidth.

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

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

◆ m_ulMediumRbgMap

std::vector<bool> ns3::LteFfrSoftAlgorithm::m_ulMediumRbgMap
private

UL medium RBG map.

Definition at line 135 of file lte-ffr-soft-algorithm.h.

Referenced by DoGetMinContinuousUlBandwidth(), DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

◆ m_ulRbgMap

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

UL RBG map.

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

Referenced by DoGetAvailableUlRbg(), and InitializeUplinkRbgMaps().

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