A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ns3::LteFfrAlgorithm Class Referenceabstract

The abstract base class of a Frequency Reuse algorithm. More...

#include "lte-ffr-algorithm.h"

+ Inheritance diagram for ns3::LteFfrAlgorithm:
+ Collaboration diagram for ns3::LteFfrAlgorithm:

Public Member Functions

 LteFfrAlgorithm ()
 
 ~LteFfrAlgorithm () override
 
uint16_t GetDlBandwidth () const
 
uint8_t GetFrCellTypeId () const
 
virtual LteFfrRrcSapProvider * GetLteFfrRrcSapProvider ()=0
 Export the "provider" part of the LteFfrRrcSap interface.
 
virtual LteFfrSapProvider * GetLteFfrSapProvider ()=0
 Export the "provider" part of the LteFfrSap interface.
 
uint16_t GetUlBandwidth () const
 
void SetDlBandwidth (uint16_t bw)
 
void SetFrCellTypeId (uint8_t cellTypeId)
 
virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser *s)=0
 Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will interact with.
 
virtual void SetLteFfrSapUser (LteFfrSapUser *s)=0
 Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will interact with.
 
void SetUlBandwidth (uint16_t bw)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< Object > GetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Protected Member Functions

void DoDispose () override
 Destructor implementation.
 
virtual std::vector< bool > DoGetAvailableDlRbg ()=0
 Implementation of LteFfrSapProvider::GetAvailableDlRbg.
 
virtual std::vector< bool > DoGetAvailableUlRbg ()=0
 Implementation of LteFfrSapProvider::GetAvailableUlRbg.
 
virtual uint16_t DoGetMinContinuousUlBandwidth ()=0
 DoGetMinContinuousUlBandwidth in number of RB.
 
virtual uint8_t DoGetTpc (uint16_t rnti)=0
 DoGetTpc for UE.
 
virtual bool DoIsDlRbgAvailableForUe (int rbId, uint16_t rnti)=0
 Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.
 
virtual bool DoIsUlRbgAvailableForUe (int rbId, uint16_t rnti)=0
 Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.
 
virtual void DoRecvLoadInformation (EpcX2Sap::LoadInformationParams params)=0
 DoRecvLoadInformation.
 
virtual void DoReportDlCqiInfo (const FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)=0
 DoReportDlCqiInfo.
 
virtual void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults)=0
 Implementation of LteFfrRrcSapProvider::ReportUeMeas.
 
virtual void DoReportUlCqiInfo (const FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)=0
 DoReportUlCqiInfo.
 
virtual void DoReportUlCqiInfo (std::map< uint16_t, std::vector< double > > ulCqiMap)=0
 DoReportUlCqiInfo.
 
virtual void DoSetBandwidth (uint16_t ulBandwidth, uint16_t dlBandwidth)
 Implementation of LteFfrRrcSapProvider::SetBandwidth.
 
virtual void DoSetCellId (uint16_t cellId)
 SetCellId.
 
int GetRbgSize (int dlbandwidth)
 Get RBG size for DL Bandwidth according to table 7.1.6.1-1 of 36.213.
 
virtual void Reconfigure ()=0
 Automatic FR reconfiguration.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Protected Attributes

uint16_t m_cellId
 cell ID
 
uint8_t m_dlBandwidth
 downlink bandwidth in RBs
 
bool m_enabledInUplink
 If true FR algorithm will also work in Uplink.
 
uint8_t m_frCellTypeId
 FFR cell type ID for automatic configuration.
 
bool m_needReconfiguration
 If true FR algorithm will be reconfigured.
 
uint8_t m_ulBandwidth
 uplink bandwidth in RBs
 

Additional Inherited Members

- Related Symbols inherited from ns3::ObjectBase
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.
 

Detailed Description

The abstract base class of a Frequency Reuse algorithm.

Generally Frequency reuse algorithm tells the Scheduler which RB can be allocated and which can not. FR policy depend on its implementation.

