A Discrete-Event Network Simulator
API
ns3::MemberLteUeCphySapUser< C > Class Template Reference

Template for the implementation of the LteUeCphySapUser 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::MemberLteUeCphySapUser< C >:
+ Collaboration diagram for ns3::MemberLteUeCphySapUser< C >:

Public Member Functions

 MemberLteUeCphySapUser ()=delete
 
 MemberLteUeCphySapUser (C *owner)
 Constructor. More...
 
void NotifyInSync () override
 Send an in sync indication to UE RRC. More...
 
void NotifyOutOfSync () override
 Send an out of sync indication to UE RRC. More...
 
void RecvMasterInformationBlock (uint16_t cellId, LteRrcSap::MasterInformationBlock mib) override
 Relay an MIB message from the PHY entity to the RRC layer. More...
 
void RecvSystemInformationBlockType1 (uint16_t cellId, LteRrcSap::SystemInformationBlockType1 sib1) override
 Relay an SIB1 message from the PHY entity to the RRC layer. More...
 
void ReportUeMeasurements (LteUeCphySapUser::UeMeasurementsParameters params) override
 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...
 
void ResetSyncIndicationCounter () override
 Reset the sync indication counter. More...
 
- Public Member Functions inherited from ns3::LteUeCphySapUser
virtual ~LteUeCphySapUser ()
 destructor More...
 

Private Attributes

C * m_owner
 the owner class More...
 

Detailed Description

template<class C>
class ns3::MemberLteUeCphySapUser< C >

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

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

Constructor & Destructor Documentation

◆ MemberLteUeCphySapUser() [1/2]

template<class C >
ns3::MemberLteUeCphySapUser< C >::MemberLteUeCphySapUser ( C *  owner)

Constructor.

Parameters
ownerthe owner class

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

◆ MemberLteUeCphySapUser() [2/2]

template<class C >
ns3::MemberLteUeCphySapUser< C >::MemberLteUeCphySapUser ( )
delete

Member Function Documentation

◆ NotifyInSync()

template<class C >
void ns3::MemberLteUeCphySapUser< C >::NotifyInSync ( )
overridevirtual

Send an in sync indication to UE RRC.

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

Implements ns3::LteUeCphySapUser.

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

◆ NotifyOutOfSync()

template<class C >
void ns3::MemberLteUeCphySapUser< C >::NotifyOutOfSync ( )
overridevirtual

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.

Implements ns3::LteUeCphySapUser.

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

◆ RecvMasterInformationBlock()

template<class C >
void ns3::MemberLteUeCphySapUser< C >::RecvMasterInformationBlock ( uint16_t  cellId,
LteRrcSap::MasterInformationBlock  mib 
)
overridevirtual

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.

Implements ns3::LteUeCphySapUser.

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

◆ RecvSystemInformationBlockType1()

template<class C >
void ns3::MemberLteUeCphySapUser< C >::RecvSystemInformationBlockType1 ( uint16_t  cellId,
LteRrcSap::SystemInformationBlockType1  sib1 
)
overridevirtual

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

Implements ns3::LteUeCphySapUser.

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

◆ ReportUeMeasurements()

template<class C >
void ns3::MemberLteUeCphySapUser< C >::ReportUeMeasurements ( LteUeCphySapUser::UeMeasurementsParameters  params)
overridevirtual

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

Implements ns3::LteUeCphySapUser.

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

References two-ray-to-three-gpp-ch-calibration::params.

◆ ResetSyncIndicationCounter()

template<class C >
void ns3::MemberLteUeCphySapUser< C >::ResetSyncIndicationCounter ( )
overridevirtual

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.

Implements ns3::LteUeCphySapUser.

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

Member Data Documentation

◆ m_owner

template<class C >
C* ns3::MemberLteUeCphySapUser< C >::m_owner
private

the owner class

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


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