A Discrete-Event Network Simulator
API
ns3::LteUeCphySapUser Class Referenceabstract

Service Access Point (SAP) offered by the UE PHY to the UE RRC for control purposes. More...

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

+ Inheritance diagram for ns3::LteUeCphySapUser:

Classes

struct  UeMeasurementsElement
 Parameters of the ReportUeMeasurements primitive: RSRP [dBm] and RSRQ [dB] See section 5.1.1 and 5.1.3 of TS 36.214. More...
 
struct  UeMeasurementsParameters
 UeMeasurementsParameters structure. More...
 

Public Member Functions

virtual ~LteUeCphySapUser ()
 destructor More...
 
virtual void NotifyInSync ()=0
 Send an in sync indication to UE RRC. More...
 
virtual void NotifyOutOfSync ()=0
 Send an out of sync indication to UE RRC. More...
 
virtual void RecvMasterInformationBlock (uint16_t cellId, LteRrcSap::MasterInformationBlock mib)=0
 Relay an MIB message from the PHY entity to the RRC layer. More...
 
virtual void RecvSystemInformationBlockType1 (uint16_t cellId, LteRrcSap::SystemInformationBlockType1 sib1)=0
 Relay an SIB1 message from the PHY entity to the RRC layer. More...
 
virtual void ReportUeMeasurements (UeMeasurementsParameters params)=0
 Send a report of RSRP and RSRQ values perceived from PSS by the PHY entity (after applying layer-1 filtering) to the RRC layer. More...
 
virtual void ResetSyncIndicationCounter ()=0
 Reset the sync indication counter. More...
 

Detailed Description

Service Access Point (SAP) offered by the UE PHY to the UE RRC for control purposes.

This is the CPHY SAP User, i.e., the part of the SAP that contains the RRC methods called by the PHY

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

Constructor & Destructor Documentation

◆ ~LteUeCphySapUser()

ns3::LteUeCphySapUser::~LteUeCphySapUser ( )
virtual

destructor

Definition at line 29 of file lte-ue-cphy-sap.cc.

Member Function Documentation

◆ NotifyInSync()

virtual void ns3::LteUeCphySapUser::NotifyInSync ( )
pure virtual

Send an in sync indication to UE RRC.

When the number of in-sync indications are equal to N311, RRC stops the T310 timer.

Implemented in ns3::MemberLteUeCphySapUser< C >.

Referenced by ns3::LteUePhy::RlfDetection().

+ Here is the caller graph for this function:

◆ NotifyOutOfSync()

virtual void ns3::LteUeCphySapUser::NotifyOutOfSync ( )
pure virtual

Send an out of sync indication to UE RRC.

When the number of out-of-sync indications are equal to N310, RRC starts the T310 timer.

Implemented in ns3::MemberLteUeCphySapUser< C >.

Referenced by ns3::LteUePhy::RlfDetection().

+ Here is the caller graph for this function:

◆ RecvMasterInformationBlock()

virtual void ns3::LteUeCphySapUser::RecvMasterInformationBlock ( uint16_t  cellId,
LteRrcSap::MasterInformationBlock  mib 
)
pure virtual

Relay an MIB message from the PHY entity to the RRC layer.

This function is typically called after PHY receives an MIB message over the BCH.

Parameters
cellIdthe ID of the eNodeB where the message originates from
mibthe Master Information Block message.

Implemented in ns3::MemberLteUeCphySapUser< C >.

Referenced by ns3::LteUePhy::ReceiveLteControlMessageList().

+ Here is the caller graph for this function:

◆ RecvSystemInformationBlockType1()

virtual void ns3::LteUeCphySapUser::RecvSystemInformationBlockType1 ( uint16_t  cellId,
LteRrcSap::SystemInformationBlockType1  sib1 
)
pure virtual

Relay an SIB1 message from the PHY entity to the RRC layer.

This function is typically called after PHY receives an SIB1 message over the BCH.

Parameters
cellIdthe ID of the eNodeB where the message originates from
sib1the System Information Block Type 1 message

Implemented in ns3::MemberLteUeCphySapUser< C >.

Referenced by ns3::LteUePhy::ReceiveLteControlMessageList().

+ Here is the caller graph for this function:

◆ ReportUeMeasurements()

virtual void ns3::LteUeCphySapUser::ReportUeMeasurements ( UeMeasurementsParameters  params)
pure virtual

Send a report of RSRP and RSRQ values perceived from PSS by the PHY entity (after applying layer-1 filtering) to the RRC layer.

Parameters
paramsthe structure containing a vector of cellId, RSRP and RSRQ

Implemented in ns3::MemberLteUeCphySapUser< C >.

Referenced by ns3::LteUePhy::ReportUeMeasurements().

+ Here is the caller graph for this function:

◆ ResetSyncIndicationCounter()

virtual void ns3::LteUeCphySapUser::ResetSyncIndicationCounter ( )
pure virtual

Reset the sync indication counter.

Resets the sync indication counter of RRC if the Qin or Qout condition is not fulfilled for the number of consecutive frames.

Implemented in ns3::MemberLteUeCphySapUser< C >.

Referenced by ns3::LteUePhy::RlfDetection().

+ Here is the caller graph for this function:

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