Hard Frequency Reuse algorithm implementation which uses only 1 sub-band. More...

#include "lte-fr-hard-algorithm.h"

Inheritance diagram for ns3::LteFrHardAlgorithm:

Collaboration diagram for ns3::LteFrHardAlgorithm:

Public Member Functions
	LteFrHardAlgorithm ()
	Creates a trivial ffr algorithm instance.

	~LteFrHardAlgorithm () override

LteFfrRrcSapProvider *	GetLteFfrRrcSapProvider () override
	Export the "provider" part of the LteFfrRrcSap interface.

LteFfrSapProvider *	GetLteFfrSapProvider () override
	Export the "provider" part of the LteFfrSap interface.

void	SetLteFfrRrcSapUser (LteFfrRrcSapUser *s) override
	Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will interact with.

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

Public Member Functions inherited from ns3::LteFfrAlgorithm
	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) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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

std::vector< bool >	DoGetAvailableDlRbg () override
	Implementation of LteFfrSapProvider::GetAvailableDlRbg.

std::vector< bool >	DoGetAvailableUlRbg () override
	Implementation of LteFfrSapProvider::GetAvailableUlRbg.

uint16_t	DoGetMinContinuousUlBandwidth () override
	DoGetMinContinuousUlBandwidth in number of RB.

uint8_t	DoGetTpc (uint16_t rnti) override
	DoGetTpc for UE.

void	DoInitialize () override
	Initialize() implementation.

bool	DoIsDlRbgAvailableForUe (int i, uint16_t rnti) override
	Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.

bool	DoIsUlRbgAvailableForUe (int i, uint16_t rnti) override
	Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.

void	DoRecvLoadInformation (EpcX2Sap::LoadInformationParams params) override
	DoRecvLoadInformation.

void	DoReportDlCqiInfo (const FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params) override
	DoReportDlCqiInfo.

void	DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults) override
	Implementation of LteFfrRrcSapProvider::ReportUeMeas.

void	DoReportUlCqiInfo (const FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params) override
	DoReportUlCqiInfo.

void	DoReportUlCqiInfo (std::map< uint16_t, std::vector< double > > ulCqiMap) override
	DoReportUlCqiInfo.

void	Reconfigure () override
	Automatic FR reconfiguration.

Protected Member Functions inherited from ns3::LteFfrAlgorithm
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	DoDispose ()
	Destructor implementation.

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.

Private Member Functions
void	InitializeDownlinkRbgMaps ()
	Initialize downlink rbg maps.

void	InitializeUplinkRbgMaps ()
	Initialize uplink rbg maps.

void	SetDownlinkConfiguration (uint16_t cellId, uint8_t bandwidth)
	Set downlink configuration.

void	SetUplinkConfiguration (uint16_t cellId, uint8_t bandwidth)
	Set uplink configuration.

Private Attributes
uint8_t	m_dlOffset
	DL offset.

std::vector< bool >	m_dlRbgMap
	DL RBG Map.

uint8_t	m_dlSubBand
	DL subband.

LteFfrRrcSapProvider *	m_ffrRrcSapProvider
	FFR RRC SAP provider.

LteFfrRrcSapUser *	m_ffrRrcSapUser
	FFR RRC SAP user.

LteFfrSapProvider *	m_ffrSapProvider
	FFR SAP provider.

LteFfrSapUser *	m_ffrSapUser
	FFR SAP user.

uint8_t	m_ulOffset
	UL offset.

std::vector< bool >	m_ulRbgMap
	UL RBG Map.

uint8_t	m_ulSubBand
	UL subband.

Friends
class	MemberLteFfrRrcSapProvider< LteFrHardAlgorithm >
	let the forwarder class access the protected and private members

class	MemberLteFfrSapProvider< LteFrHardAlgorithm >
	let the forwarder class access the protected and private members

Additional Inherited Members
Protected Attributes inherited from ns3::LteFfrAlgorithm
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

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

Detailed Description

Hard Frequency Reuse algorithm implementation which uses only 1 sub-band.

Config Paths

ns3::LteFrHardAlgorithm is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteFfrAlgorithm/$ns3::LteFrHardAlgorithm"
"/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/ComponentCarrierMap/[i]/LteFfrAlgorithm/$ns3::LteFrHardAlgorithm"
"/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteFfrAlgorithm/$ns3::LteFrHardAlgorithm"
"/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/ComponentCarrierMap/[i]/LteFfrAlgorithm/$ns3::LteFrHardAlgorithm"

Attributes

