Template for the implementation of the LteUeCphySapProvider as a member of an owner class of type C to which all methods are forwarded. More...

#include "lte-ue-cphy-sap.h"

Inheritance diagram for ns3::MemberLteUeCphySapProvider< C >:

Collaboration diagram for ns3::MemberLteUeCphySapProvider< C >:

Public Member Functions
	MemberLteUeCphySapProvider ()=delete

	MemberLteUeCphySapProvider (C *owner)
	Constructor.

void	ConfigureReferenceSignalPower (int8_t referenceSignalPower) override
	Configure referenceSignalPower.

void	ConfigureUplink (uint32_t ulEarfcn, uint16_t ulBandwidth) override
	Configure uplink (normally done after reception of SIB2)

uint16_t	GetCellId () override
	Get PHY cell ID.

uint32_t	GetDlEarfcn () override
	Get PHY DL EARFCN.

void	Reset () override
	Reset the PHY.

void	ResetPhyAfterRlf () override
	Reset the PHY after radio link failure function It resets the physical layer parameters of the UE after RLF.

void	ResetRlfParams () override
	Reset radio link failure parameters.

void	SetDlBandwidth (uint16_t dlBandwidth) override

void	SetImsi (uint64_t imsi) override
	A method call by UE RRC to communicate the IMSI to the UE PHY.

void	SetPa (double pa) override
	Set P_A value for UE power control.

void	SetRnti (uint16_t rnti) override
	Set Rnti function.

void	SetRsrpFilterCoefficient (uint8_t rsrpFilterCoefficient) override
	Set RSRP filter coefficient.

void	SetSrsConfigurationIndex (uint16_t srcCi) override
	Set SRS configuration index.

void	SetTransmissionMode (uint8_t txMode) override
	Set transmission mode.

void	StartCellSearch (uint32_t dlEarfcn) override
	Tell the PHY entity to listen to PSS from surrounding cells and measure the RSRP.

void	StartInSyncDetection () override
	Start in-sync detection function When T310 timer is started, it indicates that physical layer problems are detected at the UE and the recovery process is started by checking if the radio frames are in-sync for N311 consecutive times.

void	SynchronizeWithEnb (uint16_t cellId) override
	Tell the PHY entity to synchronize with a given eNodeB over the currently active EARFCN for communication purposes.

void	SynchronizeWithEnb (uint16_t cellId, uint32_t dlEarfcn) override
	Tell the PHY entity to align to the given EARFCN and synchronize with a given eNodeB for communication purposes.

Public Member Functions inherited from ns3::LteUeCphySapProvider
virtual	~LteUeCphySapProvider ()
	Destructor.

Private Attributes
C *	m_owner
	the owner class

Detailed Description

template<class C>
class ns3::MemberLteUeCphySapProvider< C >

Template for the implementation of the LteUeCphySapProvider as a member of an owner class of type C to which all methods are forwarded.

Definition at line 290 of file lte-ue-cphy-sap.h.

Constructor & Destructor Documentation

◆ MemberLteUeCphySapProvider() [1/2]

template<class C >

ns3::MemberLteUeCphySapProvider< C >::MemberLteUeCphySapProvider ( C * owner )

Constructor.

Parameters

owner the owner class

Definition at line 328 of file lte-ue-cphy-sap.h.

◆ MemberLteUeCphySapProvider() [2/2]

template<class C >

ns3::MemberLteUeCphySapProvider< C >::MemberLteUeCphySapProvider ( )

delete

Member Function Documentation

◆ ConfigureReferenceSignalPower()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::ConfigureReferenceSignalPower ( int8_t referenceSignalPower )

overridevirtual

Configure referenceSignalPower.

Parameters

referenceSignalPower received from eNB in SIB2

Implements ns3::LteUeCphySapProvider.

Definition at line 391 of file lte-ue-cphy-sap.h.

◆ ConfigureUplink()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::ConfigureUplink	(	uint32_t	ulEarfcn,
		uint16_t	ulBandwidth )

overridevirtual

Configure uplink (normally done after reception of SIB2)

Parameters