The communication with the eNodeB MAC Scheduler instance is done through the LteFfrSap interface. The frequency reuse algorithm instance corresponds to the "provider" part of this interface, while the eNodeB MAC Scheduler instance takes the role of the "user" part.

The communication with the eNodeB RRC instance is done through the LteFfrRrcSap interface. The frequency reuse algorithm instance corresponds to the "provider" part of this interface, while the eNodeB RRC instance takes the role of the "user" part.

Definition at line 48 of file lte-ffr-algorithm.h.

Constructor & Destructor Documentation

◆ LteFfrAlgorithm()

ns3::LteFfrAlgorithm::LteFfrAlgorithm ( )

Definition at line 31 of file lte-ffr-algorithm.cc.

◆ ~LteFfrAlgorithm()

ns3::LteFfrAlgorithm::~LteFfrAlgorithm ( )
override

Definition at line 36 of file lte-ffr-algorithm.cc.

Member Function Documentation

◆ DoDispose()

void ns3::LteFfrAlgorithm::DoDispose ( )
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::Object.

Reimplemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

Definition at line 65 of file lte-ffr-algorithm.cc.

References NS_LOG_FUNCTION.

◆ DoGetAvailableDlRbg()

virtual std::vector< bool > ns3::LteFfrAlgorithm::DoGetAvailableDlRbg ( )
protectedpure virtual

Implementation of LteFfrSapProvider::GetAvailableDlRbg.

Returns
vector of size (m_dlBandwidth/RbgSize); false indicates that RBG is free to use, true otherwise

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoGetAvailableUlRbg()

virtual std::vector< bool > ns3::LteFfrAlgorithm::DoGetAvailableUlRbg ( )
protectedpure virtual

Implementation of LteFfrSapProvider::GetAvailableUlRbg.

Returns
vector of size m_ulBandwidth; false indicates that RB is free to use, true otherwise

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoGetMinContinuousUlBandwidth()

virtual uint16_t ns3::LteFfrAlgorithm::DoGetMinContinuousUlBandwidth ( )
protectedpure virtual

DoGetMinContinuousUlBandwidth in number of RB.

Returns
number of RB in min continuous UL Bandwidth

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoGetTpc()

virtual uint8_t ns3::LteFfrAlgorithm::DoGetTpc ( uint16_t rnti)
protectedpure virtual

DoGetTpc for UE.

Parameters
rnti
Returns
TPC value

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoIsDlRbgAvailableForUe()

virtual bool ns3::LteFfrAlgorithm::DoIsDlRbgAvailableForUe ( int rbId,
uint16_t rnti )
protectedpure virtual

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

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoIsUlRbgAvailableForUe()

virtual bool ns3::LteFfrAlgorithm::DoIsUlRbgAvailableForUe ( int rbId,
uint16_t rnti )
protectedpure virtual

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

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoRecvLoadInformation()

virtual void ns3::LteFfrAlgorithm::DoRecvLoadInformation ( EpcX2Sap::LoadInformationParams params)
protectedpure virtual

DoRecvLoadInformation.

Parameters
params

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoReportDlCqiInfo()

virtual void ns3::LteFfrAlgorithm::DoReportDlCqiInfo ( const FfMacSchedSapProvider::SchedDlCqiInfoReqParameters & params)
protectedpure virtual

DoReportDlCqiInfo.

Parameters
params

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoReportUeMeas()

virtual void ns3::LteFfrAlgorithm::DoReportUeMeas ( uint16_t rnti,
LteRrcSap::MeasResults measResults )
protectedpure virtual

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

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoReportUlCqiInfo() [1/2]

virtual void ns3::LteFfrAlgorithm::DoReportUlCqiInfo ( const FfMacSchedSapProvider::SchedUlCqiInfoReqParameters & params)
protectedpure virtual

DoReportUlCqiInfo.