DlSubBandOffset: Downlink Offset in number of Resource Block Groups
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: constructwriteread
DlSubBandwidth: Downlink Transmission SubBandwidth Configuration in number of Resource Block Groups
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 25
- Flags: constructwriteread
UlSubBandOffset: Uplink Offset in number of Resource Block Groups
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: constructwriteread
UlSubBandwidth: Uplink Transmission SubBandwidth Configuration in number of Resource Block Groups
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 25
- Flags: constructwriteread

Attributes defined in parent class ns3::LteFfrAlgorithm

EnabledInUplink: If FR algorithm will also work in Uplink, default value true
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread
FrCellTypeId: Downlink FR cell type ID for automatic configuration,default value is 0 and it means that user needs to configure FR algorithm manually,if it is set to 1,2 or 3 FR algorithm will be configured automatically
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: constructwriteread

No TraceSources are defined for this type.
Size of this type is 184 bytes (on a 64-bit architecture).

Definition at line 35 of file lte-fr-hard-algorithm.h.

Constructor & Destructor Documentation

◆ LteFrHardAlgorithm()

ns3::LteFrHardAlgorithm::LteFrHardAlgorithm ( )

Creates a trivial ffr algorithm instance.

Definition at line 95 of file lte-fr-hard-algorithm.cc.

References m_ffrRrcSapProvider, m_ffrSapProvider, MemberLteFfrRrcSapProvider< LteFrHardAlgorithm >, MemberLteFfrSapProvider< LteFrHardAlgorithm >, and NS_LOG_FUNCTION.

◆ ~LteFrHardAlgorithm()

ns3::LteFrHardAlgorithm::~LteFrHardAlgorithm ( )

override

Definition at line 108 of file lte-fr-hard-algorithm.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::LteFrHardAlgorithm::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::LteFfrAlgorithm.

Definition at line 114 of file lte-fr-hard-algorithm.cc.

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

◆ DoGetAvailableDlRbg()

std::vector< bool > ns3::LteFrHardAlgorithm::DoGetAvailableDlRbg ( )

overrideprotectedvirtual

Implementation of LteFfrSapProvider::GetAvailableDlRbg.

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

Implements ns3::LteFfrAlgorithm.

Definition at line 286 of file lte-fr-hard-algorithm.cc.

References InitializeDownlinkRbgMaps(), m_dlRbgMap, ns3::LteFfrAlgorithm::m_needReconfiguration, NS_LOG_FUNCTION, and Reconfigure().

Here is the call graph for this function:

◆ DoGetAvailableUlRbg()

std::vector< bool > ns3::LteFrHardAlgorithm::DoGetAvailableUlRbg ( )

overrideprotectedvirtual

Implementation of LteFfrSapProvider::GetAvailableUlRbg.

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

Implements ns3::LteFfrAlgorithm.

Definition at line 311 of file lte-fr-hard-algorithm.cc.

References InitializeUplinkRbgMaps(), m_ulRbgMap, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoGetMinContinuousUlBandwidth()

uint16_t ns3::LteFrHardAlgorithm::DoGetMinContinuousUlBandwidth ( )

overrideprotectedvirtual

DoGetMinContinuousUlBandwidth in number of RB.

Returns: number of RB in min continuous UL Bandwidth

Implements ns3::LteFfrAlgorithm.

Definition at line 368 of file lte-fr-hard-algorithm.cc.

References ns3::LteFfrAlgorithm::m_enabledInUplink, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulSubBand, and NS_LOG_FUNCTION.

◆ DoGetTpc()

uint8_t ns3::LteFrHardAlgorithm::DoGetTpc ( uint16_t rnti )

overrideprotectedvirtual

DoGetTpc for UE.

Parameters

rnti

Returns: TPC value

Implements ns3::LteFfrAlgorithm.

Definition at line 360 of file lte-fr-hard-algorithm.cc.

References NS_LOG_FUNCTION.

◆ DoInitialize()

void ns3::LteFrHardAlgorithm::DoInitialize ( )

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 183 of file lte-fr-hard-algorithm.cc.

References ns3::Object::DoInitialize(), ns3::LteFfrAlgorithm::m_dlBandwidth, ns3::LteFfrAlgorithm::m_frCellTypeId, ns3::LteFfrAlgorithm::m_ulBandwidth, NS_ASSERT_MSG, NS_LOG_FUNCTION, SetDownlinkConfiguration(), and SetUplinkConfiguration().

Here is the call graph for this function:

◆ DoIsDlRbgAvailableForUe()

