Searching...

No Matches

The class implements Component Carrier Manager (CCM) that operates using the Component Carrier Manager SAP interfaces. More...

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

Inheritance diagram for ns3::NrGnbComponentCarrierManager:

Collaboration diagram for ns3::NrGnbComponentCarrierManager:

Classes
struct	NrUeInfo
	Structure to represent UE info. More...

Public Member Functions
virtual NrCcmMacSapUser *	GetNrCcmMacSapUser ()
	This function returns a pointer to the NrCcmMacSapUser interface, which is used by MAC to communicate to CCM when e.g. UL buffer status report is received, or to notify CCM about PRB occupancy, and similar. Functions that are specific for the communication between MAC and CCM.

virtual NrCcmRrcSapProvider *	GetNrCcmRrcSapProvider ()
	Export the "provider" part of the NrComponentCarrier Management SAP interface.

virtual NrMacSapProvider *	GetNrMacSapProvider ()
	Returns the pointer to the NrMacSapProvider interface, the provider of MAC, which is this new architecture served by NrGnbComponentCarrierManager object which will behave as a proxy, and will forward calls between to MAC objects of component carriers based on the logic implemented in the specific component carrier manager.

virtual bool	SetCcmMacSapProviders (uint8_t componentCarrierId, NrCcmMacSapProvider *sap)
	Set NrCcmMacSapProvider interface for the MAC object of the specified component carrier. Through this interface CCM communicates with MAC, e.g. it notifies MAC of the specific carrier when to scheduler UL BSR.

virtual bool	SetMacSapProvider (uint8_t componentCarrierId, NrMacSapProvider *sap)
	Set NrMacSapProvider interface for the MAC object of the specified component carrier.

virtual void	SetNrCcmRrcSapUser (NrCcmRrcSapUser *s)
	Set the "user" part of the NrComponentCarrier Management SAP interface that this NrComponentCarrier algorithm instance will interact with.

virtual void	SetNumberOfComponentCarriers (uint16_t noOfComponentCarriers)
	Sets the total number of component carriers.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
void	DoDispose () override

virtual void	DoReportUeMeas (uint16_t rnti, NrRrcSap::MeasResults measResults)=0
	Implementation of ReportUeMeas.

Protected Attributes
std::map< uint8_t, NrCcmMacSapProvider * >	m_ccmMacSapProviderMap

NrCcmMacSapUser *	m_ccmMacSapUser

NrCcmRrcSapProvider *	m_ccmRrcSapProvider

NrCcmRrcSapUser *	m_ccmRrcSapUser

NrMacSapProvider *	m_macSapProvider

std::map< uint8_t, NrMacSapProvider * >	m_macSapProvidersMap
	A map of pointers to real SAP interfaces of MAC instances.

uint16_t	m_noOfComponentCarriers

Ptr< NrGnbRrc >	m_rrc
	A pointer to the RRC instance of this eNb.

std::map< uint16_t, NrUeInfo >	m_ueInfo
	The map from RNTI to UE information.

Detailed Description

The class implements Component Carrier Manager (CCM) that operates using the Component Carrier Manager SAP interfaces.

CCM receives measurement reports from an eNode RRC instance and is forwarding calls from RLC to MAC layer, and from MAC to RLC.

This class is an abstract class intended to be inherited by subclasses that will implement its virtual methods. The subclasses are compatible with the NrGnbNetDevice class, and are accessible using namespace-based access through ns-3 Config subsystem, and can be installed and configured by NrHelper class.

The communication with the eNodeB RRC instance is done through the Component Carrier Manager SAP interface. The NrGnbComponentCarrierManager instance corresponds to the "provider" part of this interface, while the eNodeB RRC instance takes the role of the "user" part. The following code skeleton establishes the connection between both instances:

Ptr<NrGnbRrc> rrc = ...; Ptr<NrComponentCarrierManager> ccmGnb = ...; rrc->SetNrCcmRrcSapProvider (ccmGnb->GetNrCcmRrcSapProvider ()); ccmGnb->SetNrCcmRrcSapUser (rrc->GetNrCcmRrcSapUser ())

