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

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

#include "lte-handover-management-sap.h"

+ Inheritance diagram for ns3::MemberLteHandoverManagementSapUser< C >:
+ Collaboration diagram for ns3::MemberLteHandoverManagementSapUser< C >:

Public Member Functions

 MemberLteHandoverManagementSapUser ()=delete
 
 MemberLteHandoverManagementSapUser (C *owner)
 Constructor. More...
 
virtual std::vector< uint8_t > AddUeMeasReportConfigForHandover (LteRrcSap::ReportConfigEutra reportConfig)
 Request a certain reporting configuration to be fulfilled by the UEs attached to the eNodeB entity. More...
 
virtual void TriggerHandover (uint16_t rnti, uint16_t targetCellId)
 Instruct the eNodeB RRC entity to prepare a handover. More...
 
- Public Member Functions inherited from ns3::LteHandoverManagementSapUser
virtual ~LteHandoverManagementSapUser ()
 
virtual std::vector< uint8_t > AddUeMeasReportConfigForHandover (LteRrcSap::ReportConfigEutra reportConfig)=0
 Request a certain reporting configuration to be fulfilled by the UEs attached to the eNodeB entity. More...
 
virtual void TriggerHandover (uint16_t rnti, uint16_t targetCellId)=0
 Instruct the eNodeB RRC entity to prepare a handover. More...
 

Private Attributes

C * m_owner
 the owner class More...
 

Detailed Description

template<class C>
class ns3::MemberLteHandoverManagementSapUser< C >

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

Definition at line 159 of file lte-handover-management-sap.h.

Constructor & Destructor Documentation

◆ MemberLteHandoverManagementSapUser() [1/2]

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

Constructor.

Parameters
ownerthe owner class

Definition at line 183 of file lte-handover-management-sap.h.

◆ MemberLteHandoverManagementSapUser() [2/2]

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

Member Function Documentation

◆ AddUeMeasReportConfigForHandover()

template<class C >
std::vector< uint8_t > ns3::MemberLteHandoverManagementSapUser< C >::AddUeMeasReportConfigForHandover ( LteRrcSap::ReportConfigEutra  reportConfig)
virtual

Request a certain reporting configuration to be fulfilled by the UEs attached to the eNodeB entity.

Parameters
reportConfigthe UE measurement reporting configuration
Returns
the measurement identities associated with this newly added reporting configuration

The eNodeB RRC entity is expected to configure the same reporting configuration in each of the attached UEs. When later in the simulation a UE measurement report is received from a UE as a result of this configuration, the eNodeB RRC entity shall forward this report to the handover algorithm through the LteHandoverManagementSapProvider::ReportUeMeas SAP function.

Note
This function is only valid before the simulation begins.

Implements ns3::LteHandoverManagementSapUser.

Definition at line 191 of file lte-handover-management-sap.h.

◆ TriggerHandover()

template<class C >
void ns3::MemberLteHandoverManagementSapUser< C >::TriggerHandover ( uint16_t  rnti,
uint16_t  targetCellId 
)
virtual

Instruct the eNodeB RRC entity to prepare a handover.

Parameters
rntiRadio Network Temporary Identity, an integer identifying the UE which shall perform the handover
targetCellIdthe cell ID of the target eNodeB

This function is used by the handover algorithm entity when a handover decision has been reached.

The process to produce the decision is up to the implementation of handover algorithm. It is typically based on the reported UE measurements, which are received through the LteHandoverManagementSapProvider::ReportUeMeas function.

Implements ns3::LteHandoverManagementSapUser.

Definition at line 199 of file lte-handover-management-sap.h.

Member Data Documentation

◆ m_owner

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

the owner class

Definition at line 177 of file lte-handover-management-sap.h.


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