bool ns3::LteFrHardAlgorithm::DoIsDlRbgAvailableForUe	(	int	rbId,
		uint16_t	rnti
	)

overrideprotectedvirtual

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

Implements ns3::LteFfrAlgorithm.

Definition at line 304 of file lte-fr-hard-algorithm.cc.

References m_dlRbgMap, and NS_LOG_FUNCTION.

◆ DoIsUlRbgAvailableForUe()

bool ns3::LteFrHardAlgorithm::DoIsUlRbgAvailableForUe	(	int	rbId,
		uint16_t	rnti
	)

overrideprotectedvirtual

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

Implements ns3::LteFfrAlgorithm.

Definition at line 324 of file lte-fr-hard-algorithm.cc.

References ns3::LteFfrAlgorithm::m_enabledInUplink, m_ulRbgMap, and NS_LOG_FUNCTION.

◆ DoRecvLoadInformation()

void ns3::LteFrHardAlgorithm::DoRecvLoadInformation ( EpcX2Sap::LoadInformationParams params )

overrideprotectedvirtual

DoRecvLoadInformation.

Parameters

params

Implements ns3::LteFfrAlgorithm.

Definition at line 388 of file lte-fr-hard-algorithm.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ DoReportDlCqiInfo()

void ns3::LteFrHardAlgorithm::DoReportDlCqiInfo ( const FfMacSchedSapProvider::SchedDlCqiInfoReqParameters & params )

overrideprotectedvirtual

DoReportDlCqiInfo.

Parameters

params

Implements ns3::LteFfrAlgorithm.

Definition at line 337 of file lte-fr-hard-algorithm.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ DoReportUeMeas()

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

overrideprotectedvirtual

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

Implements ns3::LteFfrAlgorithm.

Definition at line 381 of file lte-fr-hard-algorithm.cc.

References ns3::LteRrcSap::MeasResults::measId, NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ DoReportUlCqiInfo() [1/2]

void ns3::LteFrHardAlgorithm::DoReportUlCqiInfo ( const FfMacSchedSapProvider::SchedUlCqiInfoReqParameters & params )

overrideprotectedvirtual

DoReportUlCqiInfo.

Parameters

params

Implements ns3::LteFfrAlgorithm.

Definition at line 345 of file lte-fr-hard-algorithm.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ DoReportUlCqiInfo() [2/2]

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

overrideprotectedvirtual

DoReportUlCqiInfo.

Parameters

ulCqiMap

Implements ns3::LteFfrAlgorithm.

Definition at line 353 of file lte-fr-hard-algorithm.cc.

References NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ GetLteFfrRrcSapProvider()

LteFfrRrcSapProvider * ns3::LteFrHardAlgorithm::GetLteFfrRrcSapProvider ( )

overridevirtual

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

Implements ns3::LteFfrAlgorithm.

Definition at line 176 of file lte-fr-hard-algorithm.cc.

References m_ffrRrcSapProvider, and NS_LOG_FUNCTION.

◆ GetLteFfrSapProvider()

LteFfrSapProvider * ns3::LteFrHardAlgorithm::GetLteFfrSapProvider ( )

overridevirtual

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

Implements ns3::LteFfrAlgorithm.

Definition at line 162 of file lte-fr-hard-algorithm.cc.

References m_ffrSapProvider, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::LteFrHardAlgorithm::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 122 of file lte-fr-hard-algorithm.cc.

References m_dlOffset, m_dlSubBand, m_ulOffset, m_ulSubBand, ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ InitializeDownlinkRbgMaps()

void ns3::LteFrHardAlgorithm::InitializeDownlinkRbgMaps ( )

private

Initialize downlink rbg maps.

Definition at line 243 of file lte-fr-hard-algorithm.cc.

References ns3::LteFfrAlgorithm::GetRbgSize(), ns3::LteFfrAlgorithm::m_dlBandwidth, m_dlOffset, m_dlRbgMap, m_dlSubBand, and NS_ASSERT_MSG.

Referenced by DoGetAvailableDlRbg(), and Reconfigure().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitializeUplinkRbgMaps()

void ns3::LteFrHardAlgorithm::InitializeUplinkRbgMaps ( )

private

Initialize uplink rbg maps.

Definition at line 262 of file lte-fr-hard-algorithm.cc.

References ns3::LteFfrAlgorithm::m_enabledInUplink, ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulOffset, m_ulRbgMap, m_ulSubBand, and NS_ASSERT_MSG.

Referenced by DoGetAvailableUlRbg(), and Reconfigure().

Here is the caller graph for this function:

