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::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 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 ()
 
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
 Implement the GetInstanceTypeId method defined in ObjectBase. 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...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment. 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 ()
 
- Static Public Member Functions inherited from ns3::LteFfrAlgorithm
static TypeId GetTypeId ()
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. 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 }
 

Private Member Functions

double EstimateUlSinr (uint16_t rnti, uint16_t rb, std::map< uint16_t, std::vector< double > > ulCqiMap)
 
int GetCqiFromSpectralEfficiency (double s)
 
void InitializeDownlinkRbgMaps ()
 
void InitializeUplinkRbgMaps ()
 
void SetDownlinkConfiguration (uint16_t cellId, uint8_t bandwidth)
 
void SetUplinkConfiguration (uint16_t cellId, uint8_t bandwidth)
 

Private Attributes

uint8_t m_centerAreaPowerOffset
 
uint8_t m_centerAreaTpc
 
std::map< uint16_t, SbMeasResult_s > m_dlCqi
 
uint8_t m_dlCqiThreshold
 
std::vector< bool > m_dlPrimarySegmentRbgMap
 
std::map< uint16_t, std::vector< bool > > m_dlRbgAvailableforUe
 
std::vector< bool > m_dlRbgMap
 
std::vector< bool > m_dlReuse1RbgMap
 
uint8_t m_dlReuse1SubBandwidth
 
std::vector< bool > m_dlReuse3RbgMap
 
uint8_t m_dlReuse3SubBandwidth
 
std::vector< bool > m_dlSecondarySegmentRbgMap
 
uint8_t m_dlSubBandOffset
 
uint8_t m_edgeAreaPowerOffset
 
uint8_t m_edgeAreaTpc
 
LteFfrRrcSapProvider * m_ffrRrcSapProvider
 
LteFfrRrcSapUser * m_ffrRrcSapUser
 
LteFfrSapProvider * m_ffrSapProvider
 
LteFfrSapUser * m_ffrSapUser
 
uint8_t m_measId
 
uint8_t m_rsrqThreshold
 
std::map< uint16_t, uint8_t > m_ues
 
std::map< uint16_t, std::vector< int > > m_ulCqi
 
uint8_t m_ulCqiThreshold
 
std::vector< bool > m_ulPrimarySegmentRbgMap
 
std::map< uint16_t, std::vector< bool > > m_ulRbAvailableforUe
 
std::vector< bool > m_ulRbgMap
 
std::vector< bool > m_ulReuse1RbgMap
 
uint8_t m_ulReuse1SubBandwidth
 
std::vector< bool > m_ulReuse3RbgMap
 
uint8_t m_ulReuse3SubBandwidth
 
std::vector< bool > m_ulSecondarySegmentRbgMap
 
uint8_t m_ulSubBandOffset
 

Friends

class MemberLteFfrRrcSapProvider< LteFfrEnhancedAlgorithm >
 
class MemberLteFfrSapProvider< LteFfrEnhancedAlgorithm >
 

Additional Inherited Members

- Protected Attributes inherited from ns3::LteFfrAlgorithm
uint16_t m_cellId
 
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

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::LteEnbNetDevice/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

enum ns3::LteFfrEnhancedAlgorithm::UePosition
private
Enumerator
AreaUnset 
CenterArea 
EdgeArea 

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

Constructor & Destructor Documentation

ns3::LteFfrEnhancedAlgorithm::LteFfrEnhancedAlgorithm ( )

Creates a trivial ffr algorithm instance.

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

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

ns3::LteFfrEnhancedAlgorithm::~LteFfrEnhancedAlgorithm ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

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 435 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:

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 531 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:

uint8_t ns3::LteFfrEnhancedAlgorithm::DoGetMinContinuousUlBandwidth ( )
protectedvirtual

DoGetMinContinuousUlBandwidth in number of RB.

Returns
number of RB in min continous UL Bandwidth

Implements ns3::LteFfrAlgorithm.

Definition at line 830 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.

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

DoGetTpc for UE.

Parameters
rnti
Returns
TPC value

Implements ns3::LteFfrAlgorithm.

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

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

void ns3::LteFfrEnhancedAlgorithm::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 231 of file lte-ffr-enhanced-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:

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 470 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.

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 566 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.

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

DoRecvLoadInformation.

Parameters
params

Implements ns3::LteFfrAlgorithm.

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

References NS_LOG_FUNCTION, and NS_LOG_WARN.

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

DoReportDlCqiInfo.

Parameters
params

Implements ns3::LteFfrAlgorithm.

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

References ns3::CqiListElement_s::A30, CenterArea, ns3::LteFfrAlgorithm::GetRbgSize(), ns3::FfMacSchedSapProvider::SchedDlCqiInfoReqParameters::m_cqiList, 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:

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 854 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:

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

DoReportUlCqiInfo.

Parameters
params

Implements ns3::LteFfrAlgorithm.

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

