5G-LENA nr-v4.0
The 5G/NR module for the ns-3 simulator
Loading...
Searching...
No Matches
ns3::NrUeComponentCarrierManager Class Referenceabstract

The abstract base class of a Component Carrier Manager* for UE that operates using the component carrier manager SAP interface. More...

#include "nr-ue-component-carrier-manager.h"

+ Inheritance diagram for ns3::NrUeComponentCarrierManager:
+ Collaboration diagram for ns3::NrUeComponentCarrierManager:

Public Member Functions

virtual NrUeCcmRrcSapProviderGetNrCcmRrcSapProvider ()
 Exports the "provider" part of the NrComponentCarrier Management SAP interface.
 
virtual NrMacSapProviderGetNrMacSapProvider ()=0
 Returns the MAC sap provider interface that if forwarding calls to the instance of the NrUeComponentCarrierManager.
 
bool SetComponentCarrierMacSapProviders (uint8_t componentCarrierId, NrMacSapProvider *sap)
 Sets a pointer to SAP interface of MAC instance for the specified carrier.
 
virtual void SetNrCcmRrcSapUser (NrUeCcmRrcSapUser *s)
 Set the "user" part of the NrComponentCarrier Management SAP interface that this UE component carrier manager will interact with.
 
void SetNumberOfComponentCarriers (uint8_t noOfComponentCarriers)
 Sets number of component carriers that are supported by this UE.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 

Protected Member Functions

void DoDispose () override
 

Protected Attributes

NrUeCcmRrcSapProviderm_ccmRrcSapProvider
 Receive API calls from the UE RRC instance.
 
NrUeCcmRrcSapUserm_ccmRrcSapUser
 Interface to the UE RRC instance.
 
std::map< uint8_t, std::map< uint8_t, NrMacSapProvider * > > m_componentCarrierLcMap
 Flow configuration per flow Id of this UE.
 
std::map< uint8_t, NrMacSapUser * > m_lcAttached
 
std::map< uint8_t, NrMacSapProvider * > m_macSapProvidersMap
 
uint8_t m_noOfComponentCarriers
 The number of component carriers that this UE can support.
 

Detailed Description

The abstract base class of a Component Carrier Manager* for UE that operates using the component carrier manager SAP interface.

Config Paths

ns3::NrUeComponentCarrierManager is accessible through the following paths with Config::Set and Config::Connect:

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 224 bytes (on a 64-bit architecture).

Definition at line 34 of file nr-ue-component-carrier-manager.h.

Constructor & Destructor Documentation

◆ NrUeComponentCarrierManager()

ns3::NrUeComponentCarrierManager::NrUeComponentCarrierManager ( )

Definition at line 21 of file nr-ue-component-carrier-manager.cc.

◆ ~NrUeComponentCarrierManager()

ns3::NrUeComponentCarrierManager::~NrUeComponentCarrierManager ( )
override

Definition at line 29 of file nr-ue-component-carrier-manager.cc.

Member Function Documentation

◆ DoDispose()

void ns3::NrUeComponentCarrierManager::DoDispose ( )
overrideprotected

Definition at line 43 of file nr-ue-component-carrier-manager.cc.

◆ GetNrCcmRrcSapProvider()

NrUeCcmRrcSapProvider * ns3::NrUeComponentCarrierManager::GetNrCcmRrcSapProvider ( )
virtual

Exports the "provider" part of the NrComponentCarrier Management SAP interface.

Returns
the reference to the "provider" part of the interface, typically to be kept by an NrUeRrc instance

Definition at line 56 of file nr-ue-component-carrier-manager.cc.

◆ GetNrMacSapProvider()

virtual NrMacSapProvider * ns3::NrUeComponentCarrierManager::GetNrMacSapProvider ( )
pure virtual

Returns the MAC sap provider interface that if forwarding calls to the instance of the NrUeComponentCarrierManager.

Returns
the reference to the "provider" part of the interface

Implemented in ns3::NrSimpleUeComponentCarrierManager.

◆ GetTypeId()

TypeId ns3::NrUeComponentCarrierManager::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 35 of file nr-ue-component-carrier-manager.cc.

◆ SetComponentCarrierMacSapProviders()

bool ns3::NrUeComponentCarrierManager::SetComponentCarrierMacSapProviders ( uint8_t  componentCarrierId,
NrMacSapProvider sap 
)

Sets a pointer to SAP interface of MAC instance for the specified carrier.

Parameters
componentCarrierIdthe component carrier id
sapthe pointer to the sap interface
Returns
whether the settings of the sap provider was successful

Definition at line 63 of file nr-ue-component-carrier-manager.cc.

◆ SetNrCcmRrcSapUser()

void ns3::NrUeComponentCarrierManager::SetNrCcmRrcSapUser ( NrUeCcmRrcSapUser s)
virtual

Set the "user" part of the NrComponentCarrier Management SAP interface that this UE component carrier manager will interact with.

Parameters
sa reference to the "user" part of the interface, typically a member of an NrGnbRrc instance

Definition at line 49 of file nr-ue-component-carrier-manager.cc.

◆ SetNumberOfComponentCarriers()

void ns3::NrUeComponentCarrierManager::SetNumberOfComponentCarriers ( uint8_t  noOfComponentCarriers)

Sets number of component carriers that are supported by this UE.

Parameters
noOfComponentCarriersnumber of component carriers

Definition at line 87 of file nr-ue-component-carrier-manager.cc.

Member Data Documentation

◆ m_ccmRrcSapProvider

NrUeCcmRrcSapProvider* ns3::NrUeComponentCarrierManager::m_ccmRrcSapProvider
protected

Receive API calls from the UE RRC instance.

Definition at line 87 of file nr-ue-component-carrier-manager.h.

◆ m_ccmRrcSapUser

NrUeCcmRrcSapUser* ns3::NrUeComponentCarrierManager::m_ccmRrcSapUser
protected

Interface to the UE RRC instance.

Definition at line 86 of file nr-ue-component-carrier-manager.h.

◆ m_componentCarrierLcMap

std::map<uint8_t, std::map<uint8_t, NrMacSapProvider*> > ns3::NrUeComponentCarrierManager::m_componentCarrierLcMap
protected

Flow configuration per flow Id of this UE.

Definition at line 92 of file nr-ue-component-carrier-manager.h.

Referenced by ns3::BwpManagerUe::DoTransmitBufferStatusReport().

◆ m_lcAttached

std::map<uint8_t, NrMacSapUser*> ns3::NrUeComponentCarrierManager::m_lcAttached
protected

Map of pointers to SAP interfaces of the RLC instance of the flows of this UE.

Definition at line 89 of file nr-ue-component-carrier-manager.h.

◆ m_macSapProvidersMap

std::map<uint8_t, NrMacSapProvider*> ns3::NrUeComponentCarrierManager::m_macSapProvidersMap
protected

Map of pointers to SAP to interfaces of the MAC instance if the flows of this UE.

Definition at line 95 of file nr-ue-component-carrier-manager.h.

◆ m_noOfComponentCarriers

uint8_t ns3::NrUeComponentCarrierManager::m_noOfComponentCarriers
protected

The number of component carriers that this UE can support.

Definition at line 93 of file nr-ue-component-carrier-manager.h.


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