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

MemberLteCcmRrcSapUser class. More...

#include "lte-ccm-rrc-sap.h"

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

Public Member Functions

 MemberLteCcmRrcSapUser (C *owner)
 Constructor. More...
 
virtual void AddLcs (std::vector< LteEnbRrcSapProvider::LogicalChannelConfig > lcConfig)
 add a new Logical Channel (LC) More...
 
virtual uint8_t AddUeMeasReportConfigForComponentCarrier (LteRrcSap::ReportConfigEutra reportConfig)
 Request a certain reporting configuration to be fulfilled by the UEs attached to the eNodeB entity. More...
 
virtual Ptr< UeManagerGetUeManager (uint16_t rnti)
 Get UE manager by RNTI. More...
 
virtual void ReleaseLcs (uint16_t rnti, uint8_t lcid)
 remove an existing LC More...
 
virtual void SetNumberOfComponentCarriers (uint16_t noOfComponentCarriers)
 Set the number of component carriers. More...
 
virtual void TriggerComponentCarrier (uint16_t rnti, uint16_t targetCellId)
 Instruct the eNodeB RRC entity to prepare a component carrier. More...
 
- Public Member Functions inherited from ns3::LteCcmRrcSapUser
virtual ~LteCcmRrcSapUser ()
 

Private Attributes

C * m_owner
 the owner class More...
 

Detailed Description

template<class C>
class ns3::MemberLteCcmRrcSapUser< C >

MemberLteCcmRrcSapUser class.

Definition at line 299 of file lte-ccm-rrc-sap.h.

Constructor & Destructor Documentation

◆ MemberLteCcmRrcSapUser()

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

Constructor.

Parameters
ownerthe owner class

Definition at line 322 of file lte-ccm-rrc-sap.h.

Member Function Documentation

◆ AddLcs()

template<class C >
void ns3::MemberLteCcmRrcSapUser< C >::AddLcs ( std::vector< LteEnbRrcSapProvider::LogicalChannelConfig lcConfig)
virtual

add a new Logical Channel (LC)

Parameters
lcConfigis a single structure contains logical Channel Id, Logical Channel config and Component Carrier Id

Implements ns3::LteCcmRrcSapUser.

Definition at line 328 of file lte-ccm-rrc-sap.h.

References NS_FATAL_ERROR.

◆ AddUeMeasReportConfigForComponentCarrier()

template<class C >
uint8_t ns3::MemberLteCcmRrcSapUser< C >::AddUeMeasReportConfigForComponentCarrier ( 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 identity 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 ComponentCarrier algorithm through the LteCcmRrcSapProvider::ReportUeMeas SAP function.

Note
This function is only valid before the simulation begins.

Implements ns3::LteCcmRrcSapUser.

Definition at line 344 of file lte-ccm-rrc-sap.h.

◆ GetUeManager()

template<class C >
Ptr< UeManager > ns3::MemberLteCcmRrcSapUser< C >::GetUeManager ( uint16_t  rnti)
virtual

Get UE manager by RNTI.

Parameters
rntiRNTI
Returns
UE manager

Implements ns3::LteCcmRrcSapUser.

Definition at line 359 of file lte-ccm-rrc-sap.h.

◆ ReleaseLcs()

template<class C >
void ns3::MemberLteCcmRrcSapUser< C >::ReleaseLcs ( uint16_t  rnti,
uint8_t  lcid 
)
virtual

remove an existing LC

Parameters
rnti
lcid

Implements ns3::LteCcmRrcSapUser.

Definition at line 335 of file lte-ccm-rrc-sap.h.

References NS_FATAL_ERROR.

◆ SetNumberOfComponentCarriers()

template<class C >
void ns3::MemberLteCcmRrcSapUser< C >::SetNumberOfComponentCarriers ( uint16_t  noOfComponentCarriers)
virtual

Set the number of component carriers.

Parameters
noOfComponentCarriersThe number of component carriers

Implements ns3::LteCcmRrcSapUser.

Definition at line 366 of file lte-ccm-rrc-sap.h.

◆ TriggerComponentCarrier()

template<class C >
void ns3::MemberLteCcmRrcSapUser< C >::TriggerComponentCarrier ( uint16_t  rnti,
uint16_t  targetCellId 
)
virtual

Instruct the eNodeB RRC entity to prepare a component carrier.

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

This function is used by the ComponentCarrier manager when a decision on component carriers configurations.

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

Implements ns3::LteCcmRrcSapUser.

Definition at line 352 of file lte-ccm-rrc-sap.h.

References NS_FATAL_ERROR.

Member Data Documentation

◆ m_owner

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

the owner class

Definition at line 318 of file lte-ccm-rrc-sap.h.


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