Soft Frequency Reuse algorithm implementation. More...
#include <lte-fr-soft-algorithm.h>
Public Member Functions | |
LteFrSoftAlgorithm () | |
Creates a trivial ffr algorithm instance. More... | |
virtual | ~LteFrSoftAlgorithm () |
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... | |
![]() | |
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) |
![]() | |
Object () | |
virtual | ~Object () |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
Run the DoDispose methods of this object and all the objects aggregated to it. More... | |
AggregateIterator | GetAggregateIterator (void) const |
virtual TypeId | GetInstanceTypeId (void) const |
template<typename T > | |
Ptr< T > | GetObject (void) const |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
void | Initialize (void) |
This method calls the virtual DoInitialize method on all the objects aggregated to this object. More... | |
![]() | |
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... | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
bool | GetAttributeFailSafe (std::string name, AttributeValue &attribute) const |
void | SetAttribute (std::string name, const AttributeValue &value) |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Static Public Member Functions | |
static TypeId | GetTypeId () |
![]() | |
static TypeId | GetTypeId () |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static void | Cleanup (void) |
Noop. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Protected Member Functions | |
virtual void | DoDispose () |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. 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 () |
This method is called only once by Object::Initialize. 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 ¶ms) |
DoReportDlCqiInfo. More... | |
virtual void | DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults) |
Implementation of LteFfrRrcSapProvider::ReportUeMeas. More... | |
virtual void | DoReportUlCqiInfo (const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters ¶ms) |
DoReportUlCqiInfo. More... | |
virtual void | DoReportUlCqiInfo (std::map< uint16_t, std::vector< double > > ulCqiMap) |
DoReportUlCqiInfo. More... | |
virtual void | Reconfigure () |
Automatic FR reconfiguration. More... | |
![]() | |
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... | |
![]() | |
Object (const Object &o) | |
virtual void | NotifyNewAggregate (void) |
This method is invoked whenever two sets of objects are aggregated together. More... | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
This method is invoked once all member attributes have been initialized. More... | |
Private Types | |
enum | SubBand { AreaUnset, CellCenter, CellEdge } |
Private Member Functions | |
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_centerAreaTpc |
uint8_t | m_centerPowerOffset |
std::vector< bool > | m_dlEdgeRbgMap |
uint8_t | m_dlEdgeSubBandwidth |
uint8_t | m_dlEgdeSubBandOffset |
std::vector< bool > | m_dlRbgMap |
uint8_t | m_edgeAreaTpc |
uint8_t | m_edgePowerOffset |
uint8_t | m_egdeSubBandThreshold |
std::vector< uint16_t > | m_egdeUes |
LteFfrRrcSapProvider * | m_ffrRrcSapProvider |
LteFfrRrcSapUser * | m_ffrRrcSapUser |
LteFfrSapProvider * | m_ffrSapProvider |
LteFfrSapUser * | m_ffrSapUser |
bool | m_isEdgeSubBandForCenterUe |
uint8_t | m_measId |
std::map< uint16_t, uint8_t > | m_ues |
std::vector< bool > | m_ulEdgeRbgMap |
uint8_t | m_ulEdgeSubBandwidth |
uint8_t | m_ulEgdeSubBandOffset |
std::vector< bool > | m_ulRbgMap |
Friends | |
class | MemberLteFfrRrcSapProvider< LteFrSoftAlgorithm > |
class | MemberLteFfrSapProvider< LteFrSoftAlgorithm > |
Additional Inherited Members | |
![]() | |
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... | |
Soft Frequency Reuse algorithm implementation.
ns3::LteFrSoftAlgorithm is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Definition at line 37 of file lte-fr-soft-algorithm.h.
|
private |
Enumerator | |
---|---|
AreaUnset | |
CellCenter | |
CellEdge |
Definition at line 111 of file lte-fr-soft-algorithm.h.
ns3::LteFrSoftAlgorithm::LteFrSoftAlgorithm | ( | ) |
Creates a trivial ffr algorithm instance.
Definition at line 84 of file lte-fr-soft-algorithm.cc.
References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.
|
virtual |
Definition at line 99 of file lte-fr-soft-algorithm.cc.
References NS_LOG_FUNCTION.
|
protectedvirtual |
This method is called by Object::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 106 of file lte-fr-soft-algorithm.cc.
References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.
|
protectedvirtual |
Implementation of LteFfrSapProvider::GetAvailableDlRbg.
Implements ns3::LteFfrAlgorithm.
Definition at line 323 of file lte-fr-soft-algorithm.cc.
References InitializeDownlinkRbgMaps(), m_dlRbgMap, ns3::LteFfrAlgorithm::m_needReconfiguration, NS_LOG_FUNCTION, and Reconfigure().
|
protectedvirtual |
Implementation of LteFfrSapProvider::GetAvailableUlRbg.
Implements ns3::LteFfrAlgorithm.
Definition at line 369 of file lte-fr-soft-algorithm.cc.
References InitializeUplinkRbgMaps(), m_ulRbgMap, and NS_LOG_FUNCTION.
|
protectedvirtual |
DoGetMinContinuousUlBandwidth in number of RB.
Implements ns3::LteFfrAlgorithm.
Definition at line 474 of file lte-fr-soft-algorithm.cc.
References ns3::LteFfrAlgorithm::m_enabledInUplink, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulEdgeSubBandwidth, m_ulEgdeSubBandOffset, NS_LOG_FUNCTION, and NS_LOG_INFO.
|
protectedvirtual |
DoGetTpc for UE.
rnti |
Implements ns3::LteFfrAlgorithm.
Definition at line 436 of file lte-fr-soft-algorithm.cc.
References CellCenter, CellEdge, m_centerAreaTpc, m_edgeAreaTpc, ns3::LteFfrAlgorithm::m_enabledInUplink, m_ues, and NS_LOG_FUNCTION.
|
protectedvirtual |
This method is called only once by Object::Initialize.
If the user calls Object::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 211 of file lte-fr-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.
|
protectedvirtual |
Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.
rbId | |
rnti | Radio Network Temporary Identity, an integer identifying the UE where the report originates from |
Implements ns3::LteFfrAlgorithm.
Definition at line 341 of file lte-fr-soft-algorithm.cc.
References AreaUnset, CellEdge, m_dlEdgeRbgMap, m_isEdgeSubBandForCenterUe, m_ues, and NS_LOG_FUNCTION.
|
protectedvirtual |
Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.
rbId | |
rnti | Radio Network Temporary Identity, an integer identifying the UE where the report originates from |
Implements ns3::LteFfrAlgorithm.
Definition at line 382 of file lte-fr-soft-algorithm.cc.
References AreaUnset, CellEdge, ns3::LteFfrAlgorithm::m_enabledInUplink, m_isEdgeSubBandForCenterUe, m_ues, m_ulEdgeRbgMap, and NS_LOG_FUNCTION.
|
protectedvirtual |
DoRecvLoadInformation.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 553 of file lte-fr-soft-algorithm.cc.
References NS_LOG_FUNCTION, and NS_LOG_WARN.
|
protectedvirtual |
DoReportDlCqiInfo.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 415 of file lte-fr-soft-algorithm.cc.
References NS_LOG_FUNCTION, and NS_LOG_WARN.
|
protectedvirtual |
Implementation of LteFfrRrcSapProvider::ReportUeMeas.
rnti | Radio Network Temporary Identity, an integer identifying the UE where the report originates from |
measResults | a single report of one measurement identity |
Implements ns3::LteFfrAlgorithm.
Definition at line 504 of file lte-fr-soft-algorithm.cc.
References AreaUnset, CellCenter, CellEdge, m_centerPowerOffset, m_edgePowerOffset, m_egdeSubBandThreshold, m_ffrRrcSapUser, m_measId, 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().
|
protectedvirtual |
DoReportUlCqiInfo.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 422 of file lte-fr-soft-algorithm.cc.
References NS_LOG_FUNCTION, and NS_LOG_WARN.
|
protectedvirtual |
DoReportUlCqiInfo.
ulCqiMap |
Implements ns3::LteFfrAlgorithm.
Definition at line 429 of file lte-fr-soft-algorithm.cc.
References NS_LOG_FUNCTION, and NS_LOG_WARN.
|
virtual |
Export the "provider" part of the LteFfrRrcSap interface.
Implements ns3::LteFfrAlgorithm.
Definition at line 203 of file lte-fr-soft-algorithm.cc.
References m_ffrRrcSapProvider, and NS_LOG_FUNCTION.
|
virtual |
Export the "provider" part of the LteFfrSap interface.
Implements ns3::LteFfrAlgorithm.
Definition at line 188 of file lte-fr-soft-algorithm.cc.
References m_ffrSapProvider, and NS_LOG_FUNCTION.
|
static |
Definition at line 115 of file lte-fr-soft-algorithm.cc.
References m_centerAreaTpc, m_centerPowerOffset, m_dlEdgeSubBandwidth, m_dlEgdeSubBandOffset, m_edgeAreaTpc, m_edgePowerOffset, m_egdeSubBandThreshold, m_isEdgeSubBandForCenterUe, m_ulEdgeSubBandwidth, m_ulEgdeSubBandOffset, and ns3::TypeId::SetParent().
|
private |
Definition at line 281 of file lte-fr-soft-algorithm.cc.
References ns3::LteFfrAlgorithm::GetRbgSize(), ns3::LteFfrAlgorithm::m_dlBandwidth, m_dlEdgeRbgMap, m_dlEdgeSubBandwidth, m_dlEgdeSubBandOffset, m_dlRbgMap, and NS_ASSERT_MSG.
Referenced by DoGetAvailableDlRbg(), and Reconfigure().
|
private |
Definition at line 303 of file lte-fr-soft-algorithm.cc.
References ns3::LteFfrAlgorithm::m_dlBandwidth, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulEdgeRbgMap, m_ulEdgeSubBandwidth, m_ulEgdeSubBandOffset, m_ulRbgMap, and NS_ASSERT_MSG.
Referenced by DoGetAvailableUlRbg(), and Reconfigure().
|
protectedvirtual |
Automatic FR reconfiguration.
Implements ns3::LteFfrAlgorithm.
Definition at line 237 of file lte-fr-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().
|
private |
Definition at line 251 of file lte-fr-soft-algorithm.cc.
References ns3::FrSoftDownlinkDefaultConfiguration::dlEdgeSubBandwidth, ns3::FrSoftDownlinkDefaultConfiguration::dlEgdeSubBandOffset, ns3::g_frSoftDownlinkDefaultConfiguration, ns3::LteFfrAlgorithm::m_dlBandwidth, m_dlEdgeSubBandwidth, m_dlEgdeSubBandOffset, NS_LOG_FUNCTION, and ns3::NUM_DOWNLINK_CONFS().
Referenced by DoInitialize(), and Reconfigure().
|
virtual |
Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will interact with.
s | a reference to the "user" part of the interface, typically a member of an LteEnbRrc instance |
Implements ns3::LteFfrAlgorithm.
Definition at line 195 of file lte-fr-soft-algorithm.cc.
References m_ffrRrcSapUser, NS_LOG_FUNCTION, and s.
|
virtual |
Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will interact with.
s | a reference to the "user" part of the interface, typically a member of an Scheduler instance |
Implements ns3::LteFfrAlgorithm.
Definition at line 180 of file lte-fr-soft-algorithm.cc.
References m_ffrSapUser, NS_LOG_FUNCTION, and s.
|
private |
Definition at line 266 of file lte-fr-soft-algorithm.cc.
References ns3::g_frSoftUplinkDefaultConfiguration, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulEdgeSubBandwidth, m_ulEgdeSubBandOffset, NS_LOG_FUNCTION, ns3::NUM_UPLINK_CONFS(), ns3::FrSoftUplinkDefaultConfiguration::ulEdgeSubBandwidth, and ns3::FrSoftUplinkDefaultConfiguration::ulEgdeSubBandOffset.
Referenced by DoInitialize(), and Reconfigure().
|
friend |
Definition at line 59 of file lte-fr-soft-algorithm.h.
|
friend |
Definition at line 58 of file lte-fr-soft-algorithm.h.
|
private |
Definition at line 126 of file lte-fr-soft-algorithm.h.
Referenced by DoGetTpc(), and GetTypeId().
|
private |
Definition at line 123 of file lte-fr-soft-algorithm.h.
Referenced by DoReportUeMeas(), and GetTypeId().
|
private |
Definition at line 108 of file lte-fr-soft-algorithm.h.
Referenced by DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().
|
private |
Definition at line 100 of file lte-fr-soft-algorithm.h.
Referenced by GetTypeId(), InitializeDownlinkRbgMaps(), and SetDownlinkConfiguration().
|
private |
Definition at line 99 of file lte-fr-soft-algorithm.h.
Referenced by GetTypeId(), InitializeDownlinkRbgMaps(), and SetDownlinkConfiguration().
|
private |
Definition at line 105 of file lte-fr-soft-algorithm.h.
Referenced by DoGetAvailableDlRbg(), and InitializeDownlinkRbgMaps().
|
private |
Definition at line 127 of file lte-fr-soft-algorithm.h.
Referenced by DoGetTpc(), and GetTypeId().
|
private |
Definition at line 124 of file lte-fr-soft-algorithm.h.
Referenced by DoReportUeMeas(), and GetTypeId().
|
private |
Definition at line 121 of file lte-fr-soft-algorithm.h.
Referenced by DoReportUeMeas(), and GetTypeId().
|
private |
Definition at line 119 of file lte-fr-soft-algorithm.h.
|
private |
Definition at line 95 of file lte-fr-soft-algorithm.h.
Referenced by DoDispose(), GetLteFfrRrcSapProvider(), and LteFrSoftAlgorithm().
|
private |
Definition at line 94 of file lte-fr-soft-algorithm.h.
Referenced by DoInitialize(), DoReportUeMeas(), and SetLteFfrRrcSapUser().
|
private |
Definition at line 91 of file lte-fr-soft-algorithm.h.
Referenced by DoDispose(), GetLteFfrSapProvider(), and LteFrSoftAlgorithm().
|
private |
Definition at line 90 of file lte-fr-soft-algorithm.h.
Referenced by SetLteFfrSapUser().
|
private |
Definition at line 97 of file lte-fr-soft-algorithm.h.
Referenced by DoIsDlRbgAvailableForUe(), DoIsUlRbgAvailableForUe(), and GetTypeId().
|
private |
Definition at line 130 of file lte-fr-soft-algorithm.h.
Referenced by DoInitialize(), and DoReportUeMeas().
|
private |
Definition at line 118 of file lte-fr-soft-algorithm.h.
Referenced by DoGetTpc(), DoIsDlRbgAvailableForUe(), DoIsUlRbgAvailableForUe(), and DoReportUeMeas().
|
private |
Definition at line 109 of file lte-fr-soft-algorithm.h.
Referenced by DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().
|
private |
Definition at line 103 of file lte-fr-soft-algorithm.h.
Referenced by DoGetMinContinuousUlBandwidth(), GetTypeId(), InitializeUplinkRbgMaps(), and SetUplinkConfiguration().
|
private |
Definition at line 102 of file lte-fr-soft-algorithm.h.
Referenced by DoGetMinContinuousUlBandwidth(), GetTypeId(), InitializeUplinkRbgMaps(), and SetUplinkConfiguration().
|
private |
Definition at line 106 of file lte-fr-soft-algorithm.h.
Referenced by DoGetAvailableUlRbg(), and InitializeUplinkRbgMaps().