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... | |
virtual | ~LteFrNoOpAlgorithm () |
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 () | |
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<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... | |
bool | IsInitialized (void) const |
Check if the object has been initialized. More... | |
![]() | |
SimpleRefCount () | |
Default 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 operator. 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 |
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 TypeId | GetTypeId () |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
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 ¶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) | |
Copy an Object. More... | |
virtual void | NotifyNewAggregate (void) |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
![]() | |
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 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 | |
![]() | |
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... | |
![]() | |
static TypeId | GetObjectIid (void) |
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.
ns3::LteFrNoOpAlgorithm is accessible through the following paths with Config::Set and Config::Connect:
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 72 bytes (on a 64-bit architecture).
Definition at line 42 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, and NS_LOG_FUNCTION.
|
virtual |
Definition at line 41 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION.
|
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 48 of file lte-fr-no-op-algorithm.cc.
References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.
|
protectedvirtual |
Implementation of LteFfrSapProvider::GetAvailableDlRbg.
Implements ns3::LteFfrAlgorithm.
Definition at line 113 of file lte-fr-no-op-algorithm.cc.
References ns3::LteFfrAlgorithm::GetRbgSize(), ns3::LteFfrAlgorithm::m_dlBandwidth, and NS_LOG_FUNCTION.
|
protectedvirtual |
Implementation of LteFfrSapProvider::GetAvailableUlRbg.
Implements ns3::LteFfrAlgorithm.
Definition at line 130 of file lte-fr-no-op-algorithm.cc.
References ns3::LteFfrAlgorithm::m_ulBandwidth, and NS_LOG_FUNCTION.
|
protectedvirtual |
DoGetMinContinuousUlBandwidth in number of RB.
Implements ns3::LteFfrAlgorithm.
Definition at line 174 of file lte-fr-no-op-algorithm.cc.
References ns3::LteFfrAlgorithm::m_ulBandwidth, and NS_LOG_FUNCTION.
|
protectedvirtual |
DoGetTpc for UE.
rnti |
Implements ns3::LteFfrAlgorithm.
Definition at line 167 of file lte-fr-no-op-algorithm.cc.
References 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 100 of file lte-fr-no-op-algorithm.cc.
References ns3::Object::DoInitialize(), and NS_LOG_FUNCTION.
|
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 123 of file lte-fr-no-op-algorithm.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 139 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION.
|
protectedvirtual |
DoRecvLoadInformation.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 189 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION, and NS_LOG_WARN.
|
protectedvirtual |
DoReportDlCqiInfo.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 146 of file lte-fr-no-op-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 181 of file lte-fr-no-op-algorithm.cc.
References ns3::LteRrcSap::MeasResults::measId, NS_LOG_FUNCTION, and NS_LOG_WARN.
|
protectedvirtual |
DoReportUlCqiInfo.
params |
Implements ns3::LteFfrAlgorithm.
Definition at line 153 of file lte-fr-no-op-algorithm.cc.
References NS_LOG_FUNCTION, and NS_LOG_WARN.
|
protectedvirtual |
DoReportUlCqiInfo.
ulCqiMap |
Implements ns3::LteFfrAlgorithm.
Definition at line 160 of file lte-fr-no-op-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 92 of file lte-fr-no-op-algorithm.cc.
References m_ffrRrcSapProvider, and NS_LOG_FUNCTION.
|
virtual |
Export the "provider" part of the LteFfrSap interface.
Implements ns3::LteFfrAlgorithm.
Definition at line 77 of file lte-fr-no-op-algorithm.cc.
References m_ffrSapProvider, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 57 of file lte-fr-no-op-algorithm.cc.
References ns3::TypeId::SetParent().
|
protectedvirtual |
Automatic FR reconfiguration.
Implements ns3::LteFfrAlgorithm.
Definition at line 107 of file lte-fr-no-op-algorithm.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 84 of file lte-fr-no-op-algorithm.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 69 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 68 of file lte-fr-no-op-algorithm.h.
|
friend |
let the forwarder class access the protected and private members
Definition at line 66 of file lte-fr-no-op-algorithm.h.
|
private |
FFR RRC SAP provider.
Definition at line 99 of file lte-fr-no-op-algorithm.h.
Referenced by DoDispose(), GetLteFfrRrcSapProvider(), and LteFrNoOpAlgorithm().
|
private |
FFR RRC SAP user.
Definition at line 98 of file lte-fr-no-op-algorithm.h.
Referenced by SetLteFfrRrcSapUser().
|
private |
FFR SAP provider.
Definition at line 95 of file lte-fr-no-op-algorithm.h.
Referenced by DoDispose(), GetLteFfrSapProvider(), and LteFrNoOpAlgorithm().
|
private |
FFR SAP user.
Definition at line 94 of file lte-fr-no-op-algorithm.h.
Referenced by SetLteFfrSapUser().