Simple Frequency Reuse algorithm implementation which uses only 1 sub-band. More...
#include "lte-ffr-simple.h"
Public Types | |
typedef void(* | PdschTracedCallback) (uint16_t rnti, uint8_t pdschPa) |
TracedCallback signature for change of PdschConfigDedicated. More... | |
Public Member Functions | |
LteFfrSimple () | |
Creates a trivial ffr algorithm instance. More... | |
virtual | ~LteFfrSimple () |
void | ChangePdschConfigDedicated (bool change) |
Callback function that is used to be connected to trace ChangePdschConfigDedicated. More... | |
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... | |
void | SetPdschConfigDedicated (LteRrcSap::PdschConfigDedicated pdschConfigDedicated) |
Set PDSCH config dedicated function. More... | |
void | SetTpc (uint32_t tpc, uint32_t num, bool acculumatedMode) |
Set transmission power control. 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 ¶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... | |
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 Member Functions | |
void | UpdatePdschConfigDedicated () |
Update PDSCH config dedicated function. More... | |
Private Attributes | |
bool | m_accumulatedMode |
whether to use the TPC accumulated mode More... | |
bool | m_changePdschConfigDedicated |
PDSCH config dedicate changed? More... | |
TracedCallback< uint16_t, uint8_t > | m_changePdschConfigDedicatedTrace |
PDSCH config dedicated change trace callback. More... | |
uint8_t | m_dlOffset |
DL offset. More... | |
std::vector< bool > | m_dlRbgMap |
DL RBG map. More... | |
uint8_t | m_dlSubBand |
DL subband. 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 |
measure ID More... | |
LteRrcSap::PdschConfigDedicated | m_pdschConfigDedicated |
PDSCH config dedicated. More... | |
uint32_t | m_tpc |
transmission power control to be used More... | |
uint32_t | m_tpcNum |
number of TPC configurations More... | |
std::map< uint16_t, LteRrcSap::PdschConfigDedicated > | m_ues |
UEs. More... | |
uint8_t | m_ulOffset |
UL offset. More... | |
std::vector< bool > | m_ulRbgMap |
UL RBG map. More... | |
uint8_t | m_ulSubBand |
UL subband. More... | |
Friends | |
class | MemberLteFfrRrcSapProvider< LteFfrSimple > |
let the forwarder class access the protected and private members More... | |
class | MemberLteFfrSapProvider< LteFfrSimple > |
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... | |
Simple Frequency Reuse algorithm implementation which uses only 1 sub-band.
Used to test Downlink Power Allocation. When Simple FR receives UE measurements it immediately call functions to change PdschConfigDedicated (i.e. P_A) value for this UE.
Definition at line 45 of file lte-ffr-simple.h.
typedef void(* ns3::LteFfrSimple::PdschTracedCallback) (uint16_t rnti, uint8_t pdschPa) |
TracedCallback signature for change of PdschConfigDedicated.
[in] | rnti | |
[in] | pdschPa | PdschConfiDedicated.pa |
Definition at line 98 of file lte-ffr-simple.h.
ns3::LteFfrSimple::LteFfrSimple | ( | ) |
Creates a trivial ffr algorithm instance.
Definition at line 33 of file lte-ffr-simple.cc.
References m_ffrRrcSapProvider, m_ffrSapProvider, MemberLteFfrRrcSapProvider< LteFfrSimple >, MemberLteFfrSapProvider< LteFfrSimple >, and NS_LOG_FUNCTION.
|
virtual |
Definition at line 52 of file lte-ffr-simple.cc.
References NS_LOG_FUNCTION.
void ns3::LteFfrSimple::ChangePdschConfigDedicated | ( | bool | change | ) |
Callback function that is used to be connected to trace ChangePdschConfigDedicated.
change | trace fired upon change of PdschConfigDedicated if true |
Definition at line 159 of file lte-ffr-simple.cc.
References m_changePdschConfigDedicated.
Referenced by LteCqiGenerationDlPowerControlTestCase::DoRun(), LteDownlinkPowerControlTestCase::DoRun(), and LteDownlinkPowerControlRrcConnectionReconfigurationTestCase::DoRun().
|
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 59 of file lte-ffr-simple.cc.
References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.
|
protectedvirtual |
Implementation of LteFfrSapProvider::GetAvailableDlRbg.
Implements ns3::LteFfrAlgorithm.
Definition at line 179 of file lte-ffr-simple.cc.
References ns3::LteFfrAlgorithm::GetRbgSize(), ns3::LteFfrAlgorithm::m_dlBandwidth, m_dlOffset, m_dlRbgMap, m_dlSubBand, and NS_LOG_FUNCTION.
|
protectedvirtual |
Implementation of LteFfrSapProvider::GetAvailableUlRbg.
Implements ns3::LteFfrAlgorithm.
Definition at line 206 of file lte-ffr-simple.cc.
References ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulOffset, m_ulRbgMap, m_ulSubBand, and NS_LOG_FUNCTION.
|
protectedvirtual |
DoGetMinContinuousUlBandwidth in number of RB.
Implements ns3::LteFfrAlgorithm.
Definition at line 274 of file lte-ffr-simple.cc.
References ns3::LteFfrAlgorithm::m_ulBandwidth, and NS_LOG_FUNCTION.
|
protectedvirtual |
DoGetTpc for UE.
rnti |
Implements ns3::LteFfrAlgorithm.
Definition at line 249 of file lte-ffr-simple.cc.
References m_accumulatedMode, m_tpc, m_tpcNum, and NS_LOG_FUNCTION.
|
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 134 of file lte-ffr-simple.cc.
References ns3::LteFfrRrcSapUser::AddUeMeasReportConfigForFfr(), ns3::LteRrcSap::ThresholdEutra::choice, ns3::LteRrcSap::PdschConfigDedicated::dB0, ns3::Object::DoInitialize(), ns3::LteRrcSap::ReportConfigEutra::EVENT_A1, ns3::LteRrcSap::ReportConfigEutra::eventId, m_ffrRrcSapUser, m_measId, m_pdschConfigDedicated, ns3::LteRrcSap::ReportConfigEutra::MS120, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::LteRrcSap::PdschConfigDedicated::pa, ns3::LteRrcSap::ThresholdEutra::range, ns3::LteRrcSap::ReportConfigEutra::reportInterval, ns3::LteRrcSap::ReportConfigEutra::RSRQ, 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 199 of file lte-ffr-simple.cc.
References 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 224 of file lte-ffr-simple.cc.
References NS_LOG_FUNCTION.
|
protectedvirtual |
DoRecvLoadInformation.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 322 of file lte-ffr-simple.cc.
References NS_LOG_FUNCTION.
|
protectedvirtual |
DoReportDlCqiInfo.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 231 of file lte-ffr-simple.cc.
References NS_LOG_FUNCTION.
|
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 281 of file lte-ffr-simple.cc.
References ns3::LteRrcSap::PdschConfigDedicated::dB0, m_changePdschConfigDedicated, m_ues, ns3::LteRrcSap::MeasResults::measId, NS_LOG_FUNCTION, ns3::LteRrcSap::PdschConfigDedicated::pa, and UpdatePdschConfigDedicated().
|
protectedvirtual |
DoReportUlCqiInfo.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 237 of file lte-ffr-simple.cc.
References NS_LOG_FUNCTION.
|
protectedvirtual |
DoReportUlCqiInfo.
ulCqiMap |
Implements ns3::LteFfrAlgorithm.
Definition at line 243 of file lte-ffr-simple.cc.
References NS_LOG_FUNCTION.
|
virtual |
Export the "provider" part of the LteFfrRrcSap interface.
Implements ns3::LteFfrAlgorithm.
Definition at line 126 of file lte-ffr-simple.cc.
References m_ffrRrcSapProvider, and NS_LOG_FUNCTION.
|
virtual |
Export the "provider" part of the LteFfrSap interface.
Implements ns3::LteFfrAlgorithm.
Definition at line 111 of file lte-ffr-simple.cc.
References m_ffrSapProvider, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 68 of file lte-ffr-simple.cc.
References m_changePdschConfigDedicatedTrace, m_dlOffset, m_dlSubBand, m_ulOffset, m_ulSubBand, ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().
|
protectedvirtual |
Automatic FR reconfiguration.
Implements ns3::LteFfrAlgorithm.
Definition at line 153 of file lte-ffr-simple.cc.
References NS_LOG_FUNCTION.
|
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 118 of file lte-ffr-simple.cc.
References m_ffrRrcSapUser, and NS_LOG_FUNCTION.
|
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 103 of file lte-ffr-simple.cc.
References m_ffrSapUser, and NS_LOG_FUNCTION.
void ns3::LteFfrSimple::SetPdschConfigDedicated | ( | LteRrcSap::PdschConfigDedicated | pdschConfigDedicated | ) |
Set PDSCH config dedicated function.
pdschConfigDedicated | LteRrcSap::PdschConfigDedicated object |
Definition at line 165 of file lte-ffr-simple.cc.
References m_pdschConfigDedicated.
Referenced by LteCqiGenerationDlPowerControlTestCase::DoRun(), LteDownlinkPowerControlTestCase::DoRun(), and LteDownlinkPowerControlRrcConnectionReconfigurationTestCase::DoRun().
void ns3::LteFfrSimple::SetTpc | ( | uint32_t | tpc, |
uint32_t | num, | ||
bool | acculumatedMode | ||
) |
Set transmission power control.
tpc | TPC |
num | number of TPC configurations in the test case |
acculumatedMode | whether TPC accumulated mode is used |
Definition at line 171 of file lte-ffr-simple.cc.
References m_accumulatedMode, m_tpc, and m_tpcNum.
Referenced by LteUplinkPowerControlTestCase::SetTpcConfiguration().
|
private |
Update PDSCH config dedicated function.
Definition at line 305 of file lte-ffr-simple.cc.
References m_changePdschConfigDedicatedTrace, m_ffrRrcSapUser, m_pdschConfigDedicated, m_ues, NS_LOG_FUNCTION, ns3::LteRrcSap::PdschConfigDedicated::pa, and ns3::LteFfrRrcSapUser::SetPdschConfigDedicated().
Referenced by DoReportUeMeas().
|
friend |
let the forwarder class access the protected and private members
Definition at line 85 of file lte-ffr-simple.h.
Referenced by LteFfrSimple().
|
friend |
let the forwarder class access the protected and private members
Definition at line 85 of file lte-ffr-simple.h.
Referenced by LteFfrSimple().
|
private |
whether to use the TPC accumulated mode
Definition at line 159 of file lte-ffr-simple.h.
Referenced by DoGetTpc(), and SetTpc().
|
private |
PDSCH config dedicate changed?
Definition at line 149 of file lte-ffr-simple.h.
Referenced by ChangePdschConfigDedicated(), and DoReportUeMeas().
|
private |
PDSCH config dedicated change trace callback.
Definition at line 153 of file lte-ffr-simple.h.
Referenced by GetTypeId(), and UpdatePdschConfigDedicated().
|
private |
DL offset.
Definition at line 135 of file lte-ffr-simple.h.
Referenced by DoGetAvailableDlRbg(), and GetTypeId().
|
private |
|
private |
DL subband.
Definition at line 136 of file lte-ffr-simple.h.
Referenced by DoGetAvailableDlRbg(), and GetTypeId().
|
private |
FFR RRC SAP provider.
Definition at line 133 of file lte-ffr-simple.h.
Referenced by LteFfrSimple(), DoDispose(), and GetLteFfrRrcSapProvider().
|
private |
FFR RRC SAP user.
Definition at line 132 of file lte-ffr-simple.h.
Referenced by DoInitialize(), SetLteFfrRrcSapUser(), and UpdatePdschConfigDedicated().
|
private |
FFR SAP provider.
Definition at line 129 of file lte-ffr-simple.h.
Referenced by LteFfrSimple(), DoDispose(), and GetLteFfrSapProvider().
|
private |
|
private |
|
private |
PDSCH config dedicated.
Definition at line 151 of file lte-ffr-simple.h.
Referenced by DoInitialize(), SetPdschConfigDedicated(), and UpdatePdschConfigDedicated().
|
private |
transmission power control to be used
Definition at line 157 of file lte-ffr-simple.h.
Referenced by DoGetTpc(), and SetTpc().
|
private |
number of TPC configurations
Definition at line 158 of file lte-ffr-simple.h.
Referenced by DoGetTpc(), and SetTpc().
|
private |
UEs.
Definition at line 144 of file lte-ffr-simple.h.
Referenced by DoReportUeMeas(), and UpdatePdschConfigDedicated().
|
private |
UL offset.
Definition at line 138 of file lte-ffr-simple.h.
Referenced by DoGetAvailableUlRbg(), and GetTypeId().
|
private |
|
private |
UL subband.
Definition at line 139 of file lte-ffr-simple.h.
Referenced by DoGetAvailableUlRbg(), and GetTypeId().