FR algorithm implementation which simply does nothing. More...
#include "lte-fr-no-op-algorithm.h"
Public Member Functions | |
LteFrNoOpAlgorithm () | |
Creates a NoOP FR algorithm instance. More... | |
~LteFrNoOpAlgorithm () override | |
LteFfrRrcSapProvider * | GetLteFfrRrcSapProvider () override |
Export the "provider" part of the LteFfrRrcSap interface. More... | |
LteFfrSapProvider * | GetLteFfrSapProvider () override |
Export the "provider" part of the LteFfrSap interface. More... | |
void | SetLteFfrRrcSapUser (LteFfrRrcSapUser *s) override |
Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will interact with. More... | |
void | SetLteFfrSapUser (LteFfrSapUser *s) override |
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 () | |
~LteFfrAlgorithm () override | |
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... | |
~Object () override | |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose () |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated 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... | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized () 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 () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () 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 errors. 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 () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. More... | |
std::vector< bool > | DoGetAvailableDlRbg () override |
Implementation of LteFfrSapProvider::GetAvailableDlRbg. More... | |
std::vector< bool > | DoGetAvailableUlRbg () override |
Implementation of LteFfrSapProvider::GetAvailableUlRbg. More... | |
uint16_t | DoGetMinContinuousUlBandwidth () override |
DoGetMinContinuousUlBandwidth in number of RB. More... | |
uint8_t | DoGetTpc (uint16_t rnti) override |
DoGetTpc for UE. More... | |
void | DoInitialize () override |
Initialize() implementation. More... | |
bool | DoIsDlRbgAvailableForUe (int i, uint16_t rnti) override |
Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe. More... | |
bool | DoIsUlRbgAvailableForUe (int i, uint16_t rnti) override |
Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe. More... | |
void | DoRecvLoadInformation (EpcX2Sap::LoadInformationParams params) override |
DoRecvLoadInformation. More... | |
void | DoReportDlCqiInfo (const FfMacSchedSapProvider::SchedDlCqiInfoReqParameters ¶ms) override |
DoReportDlCqiInfo. More... | |
void | DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults) override |
Implementation of LteFfrRrcSapProvider::ReportUeMeas. More... | |
void | DoReportUlCqiInfo (const FfMacSchedSapProvider::SchedUlCqiInfoReqParameters ¶ms) override |
DoReportUlCqiInfo. More... | |
void | DoReportUlCqiInfo (std::map< uint16_t, std::vector< double >> ulCqiMap) override |
DoReportUlCqiInfo. More... | |
void | Reconfigure () override |
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 () |
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 () |
Notifier called once the ObjectBase is fully constructed. More... | |
Private Attributes | |
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... | |
Friends | |
class | MemberLteFfrRrcSapProvider< LteFrNoOpAlgorithm > |
let the forwarder class access the protected and private members More... | |
class | MemberLteFfrSapProvider< LteFrNoOpAlgorithm > |
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 () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
FR algorithm implementation which simply does nothing.
Selecting this FR algorithm is equivalent to disabling FFR. This is the default choice.
To enable FR, please select another FR algorithm, i.e., another child class of LteFfrAlgorithm.
Definition at line 41 of file lte-fr-no-op-algorithm.h.
ns3::LteFrNoOpAlgorithm::LteFrNoOpAlgorithm | ( | ) |
Creates a NoOP FR algorithm instance.
Definition at line 32 of file lte-fr-no-op-algorithm.cc.
References m_ffrRrcSapProvider, m_ffrSapProvider, MemberLteFfrRrcSapProvider< LteFrNoOpAlgorithm >, MemberLteFfrSapProvider< LteFrNoOpAlgorithm >, and NS_LOG_FUNCTION.
|
override |
Definition at line 41 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
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 47 of file lte-fr-no-op-algorithm.cc.
References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
Implementation of LteFfrSapProvider::GetAvailableDlRbg.
Implements ns3::LteFfrAlgorithm.
Definition at line 106 of file lte-fr-no-op-algorithm.cc.
References ns3::LteFfrAlgorithm::GetRbgSize(), ns3::LteFfrAlgorithm::m_dlBandwidth, and NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
Implementation of LteFfrSapProvider::GetAvailableUlRbg.
Implements ns3::LteFfrAlgorithm.
Definition at line 123 of file lte-fr-no-op-algorithm.cc.
References ns3::LteFfrAlgorithm::m_ulBandwidth, and NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
DoGetMinContinuousUlBandwidth in number of RB.
Implements ns3::LteFfrAlgorithm.
Definition at line 170 of file lte-fr-no-op-algorithm.cc.
References ns3::LteFfrAlgorithm::m_ulBandwidth, and NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
DoGetTpc for UE.
rnti |
Implements ns3::LteFfrAlgorithm.
Definition at line 162 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
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 93 of file lte-fr-no-op-algorithm.cc.
References ns3::Object::DoInitialize(), and NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
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 116 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
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 132 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
DoRecvLoadInformation.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 184 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION, and NS_LOG_WARN.
|
overrideprotectedvirtual |
DoReportDlCqiInfo.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 139 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION, and NS_LOG_WARN.
|
overrideprotectedvirtual |
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 177 of file lte-fr-no-op-algorithm.cc.
References ns3::LteRrcSap::MeasResults::measId, NS_LOG_FUNCTION, and NS_LOG_WARN.
|
overrideprotectedvirtual |
DoReportUlCqiInfo.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 147 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION, and NS_LOG_WARN.
|
overrideprotectedvirtual |
DoReportUlCqiInfo.
ulCqiMap |
Implements ns3::LteFfrAlgorithm.
Definition at line 155 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION, and NS_LOG_WARN.
|
overridevirtual |
Export the "provider" part of the LteFfrRrcSap interface.
Implements ns3::LteFfrAlgorithm.
Definition at line 86 of file lte-fr-no-op-algorithm.cc.
References m_ffrRrcSapProvider, and NS_LOG_FUNCTION.
|
overridevirtual |
Export the "provider" part of the LteFfrSap interface.
Implements ns3::LteFfrAlgorithm.
Definition at line 72 of file lte-fr-no-op-algorithm.cc.
References m_ffrSapProvider, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 55 of file lte-fr-no-op-algorithm.cc.
References ns3::TypeId::SetParent().
|
overrideprotectedvirtual |
Automatic FR reconfiguration.
Implements ns3::LteFfrAlgorithm.
Definition at line 100 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
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 79 of file lte-fr-no-op-algorithm.cc.
References m_ffrRrcSapUser, and NS_LOG_FUNCTION.
|
overridevirtual |
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 65 of file lte-fr-no-op-algorithm.cc.
References m_ffrSapUser, and NS_LOG_FUNCTION.
|
friend |
let the forwarder class access the protected and private members
Definition at line 62 of file lte-fr-no-op-algorithm.h.
Referenced by LteFrNoOpAlgorithm().
|
friend |
let the forwarder class access the protected and private members
Definition at line 62 of file lte-fr-no-op-algorithm.h.
Referenced by LteFrNoOpAlgorithm().
|
private |
FFR RRC SAP provider.
Definition at line 100 of file lte-fr-no-op-algorithm.h.
Referenced by LteFrNoOpAlgorithm(), DoDispose(), and GetLteFfrRrcSapProvider().
|
private |
FFR RRC SAP user.
Definition at line 99 of file lte-fr-no-op-algorithm.h.
Referenced by SetLteFfrRrcSapUser().
|
private |
FFR SAP provider.
Definition at line 96 of file lte-fr-no-op-algorithm.h.
Referenced by LteFrNoOpAlgorithm(), DoDispose(), and GetLteFfrSapProvider().
|
private |
FFR SAP user.
Definition at line 95 of file lte-fr-no-op-algorithm.h.
Referenced by SetLteFfrSapUser().