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

virtual	~LteFrHardAlgorithm ()

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

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

Public Member Functions inherited from ns3::Object
	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
	Implement the GetInstanceTypeId method defined in ObjectBase. 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. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	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. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) 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 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 ()

Static Public Member Functions inherited from ns3::LteFfrAlgorithm
static TypeId	GetTypeId ()

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
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 &params)
	DoReportDlCqiInfo. More...

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

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

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

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

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

Protected Member Functions inherited from ns3::Object
	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...

Protected Member Functions inherited from ns3::ObjectBase
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 Member Functions
void	InitializeDownlinkRbgMaps ()

void	InitializeUplinkRbgMaps ()

void	SetDownlinkConfiguration (uint16_t cellId, uint8_t bandwidth)

void	SetUplinkConfiguration (uint16_t cellId, uint8_t bandwidth)

Private Attributes
uint8_t	m_dlOffset

std::vector< bool >	m_dlRbgMap

uint8_t	m_dlSubBand

LteFfrRrcSapProvider *	m_ffrRrcSapProvider

LteFfrRrcSapUser *	m_ffrRrcSapUser

LteFfrSapProvider *	m_ffrSapProvider

LteFfrSapUser *	m_ffrSapUser

uint8_t	m_ulOffset

std::vector< bool >	m_ulRbgMap

uint8_t	m_ulSubBand

Friends
class	MemberLteFfrRrcSapProvider< LteFrHardAlgorithm >

class	MemberLteFfrSapProvider< LteFrHardAlgorithm >

Additional Inherited Members
Protected Attributes inherited from ns3::LteFfrAlgorithm
uint16_t	m_cellId

uint8_t	m_dlBandwidth
	downlink bandwidth in RBs More...

bool	m_enabledInUplink
	If true FR algorithm will also work in Uplink. More...

uint8_t	m_frCellTypeId
	FFR cell type ID for automatic configuration. More...

bool	m_needReconfiguration
	If true FR algorithm will be reconfigured. More...

uint8_t	m_ulBandwidth
	uplink bandwidth in RBs More...

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

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::LteNetDevice/$ns3::LteEnbNetDevice/LteFfrAlgorithm/$ns3::LteFrHardAlgorithm"
"/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteFfrAlgorithm/$ns3::LteFrHardAlgorithm"

Attributes

UlSubBandOffset: Uplink Offset in number of Resource Block Groups
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: construct write read
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: construct write read
DlSubBandOffset: Downlink Offset in number of Resource Block Groups
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: construct write read
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: construct write read

Attributes defined in parent class ns3::LteFfrAlgorithm

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: construct write read
EnabledInUplink: If FR algorithm will also work in Uplink, default value true
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read

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

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

Constructor & Destructor Documentation

ns3::LteFrHardAlgorithm::LteFrHardAlgorithm ( )

Creates a trivial ffr algorithm instance.

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

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

ns3::LteFrHardAlgorithm::~LteFrHardAlgorithm ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::LteFrHardAlgorithm::DoDispose ( void )

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

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

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

protectedvirtual

Implementation of LteFfrSapProvider::GetAvailableDlRbg.

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

rbId
rnti	Radio Network Temporary Identity, an integer identifying the UE where the report originates from

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members