◆ Reconfigure()

void ns3::LteFrHardAlgorithm::Reconfigure ( )

overrideprotectedvirtual

Automatic FR reconfiguration.

Implements ns3::LteFfrAlgorithm.

Definition at line 199 of file lte-fr-hard-algorithm.cc.

References InitializeDownlinkRbgMaps(), InitializeUplinkRbgMaps(), ns3::LteFfrAlgorithm::m_dlBandwidth, ns3::LteFfrAlgorithm::m_frCellTypeId, ns3::LteFfrAlgorithm::m_needReconfiguration, ns3::LteFfrAlgorithm::m_ulBandwidth, NS_LOG_FUNCTION, SetDownlinkConfiguration(), and SetUplinkConfiguration().

Referenced by DoGetAvailableDlRbg().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDownlinkConfiguration()

void ns3::LteFrHardAlgorithm::SetDownlinkConfiguration	(	uint16_t	cellId,
		uint8_t	bandwidth
	)

private

Set downlink configuration.

Parameters

cellId	the cell ID
bandwidth	the bandwidth

Definition at line 213 of file lte-fr-hard-algorithm.cc.

References ns3::g_frHardDownlinkDefaultConfiguration, ns3::LteFfrAlgorithm::m_cellId, ns3::LteFfrAlgorithm::m_dlBandwidth, ns3::FrHardDownlinkDefaultConfiguration::m_dlOffset, m_dlOffset, ns3::FrHardDownlinkDefaultConfiguration::m_dlSubBand, m_dlSubBand, NS_LOG_FUNCTION, and ns3::NUM_DOWNLINK_CONFS().

Referenced by DoInitialize(), and Reconfigure().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLteFfrRrcSapUser()

void ns3::LteFrHardAlgorithm::SetLteFfrRrcSapUser ( LteFfrRrcSapUser * s )

overridevirtual

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

Implements ns3::LteFfrAlgorithm.

Definition at line 169 of file lte-fr-hard-algorithm.cc.

References m_ffrRrcSapUser, and NS_LOG_FUNCTION.

◆ SetLteFfrSapUser()

void ns3::LteFrHardAlgorithm::SetLteFfrSapUser ( LteFfrSapUser * s )

overridevirtual

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

Implements ns3::LteFfrAlgorithm.

Definition at line 155 of file lte-fr-hard-algorithm.cc.

References m_ffrSapUser, and NS_LOG_FUNCTION.

◆ SetUplinkConfiguration()

void ns3::LteFrHardAlgorithm::SetUplinkConfiguration	(	uint16_t	cellId,
		uint8_t	bandwidth
	)

private

Set uplink configuration.

Parameters

cellId	the cell ID
bandwidth	the bandwidth

Definition at line 228 of file lte-fr-hard-algorithm.cc.

References ns3::g_frHardUplinkDefaultConfiguration, ns3::LteFfrAlgorithm::m_cellId, ns3::LteFfrAlgorithm::m_ulBandwidth, ns3::FrHardUplinkDefaultConfiguration::m_ulOffset, m_ulOffset, ns3::FrHardUplinkDefaultConfiguration::m_ulSubBand, m_ulSubBand, NS_LOG_FUNCTION, and ns3::NUM_UPLINK_CONFS().

Referenced by DoInitialize(), and Reconfigure().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ MemberLteFfrRrcSapProvider< LteFrHardAlgorithm >

friend class MemberLteFfrRrcSapProvider< LteFrHardAlgorithm >

friend

let the forwarder class access the protected and private members

Definition at line 56 of file lte-fr-hard-algorithm.h.

Referenced by LteFrHardAlgorithm().

◆ MemberLteFfrSapProvider< LteFrHardAlgorithm >

friend class MemberLteFfrSapProvider< LteFrHardAlgorithm >

friend

let the forwarder class access the protected and private members

Definition at line 56 of file lte-fr-hard-algorithm.h.

Referenced by LteFrHardAlgorithm().

Member Data Documentation

◆ m_dlOffset

uint8_t ns3::LteFrHardAlgorithm::m_dlOffset

private

DL offset.

Definition at line 119 of file lte-fr-hard-algorithm.h.

Referenced by GetTypeId(), InitializeDownlinkRbgMaps(), and SetDownlinkConfiguration().

◆ m_dlRbgMap

std::vector<bool> ns3::LteFrHardAlgorithm::m_dlRbgMap

private

DL RBG Map.

Definition at line 125 of file lte-fr-hard-algorithm.h.

