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

Public Member Functions
	MemberLteUeCphySapProvider (C *owner)
	Constructor. More...

virtual void	ConfigureReferenceSignalPower (int8_t referenceSignalPower)
	Configure referenceSignalPower. More...

virtual void	ConfigureUplink (uint32_t ulEarfcn, uint8_t ulBandwidth)
	Configure uplink (normally done after reception of SIB2) More...

virtual void	Reset ()
	reset the PHY More...

virtual void	SetDlBandwidth (uint8_t dlBandwidth)

virtual void	SetPa (double pa)

virtual void	SetRnti (uint16_t rnti)

virtual void	SetSrsConfigurationIndex (uint16_t srcCi)

virtual void	SetTransmissionMode (uint8_t txMode)

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

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

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

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

Private Member Functions
	MemberLteUeCphySapProvider ()

Private Attributes
C *	m_owner
	the owner class More...

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 225 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 254 of file lte-ue-cphy-sap.h.

◆ MemberLteUeCphySapProvider() [2/2]

template<class C >

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

private

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

Member Function Documentation

◆ ConfigureReferenceSignalPower()

template<class C >

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

virtual

Configure referenceSignalPower.

Parameters

referenceSignalPower received from eNB in SIB2

Implements ns3::LteUeCphySapProvider.

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

◆ ConfigureUplink()

template<class C >

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

virtual

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 301 of file lte-ue-cphy-sap.h.

◆ Reset()

template<class C >

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

virtual

reset the PHY

Implements ns3::LteUeCphySapProvider.

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

◆ SetDlBandwidth()

template<class C >

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

virtual

Parameters

dlBandwidth the DL bandwidth in number of PRBs

Implements ns3::LteUeCphySapProvider.

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

◆ SetPa()

template<class C >

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

virtual

Parameters

pa	the P_A value

Implements ns3::LteUeCphySapProvider.

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

◆ SetRnti()

template<class C >

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

virtual

Parameters

rnti	the cell-specific UE identifier

Implements ns3::LteUeCphySapProvider.

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

◆ SetSrsConfigurationIndex()

template<class C >

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

virtual

Parameters

srcCi the SRS configuration index

Implements ns3::LteUeCphySapProvider.

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

◆ SetTransmissionMode()

template<class C >

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

virtual

Parameters

txMode the transmissionMode of the user

Implements ns3::LteUeCphySapProvider.

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

◆ StartCellSearch()

template<class C >

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

virtual

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 273 of file lte-ue-cphy-sap.h.

◆ SynchronizeWithEnb() [1/2]

template<class C >

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

virtual

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 280 of file lte-ue-cphy-sap.h.

◆ SynchronizeWithEnb() [2/2]

template<class C >

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

virtual

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 287 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 250 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 Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ MemberLteUeCphySapProvider() [1/2]

◆ MemberLteUeCphySapProvider() [2/2]

Member Function Documentation

◆ ConfigureReferenceSignalPower()

◆ ConfigureUplink()

◆ Reset()

◆ SetDlBandwidth()

◆ SetPa()

◆ SetRnti()

◆ SetSrsConfigurationIndex()

◆ SetTransmissionMode()

◆ StartCellSearch()

◆ SynchronizeWithEnb() [1/2]

◆ SynchronizeWithEnb() [2/2]

Member Data Documentation

◆ m_owner

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