ulEarfcn	the uplink carrier frequency (EARFCN)
ulBandwidth	the UL bandwidth in number of PRBs

Implements ns3::LteUeCphySapProvider.

Definition at line 384 of file lte-ue-cphy-sap.h.

◆ GetCellId()

template<class C >

uint16_t ns3::MemberLteUeCphySapProvider< C >::GetCellId ( )

overridevirtual

Get PHY cell ID.

Returns: cell ID this PHY is synchronized to

Implements ns3::LteUeCphySapProvider.

Definition at line 363 of file lte-ue-cphy-sap.h.

◆ GetDlEarfcn()

template<class C >

uint32_t ns3::MemberLteUeCphySapProvider< C >::GetDlEarfcn ( )

overridevirtual

Get PHY DL EARFCN.

Returns: DL EARFCN this PHY is synchronized to

Implements ns3::LteUeCphySapProvider.

Definition at line 370 of file lte-ue-cphy-sap.h.

◆ Reset()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::Reset ( )

overridevirtual

Reset the PHY.

Implements ns3::LteUeCphySapProvider.

Definition at line 335 of file lte-ue-cphy-sap.h.

◆ ResetPhyAfterRlf()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::ResetPhyAfterRlf ( )

overridevirtual

Reset the PHY after radio link failure function It resets the physical layer parameters of the UE after RLF.

Implements ns3::LteUeCphySapProvider.

Definition at line 433 of file lte-ue-cphy-sap.h.

◆ ResetRlfParams()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::ResetRlfParams ( )

overridevirtual

Reset radio link failure parameters.

Upon receiving N311 in-sync indications from the UE PHY the UE RRC instructs the UE PHY to reset the RLF parameters so, it can start RLF detection again.

Implements ns3::LteUeCphySapProvider.

Definition at line 440 of file lte-ue-cphy-sap.h.

◆ SetDlBandwidth()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::SetDlBandwidth ( uint16_t dlBandwidth )

overridevirtual

Parameters

dlBandwidth the DL bandwidth in number of PRBs

Implements ns3::LteUeCphySapProvider.

Definition at line 377 of file lte-ue-cphy-sap.h.

◆ SetImsi()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::SetImsi ( uint64_t imsi )

overridevirtual

A method call by UE RRC to communicate the IMSI to the UE PHY.

Parameters

imsi	the IMSI of the UE

Implements ns3::LteUeCphySapProvider.

Definition at line 454 of file lte-ue-cphy-sap.h.

◆ SetPa()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::SetPa ( double pa )

overridevirtual

Set P_A value for UE power control.

Parameters

pa	the P_A value

Implements ns3::LteUeCphySapProvider.

Definition at line 419 of file lte-ue-cphy-sap.h.

◆ SetRnti()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::SetRnti ( uint16_t rnti )

overridevirtual

Set Rnti function.

Parameters

rnti	the cell-specific UE identifier

Implements ns3::LteUeCphySapProvider.

Definition at line 398 of file lte-ue-cphy-sap.h.

◆ SetRsrpFilterCoefficient()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::SetRsrpFilterCoefficient ( uint8_t rsrpFilterCoefficient )

overridevirtual

Set RSRP filter coefficient.

Determines the strength of smoothing effect induced by layer 3 filtering of RSRP used for uplink power control in all attached UE. If equals to 0, no layer 3 filtering is applicable.

Parameters

rsrpFilterCoefficient value.

Implements ns3::LteUeCphySapProvider.

Definition at line 426 of file lte-ue-cphy-sap.h.

◆ SetSrsConfigurationIndex()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::SetSrsConfigurationIndex ( uint16_t srcCi )

overridevirtual

Set SRS configuration index.

Parameters

srcCi the SRS configuration index

Implements ns3::LteUeCphySapProvider.

Definition at line 412 of file lte-ue-cphy-sap.h.

◆ SetTransmissionMode()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::SetTransmissionMode ( uint8_t txMode )

overridevirtual

Set transmission mode.

Parameters

txMode the transmissionMode of the user

Implements ns3::LteUeCphySapProvider.

