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

#include "lte-enb-component-carrier-manager.h"

Inheritance diagram for ns3::LteEnbComponentCarrierManager:

Collaboration diagram for ns3::LteEnbComponentCarrierManager:

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

Public Member Functions
	LteEnbComponentCarrierManager ()

virtual	~LteEnbComponentCarrierManager ()

virtual LteCcmMacSapUser *	GetLteCcmMacSapUser ()
	This function returns a pointer to the LteCcmMacSapUser interface, which is used by MAC to communicate to CCM when e.g. More...

virtual LteCcmRrcSapProvider *	GetLteCcmRrcSapProvider ()
	Export the "provider" part of the ComponentCarrier Management SAP interface. More...

virtual LteMacSapProvider *	GetLteMacSapProvider ()
	Returns the pointer to the LteMacSapProvider interface, the provider of MAC, which is this new architecture served by LteEnbComponentCarrierManager 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. More...

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

virtual void	SetLteCcmRrcSapUser (LteCcmRrcSapUser *s)
	Set the "user" part of the ComponentCarrier Management SAP interface that this ComponentCarrier algorithm instance will interact with. More...

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

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

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

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

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Member Functions
virtual void	DoDispose ()
	Destructor implementation. More...

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

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Protected Attributes
std::map< uint8_t, LteCcmMacSapProvider * >	m_ccmMacSapProviderMap
	A map of pointers to the SAP interfaces of CCM instance that provides the CCM specific functionalities to MAC, i.e. More...

LteCcmMacSapUser *	m_ccmMacSapUser
	LteCcmMacSapUser is extended version of LteMacSapUser interface. More...

LteCcmRrcSapProvider *	m_ccmRrcSapProvider
	A pointer to the SAP interface of the CCM instance to receive API calls from the eNodeB RRC instance. More...

LteCcmRrcSapUser *	m_ccmRrcSapUser
	A pointer to SAP interface of RRC instance, i.e. More...

LteMacSapProvider *	m_macSapProvider
	A pointer to main SAP interface of the MAC instance, which is in this case handled by CCM. More...

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

uint16_t	m_noOfComponentCarriers
	The number component of carriers that are supported by this eNb. More...

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

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

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

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 LteEnbNetDevice class, and are accessible using namespace-based access through ns-3 Config subsystem, and can be installed and configured by LteHelper class.

The communication with the eNodeB RRC instance is done through the Component Carrier Manager SAP interface. The LteEnbComponentCarrierManager 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<LteEnbRrc> rrc = ...; Ptr<LteComponentCarrierManager> ccmEnb = ...; rrc->SetLteCcmRrcSapProvider (ccmEnb->GetLteCcmRrcSapProvider ()); ccmEnb->SetLteCcmRrcSapUser (rrc->GetLteCcmRrcSapUser ())

Similarly, LteEnbComponentCarrierManager 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 LteHelper::InstallEnbDevice.

See also: LteCcmRrcSapUser, LteCcmRrcSapProvider, LteCcmMacSapUser, LteCcmMacSapProvider

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbComponentCarrierManager"
"/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbComponentCarrierManager"

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 78 of file lte-enb-component-carrier-manager.h.

Constructor & Destructor Documentation

◆ LteEnbComponentCarrierManager()

ns3::LteEnbComponentCarrierManager::LteEnbComponentCarrierManager ( )

Definition at line 31 of file lte-enb-component-carrier-manager.cc.

◆ ~LteEnbComponentCarrierManager()

ns3::LteEnbComponentCarrierManager::~LteEnbComponentCarrierManager ( )

virtual

Definition at line 36 of file lte-enb-component-carrier-manager.cc.

Member Function Documentation

◆ DoDispose()

void ns3::LteEnbComponentCarrierManager::DoDispose ( void )

protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Reimplemented in ns3::NoOpComponentCarrierManager.

Definition at line 51 of file lte-enb-component-carrier-manager.cc.

◆ DoReportUeMeas()

virtual void ns3::LteEnbComponentCarrierManager::DoReportUeMeas	(	uint16_t	rnti,
		LteRrcSap::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::NoOpComponentCarrierManager.

◆ GetLteCcmMacSapUser()

LteCcmMacSapUser * ns3::LteEnbComponentCarrierManager::GetLteCcmMacSapUser ( )

virtual

This function returns a pointer to the LteCcmMacSapUser 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: LteCcmMacSapUser*

Definition at line 77 of file lte-enb-component-carrier-manager.cc.

References m_ccmMacSapUser, and NS_LOG_FUNCTION.

◆ GetLteCcmRrcSapProvider()

LteCcmRrcSapProvider * ns3::LteEnbComponentCarrierManager::GetLteCcmRrcSapProvider ( )

virtual

Export the "provider" part of the ComponentCarrier Management SAP interface.

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

Definition at line 63 of file lte-enb-component-carrier-manager.cc.

References m_ccmRrcSapProvider, and NS_LOG_FUNCTION.

◆ GetLteMacSapProvider()

LteMacSapProvider * ns3::LteEnbComponentCarrierManager::GetLteMacSapProvider ( )

virtual

Returns the pointer to the LteMacSapProvider interface, the provider of MAC, which is this new architecture served by LteEnbComponentCarrierManager 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.