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. More...

virtual LteFfrSapProvider *	GetLteFfrSapProvider ()=0
	Export the "provider" part of the LteFfrSap interface. More...

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. More...

virtual void	SetLteFfrSapUser (LteFfrSapUser *s)=0
	Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will interact with. More...

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::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...

virtual std::vector< bool >	DoGetAvailableDlRbg ()=0
	Implementation of LteFfrSapProvider::GetAvailableDlRbg. More...

virtual std::vector< bool >	DoGetAvailableUlRbg ()=0
	Implementation of LteFfrSapProvider::GetAvailableUlRbg. More...

virtual uint16_t	DoGetMinContinuousUlBandwidth ()=0
	DoGetMinContinuousUlBandwidth in number of RB. More...

virtual uint8_t	DoGetTpc (uint16_t rnti)=0
	DoGetTpc for UE. More...

virtual bool	DoIsDlRbgAvailableForUe (int rbId, uint16_t rnti)=0
	Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe. More...

virtual bool	DoIsUlRbgAvailableForUe (int rbId, uint16_t rnti)=0
	Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe. More...

virtual void	DoRecvLoadInformation (EpcX2Sap::LoadInformationParams params)=0
	DoRecvLoadInformation. More...

virtual void	DoReportDlCqiInfo (const FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)=0
	DoReportDlCqiInfo. More...

virtual void	DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults)=0
	Implementation of LteFfrRrcSapProvider::ReportUeMeas. More...

virtual void	DoReportUlCqiInfo (const FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)=0
	DoReportUlCqiInfo. More...

virtual void	DoReportUlCqiInfo (std::map< uint16_t, std::vector< double >> ulCqiMap)=0
	DoReportUlCqiInfo. More...

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...

virtual void	Reconfigure ()=0
	Automatic FR reconfiguration. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoInitialize ()
	Initialize() implementation. 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...

Protected Attributes
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...

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

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 59 of file lte-ffr-algorithm.h.

Constructor & Destructor Documentation

◆ LteFfrAlgorithm()

ns3::LteFfrAlgorithm::LteFfrAlgorithm ( )

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

◆ ~LteFfrAlgorithm()

ns3::LteFfrAlgorithm::~LteFfrAlgorithm ( )

override

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

Member Function Documentation

◆ DoDispose()

void ns3::LteFfrAlgorithm::DoDispose ( void )

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::LteFfrSimple, ns3::LteFrStrictAlgorithm, ns3::LteFrSoftAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFfrSoftAlgorithm, ns3::LteFfrEnhancedAlgorithm, and ns3::LteFfrDistributedAlgorithm.

Definition at line 76 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::LteFfrSimple, ns3::LteFrStrictAlgorithm, ns3::LteFrSoftAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFfrSoftAlgorithm, ns3::LteFfrEnhancedAlgorithm, and ns3::LteFfrDistributedAlgorithm.

◆ 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::LteFfrSimple, ns3::LteFrStrictAlgorithm, ns3::LteFrSoftAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFfrSoftAlgorithm, ns3::LteFfrEnhancedAlgorithm, and ns3::LteFfrDistributedAlgorithm.

◆ 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::LteFfrSimple, ns3::LteFrStrictAlgorithm, ns3::LteFrSoftAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFfrSoftAlgorithm, ns3::LteFfrEnhancedAlgorithm, and ns3::LteFfrDistributedAlgorithm.

◆ DoGetTpc()

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

protectedpure virtual

DoGetTpc for UE.

Parameters

rnti

Returns: TPC value

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

◆ DoIsDlRbgAvailableForUe()

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

protectedpure virtual

Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.

Parameters

rbId
rnti	Radio 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::LteFfrSimple, ns3::LteFrStrictAlgorithm, ns3::LteFrSoftAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFfrSoftAlgorithm, ns3::LteFfrEnhancedAlgorithm, and ns3::LteFfrDistributedAlgorithm.

◆ DoIsUlRbgAvailableForUe()

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

protectedpure virtual

Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.

Parameters

rbId
rnti	Radio 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::LteFfrSimple, ns3::LteFrStrictAlgorithm, ns3::LteFrSoftAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFfrSoftAlgorithm, ns3::LteFfrEnhancedAlgorithm, and ns3::LteFfrDistributedAlgorithm.

◆ DoRecvLoadInformation()

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

protectedpure virtual

DoRecvLoadInformation.

Parameters

params

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

◆ DoReportDlCqiInfo()

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

protectedpure virtual

DoReportDlCqiInfo.

Parameters

params

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

◆ DoReportUeMeas()

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

protectedpure virtual

Implementation of LteFfrRrcSapProvider::ReportUeMeas.