References ns3::LteFfConverter::fpS11dot3toDouble(), GetCqiFromSpectralEfficiency(), ns3::UlCqi_s::m_sinr, ns3::UlCqi_s::m_type, ns3::LteFfrAlgorithm::m_ulBandwidth, ns3::FfMacSchedSapProvider::SchedUlCqiInfoReqParameters::m_ulCqi, NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::UlCqi_s::SRS.

+ Here is the call graph for this function:

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

DoReportUlCqiInfo.

Parameters
ulCqiMap

Implements ns3::LteFfrAlgorithm.

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

References NS_LOG_FUNCTION, and NS_LOG_WARN.

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

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

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

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

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

References NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by DoReportUlCqiInfo().

+ Here is the caller graph for this function:

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

References m_ffrRrcSapProvider, and NS_LOG_FUNCTION.

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

References m_ffrSapProvider, and NS_LOG_FUNCTION.

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

Definition at line 119 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(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::LteFfrEnhancedAlgorithm::InitializeDownlinkRbgMaps ( )
private

Definition at line 317 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:

void ns3::LteFfrEnhancedAlgorithm::InitializeUplinkRbgMaps ( )
private

Definition at line 373 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:

void ns3::LteFfrEnhancedAlgorithm::Reconfigure ( )
protectedvirtual

Automatic FR reconfiguration.

Implements ns3::LteFfrAlgorithm.

Definition at line 257 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:

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

Definition at line 271 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:

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

References m_ffrRrcSapUser, and NS_LOG_FUNCTION.

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

References m_ffrSapUser, and NS_LOG_FUNCTION.

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

Definition at line 287 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 Function Documentation

friend class MemberLteFfrRrcSapProvider< LteFfrEnhancedAlgorithm >
friend

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

friend class MemberLteFfrSapProvider< LteFfrEnhancedAlgorithm >
friend

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

Member Data Documentation

uint8_t ns3::LteFfrEnhancedAlgorithm::m_centerAreaPowerOffset
private

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

Referenced by DoReportUeMeas(), and GetTypeId().

uint8_t ns3::LteFfrEnhancedAlgorithm::m_centerAreaTpc
private

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

Referenced by DoGetTpc(), and GetTypeId().

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

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

Referenced by DoReportDlCqiInfo().

uint8_t ns3::LteFfrEnhancedAlgorithm::m_dlCqiThreshold
private

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

Referenced by DoReportDlCqiInfo(), and GetTypeId().

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

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

Referenced by DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().

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

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

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

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

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

Referenced by DoGetAvailableDlRbg(), and InitializeDownlinkRbgMaps().

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

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

Referenced by DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().

uint8_t ns3::LteFfrEnhancedAlgorithm::m_dlReuse1SubBandwidth
private

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

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

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

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

Referenced by DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().

uint8_t ns3::LteFfrEnhancedAlgorithm::m_dlReuse3SubBandwidth
private

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

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

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

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

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

uint8_t ns3::LteFfrEnhancedAlgorithm::m_dlSubBandOffset
private

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

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

uint8_t ns3::LteFfrEnhancedAlgorithm::m_edgeAreaPowerOffset
private

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

Referenced by DoReportUeMeas(), and GetTypeId().

uint8_t ns3::LteFfrEnhancedAlgorithm::m_edgeAreaTpc
private

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

Referenced by DoGetTpc(), and GetTypeId().

LteFfrRrcSapProvider* ns3::LteFfrEnhancedAlgorithm::m_ffrRrcSapProvider
private

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

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

LteFfrRrcSapUser* ns3::LteFfrEnhancedAlgorithm::m_ffrRrcSapUser
private

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

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

LteFfrSapProvider* ns3::LteFfrEnhancedAlgorithm::m_ffrSapProvider
private

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

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

LteFfrSapUser* ns3::LteFfrEnhancedAlgorithm::m_ffrSapUser
private

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

Referenced by SetLteFfrSapUser().

uint8_t ns3::LteFfrEnhancedAlgorithm::m_measId
private

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

Referenced by DoInitialize(), and DoReportUeMeas().

uint8_t ns3::LteFfrEnhancedAlgorithm::m_rsrqThreshold
private

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

Referenced by DoReportUeMeas(), and GetTypeId().

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

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

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

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

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

uint8_t ns3::LteFfrEnhancedAlgorithm::m_ulCqiThreshold
private

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

Referenced by GetTypeId().

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

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

Referenced by DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

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

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

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

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

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

Referenced by DoGetAvailableUlRbg(), and InitializeUplinkRbgMaps().

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

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

Referenced by DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

uint8_t ns3::LteFfrEnhancedAlgorithm::m_ulReuse1SubBandwidth
private

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

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

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

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

Referenced by DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

uint8_t ns3::LteFfrEnhancedAlgorithm::m_ulReuse3SubBandwidth
private

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

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

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

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

Referenced by DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

uint8_t ns3::LteFfrEnhancedAlgorithm::m_ulSubBandOffset
private

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

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

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