Similarly, NrGnbComponentCarrierManager instance communicates with MAC, and it takes the role of the "user".

However, user rarely needs to use the above code, since it has already been taken care by NrHelper::InstallGnbDevice.

See also: NrCcmRrcSapUser, NrCcmRrcSapProvider, NrCcmMacSapUser, NrCcmMacSapProvider

Config Paths

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

/NodeList/[i]/DeviceList/[i]/$ns3::NrGnbNetDevice/NrGnbComponentCarrierManager
/NodeList/[i]/DeviceList/[i]/$ns3::NrNetDevice/$ns3::NrGnbNetDevice/NrGnbComponentCarrierManager

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

Definition at line 65 of file nr-gnb-component-carrier-manager.h.

Constructor & Destructor Documentation

◆ NrGnbComponentCarrierManager()

ns3::NrGnbComponentCarrierManager::NrGnbComponentCarrierManager ( )

Definition at line 19 of file nr-gnb-component-carrier-manager.cc.

◆ ~NrGnbComponentCarrierManager()

ns3::NrGnbComponentCarrierManager::~NrGnbComponentCarrierManager ( )

override

Definition at line 23 of file nr-gnb-component-carrier-manager.cc.

Member Function Documentation

◆ DoDispose()

void ns3::NrGnbComponentCarrierManager::DoDispose ( )

overrideprotected

Definition at line 36 of file nr-gnb-component-carrier-manager.cc.

◆ DoReportUeMeas()

virtual void ns3::NrGnbComponentCarrierManager::DoReportUeMeas	(	uint16_t	rnti,
		NrRrcSap::MeasResults	measResults
	)

protectedpure virtual

Implementation of ReportUeMeas.

Parameters

rnti	Radio Network Temporary Identity, an integer identifying the UE where the report originates from
measResults	a single report of one measurement identity

Implemented in ns3::NrNoOpComponentCarrierManager.

◆ GetNrCcmMacSapUser()

NrCcmMacSapUser * ns3::NrGnbComponentCarrierManager::GetNrCcmMacSapUser ( )

virtual

This function returns a pointer to the NrCcmMacSapUser interface, which is used by MAC to communicate to CCM when e.g. UL buffer status report is received, or to notify CCM about PRB occupancy, and similar. Functions that are specific for the communication between MAC and CCM.

Returns: NrCcmMacSapUser*

Definition at line 62 of file nr-gnb-component-carrier-manager.cc.

References m_ccmMacSapUser.

◆ GetNrCcmRrcSapProvider()

NrCcmRrcSapProvider * ns3::NrGnbComponentCarrierManager::GetNrCcmRrcSapProvider ( )

virtual

Export 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 NrGnbRlc instance

Definition at line 48 of file nr-gnb-component-carrier-manager.cc.

References m_ccmRrcSapProvider.

◆ GetNrMacSapProvider()

NrMacSapProvider * ns3::NrGnbComponentCarrierManager::GetNrMacSapProvider ( )

virtual

Returns the pointer to the NrMacSapProvider interface, the provider of MAC, which is this new architecture served by NrGnbComponentCarrierManager object which will behave as a proxy, and will forward calls between to MAC objects of component carriers based on the logic implemented in the specific component carrier manager.

Returns: NrMacSapProvider*

Definition at line 55 of file nr-gnb-component-carrier-manager.cc.

References m_macSapProvider.

◆ GetTypeId()

TypeId ns3::NrGnbComponentCarrierManager::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 28 of file nr-gnb-component-carrier-manager.cc.

◆ SetCcmMacSapProviders()

bool ns3::NrGnbComponentCarrierManager::SetCcmMacSapProviders	(	uint8_t	componentCarrierId,
		NrCcmMacSapProvider *	sap
	)

virtual

Set NrCcmMacSapProvider interface for the MAC object of the specified component carrier. Through this interface CCM communicates with MAC, e.g. it notifies MAC of the specific carrier when to scheduler UL BSR.

Parameters