Parameters

rnti	Radio Network Temporary Identity, an integer identifying the UE where the report originates from
measResults	a single report of one measurement identity

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

◆ DoReportUlCqiInfo() [1/2]

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

protectedpure virtual

DoReportUlCqiInfo.

Parameters

params

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

◆ DoReportUlCqiInfo() [2/2]

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

protectedpure virtual

DoReportUlCqiInfo.

Parameters

ulCqiMap

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

◆ DoSetBandwidth()

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

protectedvirtual

Implementation of LteFfrRrcSapProvider::SetBandwidth.

Parameters

ulBandwidth	UL bandwidth in number of RB
dlBandwidth	DL bandwidth in number of RB

Definition at line 174 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

cellId the Cell Identifier

Definition at line 167 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 110 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 146 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::LteFfrSimple, ns3::LteFrStrictAlgorithm, ns3::LteFrSoftAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFfrSoftAlgorithm, ns3::LteFfrEnhancedAlgorithm, and ns3::LteFfrDistributedAlgorithm.

◆ 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::LteFfrSimple, ns3::LteFrStrictAlgorithm, ns3::LteFrSoftAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFfrSoftAlgorithm, ns3::LteFfrEnhancedAlgorithm, and ns3::LteFfrDistributedAlgorithm.

◆ 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 153 of file lte-ffr-algorithm.cc.

References ns3::Type0AllocationRbg.

Referenced by ns3::LteFfrDistributedAlgorithm::Calculate(), ns3::LteFrNoOpAlgorithm::DoGetAvailableDlRbg(), ns3::LteFfrSimple::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 ( void )

static

Get the type ID.

Returns: the object TypeId

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

References GetFrCellTypeId(), m_enabledInUplink, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeUintegerAccessor(), 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 82 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::LteFfrSimple, ns3::LteFrStrictAlgorithm, ns3::LteFrSoftAlgorithm, ns3::LteFrNoOpAlgorithm, ns3::LteFrHardAlgorithm, ns3::LteFfrSoftAlgorithm, ns3::LteFfrEnhancedAlgorithm, and ns3::LteFfrDistributedAlgorithm.

◆ SetDlBandwidth()

void ns3::LteFfrAlgorithm::SetDlBandwidth ( uint16_t bw )

Parameters

bw	the downlink bandwidth in RBs

Definition at line 117 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

cellTypeId for automatic FR configuration

Definition at line 138 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

s	a reference to the "user" part of the interface, typically a member of an LteEnbRrc instance

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

◆ 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

s	a reference to the "user" part of the interface, typically a member of an Scheduler instance

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

◆ SetUlBandwidth()

void ns3::LteFfrAlgorithm::SetUlBandwidth ( uint16_t bw )

Parameters

bw	the uplink bandwidth in RBs

Definition at line 89 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 247 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 249 of file lte-ffr-algorithm.h.

Referenced by ns3::LteFfrDistributedAlgorithm::Calculate(), ns3::LteFrNoOpAlgorithm::DoGetAvailableDlRbg(), ns3::LteFfrSimple::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 254 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 252 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 256 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 250 of file lte-ffr-algorithm.h.

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

src/lte/model/lte-ffr-algorithm.h
src/lte/model/lte-ffr-algorithm.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LteFfrAlgorithm()

◆ ~LteFfrAlgorithm()

Member Function Documentation

◆ DoDispose()

◆ DoGetAvailableDlRbg()

◆ DoGetAvailableUlRbg()

◆ DoGetMinContinuousUlBandwidth()

◆ DoGetTpc()

◆ DoIsDlRbgAvailableForUe()

◆ DoIsUlRbgAvailableForUe()

◆ DoRecvLoadInformation()

◆ DoReportDlCqiInfo()

◆ DoReportUeMeas()

◆ DoReportUlCqiInfo() [1/2]

◆ DoReportUlCqiInfo() [2/2]

◆ DoSetBandwidth()

◆ DoSetCellId()

◆ GetDlBandwidth()

◆ GetFrCellTypeId()

◆ GetLteFfrRrcSapProvider()

◆ GetLteFfrSapProvider()

◆ GetRbgSize()

◆ GetTypeId()

◆ GetUlBandwidth()

◆ Reconfigure()

◆ SetDlBandwidth()

◆ SetFrCellTypeId()

◆ SetLteFfrRrcSapUser()

◆ SetLteFfrSapUser()

◆ SetUlBandwidth()

Member Data Documentation

◆ m_cellId

◆ m_dlBandwidth

◆ m_enabledInUplink

◆ m_frCellTypeId

◆ m_needReconfiguration

◆ m_ulBandwidth