Definition at line 405 of file lte-ue-cphy-sap.h.

◆ StartCellSearch()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::StartCellSearch ( uint32_t dlEarfcn )

overridevirtual

Tell the PHY entity to listen to PSS from surrounding cells and measure the RSRP.

Parameters

dlEarfcn the downlink carrier frequency (EARFCN) to listen to

This function will instruct this PHY instance to listen to the DL channel over the bandwidth of 6 RB at the frequency associated with the given EARFCN.

After this, it will start receiving Primary Synchronization Signal (PSS) and periodically returning measurement reports to RRC via LteUeCphySapUser::ReportUeMeasurements function.

Implements ns3::LteUeCphySapProvider.

Definition at line 342 of file lte-ue-cphy-sap.h.

◆ StartInSyncDetection()

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::StartInSyncDetection ( )

overridevirtual

Start in-sync detection function When T310 timer is started, it indicates that physical layer problems are detected at the UE and the recovery process is started by checking if the radio frames are in-sync for N311 consecutive times.

Implements ns3::LteUeCphySapProvider.

Definition at line 447 of file lte-ue-cphy-sap.h.

◆ SynchronizeWithEnb() [1/2]

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::SynchronizeWithEnb ( uint16_t cellId )

overridevirtual

Tell the PHY entity to synchronize with a given eNodeB over the currently active EARFCN for communication purposes.

Parameters

cellId the ID of the eNodeB to synchronize with

By synchronizing, the PHY will start receiving various information transmitted by the eNodeB. For instance, when receiving system information, the message will be relayed to RRC via LteUeCphySapUser::RecvMasterInformationBlock and LteUeCphySapUser::RecvSystemInformationBlockType1 functions.

Initially, the PHY will be configured to listen to 6 RBs of BCH. LteUeCphySapProvider::SetDlBandwidth can be called afterwards to increase the bandwidth.

Implements ns3::LteUeCphySapProvider.

Definition at line 349 of file lte-ue-cphy-sap.h.

◆ SynchronizeWithEnb() [2/2]

template<class C >

void ns3::MemberLteUeCphySapProvider< C >::SynchronizeWithEnb	(	uint16_t	cellId,
		uint32_t	dlEarfcn )

overridevirtual

Tell the PHY entity to align to the given EARFCN and synchronize with a given eNodeB for communication purposes.

Parameters

cellId	the ID of the eNodeB to synchronize with
dlEarfcn	the downlink carrier frequency (EARFCN)

By synchronizing, the PHY will start receiving various information transmitted by the eNodeB. For instance, when receiving system information, the message will be relayed to RRC via LteUeCphySapUser::RecvMasterInformationBlock and LteUeCphySapUser::RecvSystemInformationBlockType1 functions.

Initially, the PHY will be configured to listen to 6 RBs of BCH. LteUeCphySapProvider::SetDlBandwidth can be called afterwards to increase the bandwidth.

Implements ns3::LteUeCphySapProvider.

Definition at line 356 of file lte-ue-cphy-sap.h.

Member Data Documentation

◆ m_owner

template<class C >

C* ns3::MemberLteUeCphySapProvider< C >::m_owner

private

the owner class

Definition at line 324 of file lte-ue-cphy-sap.h.

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

src/lte/model/lte-ue-cphy-sap.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MemberLteUeCphySapProvider() [1/2]

◆ MemberLteUeCphySapProvider() [2/2]

Member Function Documentation

◆ ConfigureReferenceSignalPower()

◆ ConfigureUplink()

◆ GetCellId()

◆ GetDlEarfcn()

◆ Reset()

◆ ResetPhyAfterRlf()

◆ ResetRlfParams()

◆ SetDlBandwidth()

◆ SetImsi()

◆ SetPa()

◆ SetRnti()

◆ SetRsrpFilterCoefficient()

◆ SetSrsConfigurationIndex()

◆ SetTransmissionMode()

◆ StartCellSearch()

◆ StartInSyncDetection()

◆ SynchronizeWithEnb() [1/2]

◆ SynchronizeWithEnb() [2/2]

Member Data Documentation

◆ m_owner