Referenced by DoGetAvailableDlRbg(), DoIsDlRbgAvailableForUe(), and InitializeDownlinkRbgMaps().

◆ m_dlSubBand

uint8_t ns3::LteFrHardAlgorithm::m_dlSubBand

private

DL subband.

Definition at line 120 of file lte-fr-hard-algorithm.h.

Referenced by GetTypeId(), InitializeDownlinkRbgMaps(), and SetDownlinkConfiguration().

◆ m_ffrRrcSapProvider

LteFfrRrcSapProvider* ns3::LteFrHardAlgorithm::m_ffrRrcSapProvider

private

FFR RRC SAP provider.

Definition at line 117 of file lte-fr-hard-algorithm.h.

Referenced by LteFrHardAlgorithm(), DoDispose(), and GetLteFfrRrcSapProvider().

◆ m_ffrRrcSapUser

LteFfrRrcSapUser* ns3::LteFrHardAlgorithm::m_ffrRrcSapUser

private

FFR RRC SAP user.

Definition at line 116 of file lte-fr-hard-algorithm.h.

Referenced by SetLteFfrRrcSapUser().

◆ m_ffrSapProvider

LteFfrSapProvider* ns3::LteFrHardAlgorithm::m_ffrSapProvider

private

FFR SAP provider.

Definition at line 113 of file lte-fr-hard-algorithm.h.

Referenced by LteFrHardAlgorithm(), DoDispose(), and GetLteFfrSapProvider().

◆ m_ffrSapUser

LteFfrSapUser* ns3::LteFrHardAlgorithm::m_ffrSapUser

private

FFR SAP user.

Definition at line 112 of file lte-fr-hard-algorithm.h.

Referenced by SetLteFfrSapUser().

◆ m_ulOffset

uint8_t ns3::LteFrHardAlgorithm::m_ulOffset

private

UL offset.

Definition at line 122 of file lte-fr-hard-algorithm.h.

Referenced by GetTypeId(), InitializeUplinkRbgMaps(), and SetUplinkConfiguration().

◆ m_ulRbgMap

std::vector<bool> ns3::LteFrHardAlgorithm::m_ulRbgMap

private

UL RBG Map.

Definition at line 126 of file lte-fr-hard-algorithm.h.

Referenced by DoGetAvailableUlRbg(), DoIsUlRbgAvailableForUe(), and InitializeUplinkRbgMaps().

◆ m_ulSubBand

uint8_t ns3::LteFrHardAlgorithm::m_ulSubBand

private

UL subband.

Definition at line 123 of file lte-fr-hard-algorithm.h.

Referenced by DoGetMinContinuousUlBandwidth(), GetTypeId(), InitializeUplinkRbgMaps(), and SetUplinkConfiguration().

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

src/lte/model/lte-fr-hard-algorithm.h
src/lte/model/lte-fr-hard-algorithm.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::LteFfrAlgorithm

Constructor & Destructor Documentation

◆ LteFrHardAlgorithm()

◆ ~LteFrHardAlgorithm()

Member Function Documentation

◆ DoDispose()

◆ DoGetAvailableDlRbg()

◆ DoGetAvailableUlRbg()

◆ DoGetMinContinuousUlBandwidth()

◆ DoGetTpc()

◆ DoInitialize()

◆ DoIsDlRbgAvailableForUe()

◆ DoIsUlRbgAvailableForUe()

◆ DoRecvLoadInformation()

◆ DoReportDlCqiInfo()

◆ DoReportUeMeas()

◆ DoReportUlCqiInfo() [1/2]

◆ DoReportUlCqiInfo() [2/2]

◆ GetLteFfrRrcSapProvider()

◆ GetLteFfrSapProvider()

◆ GetTypeId()

◆ InitializeDownlinkRbgMaps()

◆ InitializeUplinkRbgMaps()

◆ Reconfigure()

◆ SetDownlinkConfiguration()

◆ SetLteFfrRrcSapUser()

◆ SetLteFfrSapUser()

◆ SetUplinkConfiguration()

Friends And Related Function Documentation

◆ MemberLteFfrRrcSapProvider< LteFrHardAlgorithm >

◆ MemberLteFfrSapProvider< LteFrHardAlgorithm >

Member Data Documentation

◆ m_dlOffset

◆ m_dlRbgMap

◆ m_dlSubBand

◆ m_ffrRrcSapProvider

◆ m_ffrRrcSapUser

◆ m_ffrSapProvider

◆ m_ffrSapUser

◆ m_ulOffset

◆ m_ulRbgMap

◆ m_ulSubBand