Parameters
params

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoReportUlCqiInfo() [2/2]

virtual void ns3::LteFfrAlgorithm::DoReportUlCqiInfo ( std::map< uint16_t, std::vector< double > > ulCqiMap)
protectedpure virtual

DoReportUlCqiInfo.

Parameters
ulCqiMap

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ DoSetBandwidth()

void ns3::LteFfrAlgorithm::DoSetBandwidth ( uint16_t ulBandwidth,
uint16_t dlBandwidth )
protectedvirtual

Implementation of LteFfrRrcSapProvider::SetBandwidth.

Parameters
ulBandwidthUL bandwidth in number of RB
dlBandwidthDL bandwidth in number of RB

Definition at line 163 of file lte-ffr-algorithm.cc.

References NS_LOG_FUNCTION, SetDlBandwidth(), and SetUlBandwidth().

+ Here is the call graph for this function:

◆ DoSetCellId()

void ns3::LteFfrAlgorithm::DoSetCellId ( uint16_t cellId)
protectedvirtual

SetCellId.

Parameters
cellIdthe Cell Identifier

Definition at line 156 of file lte-ffr-algorithm.cc.

References m_cellId, and NS_LOG_FUNCTION.

◆ GetDlBandwidth()

uint16_t ns3::LteFfrAlgorithm::GetDlBandwidth ( ) const
Returns
the downlink bandwidth in RBs

Definition at line 99 of file lte-ffr-algorithm.cc.

References m_dlBandwidth, and NS_LOG_FUNCTION.

◆ GetFrCellTypeId()

uint8_t ns3::LteFfrAlgorithm::GetFrCellTypeId ( ) const
Returns
cellTypeId which is used for automatic FR configuration

Definition at line 135 of file lte-ffr-algorithm.cc.

References m_frCellTypeId, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetLteFfrRrcSapProvider()

virtual LteFfrRrcSapProvider * ns3::LteFfrAlgorithm::GetLteFfrRrcSapProvider ( )
pure 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

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ GetLteFfrSapProvider()

virtual LteFfrSapProvider * ns3::LteFfrAlgorithm::GetLteFfrSapProvider ( )
pure 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

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ GetRbgSize()

int ns3::LteFfrAlgorithm::GetRbgSize ( int dlbandwidth)
protected

Get RBG size for DL Bandwidth according to table 7.1.6.1-1 of 36.213.

Parameters
dlbandwidth
Returns
size of RBG in number of RB

Definition at line 142 of file lte-ffr-algorithm.cc.

References ns3::Type0AllocationRbg.

Referenced by ns3::LteFfrDistributedAlgorithm::Calculate(), ns3::LteFfrSimple::DoGetAvailableDlRbg(), ns3::LteFrNoOpAlgorithm::DoGetAvailableDlRbg(), ns3::LteFfrDistributedAlgorithm::DoInitialize(), ns3::LteFfrEnhancedAlgorithm::DoReportDlCqiInfo(), ns3::LteFfrDistributedAlgorithm::InitializeDownlinkRbgMaps(), ns3::LteFfrEnhancedAlgorithm::InitializeDownlinkRbgMaps(), ns3::LteFfrSoftAlgorithm::InitializeDownlinkRbgMaps(), ns3::LteFrHardAlgorithm::InitializeDownlinkRbgMaps(), ns3::LteFrSoftAlgorithm::InitializeDownlinkRbgMaps(), and ns3::LteFrStrictAlgorithm::InitializeDownlinkRbgMaps().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::LteFfrAlgorithm::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 41 of file lte-ffr-algorithm.cc.

