A Discrete-Event Network Simulator
API
ns3::LteFfrSimple Class Reference

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

#include "lte-ffr-simple.h"

+ Inheritance diagram for ns3::LteFfrSimple:
+ Collaboration diagram for ns3::LteFfrSimple:

Public Types

typedef void(* PdschTracedCallback) (uint16_t rnti, uint8_t pdschPa)
 TracedCallback signature for change of PdschConfigDedicated. More...
 

Public Member Functions

 LteFfrSimple ()
 Creates a trivial ffr algorithm instance. More...
 
virtual ~LteFfrSimple ()
 
void ChangePdschConfigDedicated (bool change)
 
virtual LteFfrRrcSapProviderGetLteFfrRrcSapProvider ()
 Export the "provider" part of the LteFfrRrcSap interface. More...
 
virtual LteFfrSapProviderGetLteFfrSapProvider ()
 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...
 
void SetPdschConfigDedicated (LteRrcSap::PdschConfigDedicated pdschConfigDedicated)
 
void SetTpc (uint32_t tpc, uint32_t num, bool acculumatedMode)
 
- 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 by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- 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...
 
SimpleRefCountoperator= (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 UpdatePdschConfigDedicated ()
 

Private Attributes

bool m_acculumatedMode
 
bool m_changePdschConfigDedicated
 
TracedCallback< uint16_t, uint8_t > m_changePdschConfigDedicatedTrace
 
uint8_t m_dlOffset
 
std::vector< bool > m_dlRbgMap
 
uint8_t m_dlSubBand
 
LteFfrRrcSapProviderm_ffrRrcSapProvider
 
LteFfrRrcSapUserm_ffrRrcSapUser
 
LteFfrSapProviderm_ffrSapProvider
 
LteFfrSapUserm_ffrSapUser
 
uint8_t m_measId
 
LteRrcSap::PdschConfigDedicated m_pdschConfigDedicated
 
uint32_t m_tpc
 
uint32_t m_tpcNum
 
std::map< uint16_t, LteRrcSap::PdschConfigDedicatedm_ues
 
uint8_t m_ulOffset
 
std::vector< bool > m_ulRbgMap
 
uint8_t m_ulSubBand
 

Friends

class MemberLteFfrRrcSapProvider< LteFfrSimple >
 
class MemberLteFfrSapProvider< LteFfrSimple >
 

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

Detailed Description

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

Used to test Downlink Power Allocation. When Simple FR receives UE measurements it immediately call functions to change PdschConfigDedicated (i.e. P_A) value for this UE.

Definition at line 42 of file lte-ffr-simple.h.

Member Typedef Documentation

typedef void(* ns3::LteFfrSimple::PdschTracedCallback) (uint16_t rnti, uint8_t pdschPa)

TracedCallback signature for change of PdschConfigDedicated.

Parameters
[in]rnti
[in]pdschPaPdschConfiDedicated.pa

Definition at line 77 of file lte-ffr-simple.h.

Constructor & Destructor Documentation

ns3::LteFfrSimple::LteFfrSimple ( )

Creates a trivial ffr algorithm instance.

Definition at line 33 of file lte-ffr-simple.cc.

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

ns3::LteFfrSimple::~LteFfrSimple ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::LteFfrSimple::ChangePdschConfigDedicated ( bool  change)
void ns3::LteFfrSimple::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 59 of file lte-ffr-simple.cc.

References m_ffrRrcSapProvider, m_ffrSapProvider, and NS_LOG_FUNCTION.

std::vector< bool > ns3::LteFfrSimple::DoGetAvailableDlRbg ( )
protectedvirtual

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 179 of file lte-ffr-simple.cc.

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

+ Here is the call graph for this function:

std::vector< bool > ns3::LteFfrSimple::DoGetAvailableUlRbg ( )
protectedvirtual

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 206 of file lte-ffr-simple.cc.

References ns3::LteFfrAlgorithm::m_ulBandwidth, m_ulOffset, m_ulRbgMap, m_ulSubBand, and NS_LOG_FUNCTION.

uint8_t ns3::LteFfrSimple::DoGetMinContinuousUlBandwidth ( )
protectedvirtual

DoGetMinContinuousUlBandwidth in number of RB.

Returns
number of RB in min continous UL Bandwidth

Implements ns3::LteFfrAlgorithm.

Definition at line 274 of file lte-ffr-simple.cc.

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

uint8_t ns3::LteFfrSimple::DoGetTpc ( uint16_t  rnti)
protectedvirtual

DoGetTpc for UE.

Parameters
rnti
Returns
TPC value

Implements ns3::LteFfrAlgorithm.

Definition at line 249 of file lte-ffr-simple.cc.

References m_acculumatedMode, m_tpc, m_tpcNum, and NS_LOG_FUNCTION.

bool ns3::LteFfrSimple::DoIsDlRbgAvailableForUe ( int  rbId,
uint16_t  rnti 
)
protectedvirtual

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

Implements ns3::LteFfrAlgorithm.

Definition at line 199 of file lte-ffr-simple.cc.

References NS_LOG_FUNCTION.

bool ns3::LteFfrSimple::DoIsUlRbgAvailableForUe ( int  rbId,
uint16_t  rnti 
)
protectedvirtual

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

Implements ns3::LteFfrAlgorithm.

Definition at line 224 of file lte-ffr-simple.cc.

References NS_LOG_FUNCTION.

void ns3::LteFfrSimple::DoRecvLoadInformation ( EpcX2Sap::LoadInformationParams  params)
protectedvirtual

DoRecvLoadInformation.

Parameters
params

Implements ns3::LteFfrAlgorithm.

Definition at line 322 of file lte-ffr-simple.cc.

References NS_LOG_FUNCTION.

void ns3::LteFfrSimple::DoReportDlCqiInfo ( const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters params)
protectedvirtual

DoReportDlCqiInfo.

Parameters
params

Implements ns3::LteFfrAlgorithm.

Definition at line 231 of file lte-ffr-simple.cc.

References NS_LOG_FUNCTION.

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

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

Implements ns3::LteFfrAlgorithm.

Definition at line 281 of file lte-ffr-simple.cc.

References ns3::LteRrcSap::PdschConfigDedicated::dB0, m_changePdschConfigDedicated, m_ues, ns3::LteRrcSap::MeasResults::measId, NS_LOG_FUNCTION, ns3::LteRrcSap::PdschConfigDedicated::pa, and UpdatePdschConfigDedicated().

+ Here is the call graph for this function:

void ns3::LteFfrSimple::DoReportUlCqiInfo ( const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters params)
protectedvirtual

DoReportUlCqiInfo.

Parameters
params

Implements ns3::LteFfrAlgorithm.

Definition at line 237 of file lte-ffr-simple.cc.

References NS_LOG_FUNCTION.

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

DoReportUlCqiInfo.

Parameters
ulCqiMap

Implements ns3::LteFfrAlgorithm.

Definition at line 243 of file lte-ffr-simple.cc.

References NS_LOG_FUNCTION.

LteFfrRrcSapProvider * ns3::LteFfrSimple::GetLteFfrRrcSapProvider ( )
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

Implements ns3::LteFfrAlgorithm.

Definition at line 126 of file lte-ffr-simple.cc.

References m_ffrRrcSapProvider, and NS_LOG_FUNCTION.

LteFfrSapProvider * ns3::LteFfrSimple::GetLteFfrSapProvider ( )
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

Implements ns3::LteFfrAlgorithm.

Definition at line 111 of file lte-ffr-simple.cc.

References m_ffrSapProvider, and NS_LOG_FUNCTION.

TypeId ns3::LteFfrSimple::GetTypeId ( void  )
static
void ns3::LteFfrSimple::Reconfigure ( )
protectedvirtual

Automatic FR reconfiguration.

Implements ns3::LteFfrAlgorithm.

Definition at line 153 of file lte-ffr-simple.cc.

References NS_LOG_FUNCTION.

void ns3::LteFfrSimple::SetLteFfrRrcSapUser ( LteFfrRrcSapUser s)
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

Implements ns3::LteFfrAlgorithm.

Definition at line 118 of file lte-ffr-simple.cc.

References m_ffrRrcSapUser, and NS_LOG_FUNCTION.

void ns3::LteFfrSimple::SetLteFfrSapUser ( LteFfrSapUser s)
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

Implements ns3::LteFfrAlgorithm.

Definition at line 103 of file lte-ffr-simple.cc.

References m_ffrSapUser, and NS_LOG_FUNCTION.

void ns3::LteFfrSimple::SetPdschConfigDedicated ( LteRrcSap::PdschConfigDedicated  pdschConfigDedicated)
void ns3::LteFfrSimple::SetTpc ( uint32_t  tpc,
uint32_t  num,
bool  acculumatedMode 
)

Definition at line 171 of file lte-ffr-simple.cc.

References m_acculumatedMode, m_tpc, and m_tpcNum.

Referenced by LteUplinkPowerControlTestCase::SetTpcConfiguration().

+ Here is the caller graph for this function:

void ns3::LteFfrSimple::UpdatePdschConfigDedicated ( )
private

Definition at line 305 of file lte-ffr-simple.cc.

References m_changePdschConfigDedicatedTrace, m_ffrRrcSapUser, m_pdschConfigDedicated, m_ues, NS_LOG_FUNCTION, ns3::LteRrcSap::PdschConfigDedicated::pa, and ns3::LteFfrRrcSapUser::SetPdschConfigDedicated().

Referenced by DoReportUeMeas().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Friends And Related Function Documentation

friend class MemberLteFfrRrcSapProvider< LteFfrSimple >
friend

Definition at line 69 of file lte-ffr-simple.h.

friend class MemberLteFfrSapProvider< LteFfrSimple >
friend

Definition at line 68 of file lte-ffr-simple.h.

Member Data Documentation

bool ns3::LteFfrSimple::m_acculumatedMode
private

Definition at line 137 of file lte-ffr-simple.h.

Referenced by DoGetTpc(), and SetTpc().

bool ns3::LteFfrSimple::m_changePdschConfigDedicated
private

Definition at line 127 of file lte-ffr-simple.h.

Referenced by ChangePdschConfigDedicated(), and DoReportUeMeas().

TracedCallback<uint16_t, uint8_t> ns3::LteFfrSimple::m_changePdschConfigDedicatedTrace
private

Definition at line 131 of file lte-ffr-simple.h.

Referenced by GetTypeId(), and UpdatePdschConfigDedicated().

uint8_t ns3::LteFfrSimple::m_dlOffset
private

Definition at line 113 of file lte-ffr-simple.h.

Referenced by DoGetAvailableDlRbg(), and GetTypeId().

std::vector<bool> ns3::LteFfrSimple::m_dlRbgMap
private

Definition at line 119 of file lte-ffr-simple.h.

Referenced by DoGetAvailableDlRbg().

uint8_t ns3::LteFfrSimple::m_dlSubBand
private

Definition at line 114 of file lte-ffr-simple.h.

Referenced by DoGetAvailableDlRbg(), and GetTypeId().

LteFfrRrcSapProvider* ns3::LteFfrSimple::m_ffrRrcSapProvider
private

Definition at line 111 of file lte-ffr-simple.h.

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

LteFfrRrcSapUser* ns3::LteFfrSimple::m_ffrRrcSapUser
private

Definition at line 110 of file lte-ffr-simple.h.

Referenced by DoInitialize(), SetLteFfrRrcSapUser(), and UpdatePdschConfigDedicated().

LteFfrSapProvider* ns3::LteFfrSimple::m_ffrSapProvider
private

Definition at line 107 of file lte-ffr-simple.h.

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

LteFfrSapUser* ns3::LteFfrSimple::m_ffrSapUser
private

Definition at line 106 of file lte-ffr-simple.h.

Referenced by SetLteFfrSapUser().

uint8_t ns3::LteFfrSimple::m_measId
private

Definition at line 125 of file lte-ffr-simple.h.

Referenced by DoInitialize().

LteRrcSap::PdschConfigDedicated ns3::LteFfrSimple::m_pdschConfigDedicated
private
uint32_t ns3::LteFfrSimple::m_tpc
private

Definition at line 135 of file lte-ffr-simple.h.

Referenced by DoGetTpc(), and SetTpc().

uint32_t ns3::LteFfrSimple::m_tpcNum
private

Definition at line 136 of file lte-ffr-simple.h.

Referenced by DoGetTpc(), and SetTpc().

std::map<uint16_t, LteRrcSap::PdschConfigDedicated> ns3::LteFfrSimple::m_ues
private

Definition at line 122 of file lte-ffr-simple.h.

Referenced by DoReportUeMeas(), and UpdatePdschConfigDedicated().

uint8_t ns3::LteFfrSimple::m_ulOffset
private

Definition at line 116 of file lte-ffr-simple.h.

Referenced by DoGetAvailableUlRbg(), and GetTypeId().

std::vector<bool> ns3::LteFfrSimple::m_ulRbgMap
private

Definition at line 120 of file lte-ffr-simple.h.

Referenced by DoGetAvailableUlRbg().

uint8_t ns3::LteFfrSimple::m_ulSubBand
private

Definition at line 117 of file lte-ffr-simple.h.

Referenced by DoGetAvailableUlRbg(), and GetTypeId().


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