LtePhyUe

simple module

This module extends the LtePhyBase(1,2) module by providing specific PHY functions on the User Equipment (UE) side. It ensures that frames received on the air interface are sourced from the serving eNodeB (eNB) and provides functions to manage the handover procedure, including periodic measurement of channel conditions to determine when a handover should occur. If enabled, the selection of the serving eNB at initialization is done dynamically based on radio conditions.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Known subclasses

Name	Type	Description
LtePhyUeD2D	simple module	This module extends LTE PHY functionalities at the User Equipment side to support device-to-device (D2D) communications. Specifically, it customizes the LtePhyUe functionalities to support the transmission and reception of frames to another UE directly, without going through the serving eNodeB. It also supports one-to-many D2D transmission to UEs belonging to a multicast group. It is assumed that one-to-one D2D communication is only possible when both endpoints are served by the same eNodeB. When a handover is triggered, this module is responsible for initiating a mode switch from direct (D2D) mode to infrastructure mode.

Extends

Name	Type	Description
LtePhyBase	simple module	Base module for the Physical (PHY) layer of the LTE protocol stack.

Parameters

Name	Type	Default value	Description
ueTxPower	double	26dBm
eNodeBTxPower	double	46dBm
microTxPower	double	30dBm
txDirection	string	"OMNI"
txAngle	double	0deg
dynamicCellAssociation	bool	false
enableHandover	bool	false	switch for handover messages handling on UEs
handoverLatency	double	0.05s
enableMulticastD2DRangeCheck	bool	false	TODO move to LtePhyUeD2D module
multicastD2DRange	double	1000m
binderModule	string	"binder"
channelModelModule	string	"^.channelModel[0]"	or "nrChannelModel[0]"
rlcUmModule	string	"^.rlc.um"	or "^.nrRlc.um"
pdcpRrcModule	string	"^.pdcpRrc"
ip2nicModule	string	"^.ip2nic"
feedbackGeneratorModule	string	"^.dlFbGen"	TODO or "^.nrDlFbGen"
minRssiDefault	bool	true	if true, get minRssi from PhyPisaData
minRssi	double	-99.0dB	configurable minimum threshold RSSI for attaching to an eNB (meaningful only if minRssiDefault==false)
hasCollector	bool	false	true when node has a collector module (ueCollector/NRueCollector) for this PHY module

Properties

Name	Value	Description
display	i=block/wrxtx
class	LtePhyUe

Gates

Name	Direction	Description
upperGateIn	input	from upper layer
upperGateOut	output	to upper layer
radioIn	input	gate to receive message via sendDirect

Signals

Name	Type	Unit	Description
distance
servingCell
averageCqiDl
averageCqiUl

Statistics

Name	Title	Source	Record	Unit
distance	distance between UE and serving base station	distance	mean, vector	meters
servingCell	ID of the serving cell for the UE	servingCell	vector
averageCqiDl	Average Cqi reported in DL	averageCqiDl	mean, count, vector	cqi
averageCqiUl	Average Cqi reported in UL	averageCqiUl	mean, count, vector	cqi

Source code

//
// This module extends the ~LtePhyBase module by providing specific PHY functions
// on the User Equipment (UE) side. It ensures that frames received on the air interface
// are sourced from the serving eNodeB (eNB) and provides functions to manage the handover procedure,
// including periodic measurement of channel conditions to determine when a handover should
// occur. If enabled, the selection of the serving eNB at initialization is done dynamically
// based on radio conditions.
//
simple LtePhyUe extends LtePhyBase
{
    parameters:
        @class("LtePhyUe");

        string rlcUmModule = default("^.rlc.um"); // or "^.nrRlc.um"
        string pdcpRrcModule = default("^.pdcpRrc");
        string ip2nicModule = default("^.ip2nic");
        string feedbackGeneratorModule = default("^.dlFbGen"); // TODO or "^.nrDlFbGen"

        // if true, get minRssi from PhyPisaData
        bool minRssiDefault = default(true);

        // configurable minimum threshold RSSI for attaching to an eNB (meaningful only if minRssiDefault==false)
        double minRssi @unit("dB") = default(-99.0dB);

        bool hasCollector = default(false); // true when node has a collector module (ueCollector/NRueCollector) for this PHY module

        @signal[distance];
        @statistic[distance](title="distance between UE and serving base station"; unit="meters"; source="distance"; record=mean,vector);

        @signal[servingCell];
        @statistic[servingCell](title="ID of the serving cell for the UE"; unit=""; source="servingCell"; record=vector);

        //# CQI statistics
        @signal[averageCqiDl];
        @statistic[averageCqiDl](title="Average Cqi reported in DL"; unit="cqi"; source="averageCqiDl"; record=mean,count,vector);
        @signal[averageCqiUl];
        @statistic[averageCqiUl](title="Average Cqi reported in UL"; unit="cqi"; source="averageCqiUl"; record=mean,count,vector);
}

File: src/stack/phy/LtePhyUe.ned