References GetFrCellTypeId(), m_enabledInUplink, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), SetFrCellTypeId(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetUlBandwidth()

uint16_t ns3::LteFfrAlgorithm::GetUlBandwidth ( ) const
Returns
the uplink bandwidth in RBs

Definition at line 71 of file lte-ffr-algorithm.cc.

References m_ulBandwidth, and NS_LOG_FUNCTION.

◆ Reconfigure()

virtual void ns3::LteFfrAlgorithm::Reconfigure ( )
protectedpure virtual

Automatic FR reconfiguration.

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ SetDlBandwidth()

void ns3::LteFfrAlgorithm::SetDlBandwidth ( uint16_t bw)
Parameters
bwthe downlink bandwidth in RBs

Definition at line 106 of file lte-ffr-algorithm.cc.

References m_dlBandwidth, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by DoSetBandwidth().

+ Here is the caller graph for this function:

◆ SetFrCellTypeId()

void ns3::LteFfrAlgorithm::SetFrCellTypeId ( uint8_t cellTypeId)
Parameters
cellTypeIdfor automatic FR configuration

Definition at line 127 of file lte-ffr-algorithm.cc.

References m_frCellTypeId, m_needReconfiguration, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetLteFfrRrcSapUser()

virtual void ns3::LteFfrAlgorithm::SetLteFfrRrcSapUser ( LteFfrRrcSapUser * s)
pure 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

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ SetLteFfrSapUser()

virtual void ns3::LteFfrAlgorithm::SetLteFfrSapUser ( LteFfrSapUser * s)
pure 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

Implemented in ns3::LteFfrDistributedAlgorithm, ns3::LteFfrEnhancedAlgorithm, ns3::LteFfrSimple, ns3::LteFfrSoftAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrSoftAlgorithm, and ns3::LteFrStrictAlgorithm.

◆ SetUlBandwidth()

void ns3::LteFfrAlgorithm::SetUlBandwidth ( uint16_t bw)
Parameters
bwthe uplink bandwidth in RBs

Definition at line 78 of file lte-ffr-algorithm.cc.

References m_ulBandwidth, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by DoSetBandwidth().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_cellId

uint16_t ns3::LteFfrAlgorithm::m_cellId
protected

cell ID

Definition at line 236 of file lte-ffr-algorithm.h.

Referenced by ns3::LteFfrDistributedAlgorithm::Calculate(), ns3::LteFfrDistributedAlgorithm::DoRecvLoadInformation(), ns3::LteFfrDistributedAlgorithm::DoReportUeMeas(), DoSetCellId(), ns3::LteFfrDistributedAlgorithm::SendLoadInformation(), ns3::LteFrHardAlgorithm::SetDownlinkConfiguration(), and ns3::LteFrHardAlgorithm::SetUplinkConfiguration().

◆ m_dlBandwidth

uint8_t ns3::LteFfrAlgorithm::m_dlBandwidth
protected

downlink bandwidth in RBs

Definition at line 238 of file lte-ffr-algorithm.h.

Referenced by ns3::LteFfrDistributedAlgorithm::Calculate(), ns3::LteFfrSimple::DoGetAvailableDlRbg(), ns3::LteFrNoOpAlgorithm::DoGetAvailableDlRbg(), ns3::LteFfrDistributedAlgorithm::DoInitialize(), ns3::LteFfrEnhancedAlgorithm::DoInitialize(), ns3::LteFfrSoftAlgorithm::DoInitialize(), ns3::LteFrHardAlgorithm::DoInitialize(), ns3::LteFrSoftAlgorithm::DoInitialize(), ns3::LteFrStrictAlgorithm::DoInitialize(), ns3::LteFfrEnhancedAlgorithm::DoReportDlCqiInfo(), GetDlBandwidth(), ns3::LteFfrDistributedAlgorithm::InitializeDownlinkRbgMaps(), ns3::LteFfrEnhancedAlgorithm::InitializeDownlinkRbgMaps(), ns3::LteFfrSoftAlgorithm::InitializeDownlinkRbgMaps(), ns3::LteFrHardAlgorithm::InitializeDownlinkRbgMaps(), ns3::LteFrSoftAlgorithm::InitializeDownlinkRbgMaps(), ns3::LteFrStrictAlgorithm::InitializeDownlinkRbgMaps(), ns3::LteFrSoftAlgorithm::InitializeUplinkRbgMaps(), ns3::LteFfrDistributedAlgorithm::Reconfigure(), ns3::LteFfrEnhancedAlgorithm::Reconfigure(), ns3::LteFfrSoftAlgorithm::Reconfigure(), ns3::LteFrHardAlgorithm::Reconfigure(), ns3::LteFrSoftAlgorithm::Reconfigure(), ns3::LteFrStrictAlgorithm::Reconfigure(), SetDlBandwidth(), ns3::LteFfrEnhancedAlgorithm::SetDownlinkConfiguration(), ns3::LteFfrSoftAlgorithm::SetDownlinkConfiguration(), ns3::LteFrHardAlgorithm::SetDownlinkConfiguration(), ns3::LteFrSoftAlgorithm::SetDownlinkConfiguration(), and ns3::LteFrStrictAlgorithm::SetDownlinkConfiguration().

◆ m_enabledInUplink

bool ns3::LteFfrAlgorithm::m_enabledInUplink
protected

If true FR algorithm will also work in Uplink.

Definition at line 243 of file lte-ffr-algorithm.h.

Referenced by ns3::LteFfrEnhancedAlgorithm::DoGetAvailableUlRbg(), ns3::LteFfrDistributedAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFfrEnhancedAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFfrSoftAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFrHardAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFrSoftAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFrStrictAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFfrDistributedAlgorithm::DoGetTpc(), ns3::LteFfrEnhancedAlgorithm::DoGetTpc(), ns3::LteFfrSoftAlgorithm::DoGetTpc(), ns3::LteFrSoftAlgorithm::DoGetTpc(), ns3::LteFrStrictAlgorithm::DoGetTpc(), ns3::LteFfrDistributedAlgorithm::DoIsUlRbgAvailableForUe(), ns3::LteFfrEnhancedAlgorithm::DoIsUlRbgAvailableForUe(), ns3::LteFfrSoftAlgorithm::DoIsUlRbgAvailableForUe(), ns3::LteFrHardAlgorithm::DoIsUlRbgAvailableForUe(), ns3::LteFrSoftAlgorithm::DoIsUlRbgAvailableForUe(), ns3::LteFrStrictAlgorithm::DoIsUlRbgAvailableForUe(), GetTypeId(), ns3::LteFfrEnhancedAlgorithm::InitializeUplinkRbgMaps(), ns3::LteFrHardAlgorithm::InitializeUplinkRbgMaps(), and ns3::LteFrStrictAlgorithm::InitializeUplinkRbgMaps().

◆ m_frCellTypeId

uint8_t ns3::LteFfrAlgorithm::m_frCellTypeId
protected

FFR cell type ID for automatic configuration.

Definition at line 241 of file lte-ffr-algorithm.h.

Referenced by ns3::LteFfrDistributedAlgorithm::DoInitialize(), ns3::LteFfrEnhancedAlgorithm::DoInitialize(), ns3::LteFfrSoftAlgorithm::DoInitialize(), ns3::LteFrHardAlgorithm::DoInitialize(), ns3::LteFrSoftAlgorithm::DoInitialize(), ns3::LteFrStrictAlgorithm::DoInitialize(), GetFrCellTypeId(), ns3::LteFfrDistributedAlgorithm::Reconfigure(), ns3::LteFfrEnhancedAlgorithm::Reconfigure(), ns3::LteFfrSoftAlgorithm::Reconfigure(), ns3::LteFrHardAlgorithm::Reconfigure(), ns3::LteFrSoftAlgorithm::Reconfigure(), ns3::LteFrStrictAlgorithm::Reconfigure(), and SetFrCellTypeId().

◆ m_needReconfiguration

bool ns3::LteFfrAlgorithm::m_needReconfiguration
protected

If true FR algorithm will be reconfigured.

Definition at line 245 of file lte-ffr-algorithm.h.

Referenced by ns3::LteFfrDistributedAlgorithm::DoGetAvailableDlRbg(), ns3::LteFfrEnhancedAlgorithm::DoGetAvailableDlRbg(), ns3::LteFfrSoftAlgorithm::DoGetAvailableDlRbg(), ns3::LteFrHardAlgorithm::DoGetAvailableDlRbg(), ns3::LteFrSoftAlgorithm::DoGetAvailableDlRbg(), ns3::LteFrStrictAlgorithm::DoGetAvailableDlRbg(), ns3::LteFfrDistributedAlgorithm::Reconfigure(), ns3::LteFfrEnhancedAlgorithm::Reconfigure(), ns3::LteFfrSoftAlgorithm::Reconfigure(), ns3::LteFrHardAlgorithm::Reconfigure(), ns3::LteFrSoftAlgorithm::Reconfigure(), ns3::LteFrStrictAlgorithm::Reconfigure(), and SetFrCellTypeId().

◆ m_ulBandwidth

uint8_t ns3::LteFfrAlgorithm::m_ulBandwidth
protected

uplink bandwidth in RBs

Definition at line 239 of file lte-ffr-algorithm.h.

Referenced by ns3::LteFfrDistributedAlgorithm::Calculate(), ns3::LteFfrSimple::DoGetAvailableUlRbg(), ns3::LteFrNoOpAlgorithm::DoGetAvailableUlRbg(), ns3::LteFfrDistributedAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFfrEnhancedAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFfrSimple::DoGetMinContinuousUlBandwidth(), ns3::LteFfrSoftAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFrHardAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFrNoOpAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFrSoftAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFrStrictAlgorithm::DoGetMinContinuousUlBandwidth(), ns3::LteFfrDistributedAlgorithm::DoInitialize(), ns3::LteFfrEnhancedAlgorithm::DoInitialize(), ns3::LteFfrSoftAlgorithm::DoInitialize(), ns3::LteFrHardAlgorithm::DoInitialize(), ns3::LteFrSoftAlgorithm::DoInitialize(), ns3::LteFrStrictAlgorithm::DoInitialize(), ns3::LteFfrEnhancedAlgorithm::DoReportDlCqiInfo(), ns3::LteFfrEnhancedAlgorithm::DoReportUlCqiInfo(), ns3::LteFfrEnhancedAlgorithm::EstimateUlSinr(), GetUlBandwidth(), ns3::LteFfrDistributedAlgorithm::InitializeUplinkRbgMaps(), ns3::LteFfrEnhancedAlgorithm::InitializeUplinkRbgMaps(), ns3::LteFfrSoftAlgorithm::InitializeUplinkRbgMaps(), ns3::LteFrHardAlgorithm::InitializeUplinkRbgMaps(), ns3::LteFrSoftAlgorithm::InitializeUplinkRbgMaps(), ns3::LteFrStrictAlgorithm::InitializeUplinkRbgMaps(), ns3::LteFfrDistributedAlgorithm::Reconfigure(), ns3::LteFfrEnhancedAlgorithm::Reconfigure(), ns3::LteFfrSoftAlgorithm::Reconfigure(), ns3::LteFrHardAlgorithm::Reconfigure(), ns3::LteFrSoftAlgorithm::Reconfigure(), ns3::LteFrStrictAlgorithm::Reconfigure(), SetUlBandwidth(), ns3::LteFfrEnhancedAlgorithm::SetUplinkConfiguration(), ns3::LteFfrSoftAlgorithm::SetUplinkConfiguration(), ns3::LteFrHardAlgorithm::SetUplinkConfiguration(), ns3::LteFrSoftAlgorithm::SetUplinkConfiguration(), and ns3::LteFrStrictAlgorithm::SetUplinkConfiguration().

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