The default component carrier manager that forwards all traffic, the uplink and the downlink, over the primary carrier, and will not use secondary carriers. More...

#include "no-op-component-carrier-manager.h"

Inheritance diagram for ns3::NoOpComponentCarrierManager:

Collaboration diagram for ns3::NoOpComponentCarrierManager:

Public Member Functions
	NoOpComponentCarrierManager ()

	~NoOpComponentCarrierManager () override

Public Member Functions inherited from ns3::LteEnbComponentCarrierManager
	LteEnbComponentCarrierManager ()

	~LteEnbComponentCarrierManager () override

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

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

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.

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

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

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

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

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

	~Object () override
	Destructor.

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

void	Dispose ()
	Dispose of this Object.

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

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

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

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

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

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

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

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

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Member Functions
virtual void	DoAddLc (LteEnbCmacSapProvider::LcInfo lcInfo, LteMacSapUser *msu)
	Add LC.

virtual void	DoAddUe (uint16_t rnti, uint8_t state)
	Add UE.

virtual LteMacSapUser *	DoConfigureSignalBearer (LteEnbCmacSapProvider::LcInfo lcinfo, LteMacSapUser *msu)
	Configure the signal bearer.

void	DoDispose () override
	Destructor implementation.

void	DoInitialize () override
	Initialize() implementation.

virtual void	DoNotifyHarqDeliveryFailure ()
	Notify HARQ delivery failure.

virtual void	DoNotifyPrbOccupancy (double prbOccupancy, uint8_t componentCarrierId)
	Function implements the function of the SAP interface of CCM instance which is used by MAC to notify the PRB occupancy reported by scheduler.

virtual void	DoNotifyTxOpportunity (LteMacSapUser::TxOpportunityParameters txOpParams)
	Notify transmit opportunity.

virtual void	DoReceivePdu (LteMacSapUser::ReceivePduParameters rxPduParams)
	Receive PDU.

virtual std::vector< uint8_t >	DoReleaseDataRadioBearer (uint16_t rnti, uint8_t lcid)
	Release data radio bearer.

virtual void	DoRemoveUe (uint16_t rnti)
	Remove UE.

virtual void	DoReportBufferStatus (LteMacSapProvider::ReportBufferStatusParameters params)
	Report buffer status.

void	DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults) override
	Implementation of ReportUeMeas.

virtual std::vector< LteCcmRrcSapProvider::LcsConfig >	DoSetupDataRadioBearer (EpsBearer bearer, uint8_t bearerId, uint16_t rnti, uint8_t lcid, uint8_t lcGroup, LteMacSapUser *msu)
	Setup data radio bearer.

virtual void	DoTransmitPdu (LteMacSapProvider::TransmitPduParameters params)
	Transmit PDU.

virtual void	DoUlReceiveMacCe (MacCeListElement_s bsr, uint8_t componentCarrierId)
	Forwards uplink BSR to CCM, called by MAC through CCM SAP interface.

virtual void	DoUlReceiveSr (uint16_t rnti, uint8_t componentCarrierId)
	Forward uplink SR to CCM, called by MAC through CCM SAP interface.

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

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

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

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

Protected Attributes
std::map< uint8_t, double >	m_ccPrbOccupancy
	The physical resource block occupancy per carrier.

Protected Attributes inherited from ns3::LteEnbComponentCarrierManager
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.

LteCcmMacSapUser *	m_ccmMacSapUser
	LteCcmMacSapUser is extended version of LteMacSapUser interface.

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

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

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

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

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

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

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

Friends
class	EnbMacMemberLteMacSapProvider< NoOpComponentCarrierManager >
	allow EnbMacMemberLteMacSapProvider<NoOpComponentCarrierManager> class friend access

class	MemberLteCcmMacSapUser< NoOpComponentCarrierManager >
	allow MemberLteCcmMacSapUser<NoOpComponentCarrierManager> class friend access

class	MemberLteCcmRrcSapProvider< NoOpComponentCarrierManager >
	allow MemberLteCcmRrcSapProvider<NoOpComponentCarrierManager> class friend access

class	MemberLteCcmRrcSapUser< NoOpComponentCarrierManager >
	allow MemberLteCcmRrcSapUser<NoOpComponentCarrierManager> class friend access

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

Detailed Description

The default component carrier manager that forwards all traffic, the uplink and the downlink, over the primary carrier, and will not use secondary carriers.

To enable carrier aggregation feature, select another component carrier manager class, i.e., some of child classes of LteEnbComponentCarrierManager of NoOpComponentCarrierManager.

Definition at line 33 of file no-op-component-carrier-manager.h.

Constructor & Destructor Documentation

◆ NoOpComponentCarrierManager()

ns3::NoOpComponentCarrierManager::NoOpComponentCarrierManager ( )

Definition at line 25 of file no-op-component-carrier-manager.cc.

References EnbMacMemberLteMacSapProvider< NoOpComponentCarrierManager >, ns3::LteEnbComponentCarrierManager::m_ccmMacSapUser, ns3::LteEnbComponentCarrierManager::m_ccmRrcSapProvider, ns3::LteEnbComponentCarrierManager::m_ccmRrcSapUser, ns3::LteEnbComponentCarrierManager::m_macSapProvider, MemberLteCcmMacSapUser< NoOpComponentCarrierManager >, MemberLteCcmRrcSapProvider< NoOpComponentCarrierManager >, and NS_LOG_FUNCTION.

◆ ~NoOpComponentCarrierManager()

ns3::NoOpComponentCarrierManager::~NoOpComponentCarrierManager ( )

override

Definition at line 34 of file no-op-component-carrier-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoAddLc()

void ns3::NoOpComponentCarrierManager::DoAddLc	(	LteEnbCmacSapProvider::LcInfo	lcInfo,
		LteMacSapUser *	msu )

protectedvirtual

Add LC.

Parameters

lcInfo	the LC info
msu	the MSU

Definition at line 152 of file no-op-component-carrier-manager.cc.

References ns3::LteEnbCmacSapProvider::LcInfo::lcId, ns3::LteEnbComponentCarrierManager::m_ueInfo, NS_LOG_FUNCTION, and ns3::LteEnbCmacSapProvider::LcInfo::rnti.

◆ DoAddUe()

void ns3::NoOpComponentCarrierManager::DoAddUe	(	uint16_t	rnti,
		uint8_t	state )

protectedvirtual

Add UE.

Parameters

rnti	the RNTI
state	the state

Definition at line 125 of file no-op-component-carrier-manager.cc.

References ns3::LteEnbComponentCarrierManager::UeInfo::m_enabledComponentCarrier, ns3::LteEnbComponentCarrierManager::m_ueInfo, ns3::LteEnbComponentCarrierManager::UeInfo::m_ueState, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ DoConfigureSignalBearer()

LteMacSapUser * ns3::NoOpComponentCarrierManager::DoConfigureSignalBearer	(	LteEnbCmacSapProvider::LcInfo	lcinfo,
		LteMacSapUser *	msu )

protectedvirtual

Configure the signal bearer.

Parameters

lcinfo	the LteEnbCmacSapProvider::LcInfo
msu	the MSU

Returns: updated data radio bearer list

Definition at line 271 of file no-op-component-carrier-manager.cc.

References ns3::LteEnbCmacSapProvider::LcInfo::lcId, ns3::LteEnbComponentCarrierManager::m_ccmMacSapUser, ns3::LteEnbComponentCarrierManager::m_ueInfo, NS_ASSERT_MSG, NS_LOG_ERROR, NS_LOG_FUNCTION, and ns3::LteEnbCmacSapProvider::LcInfo::rnti.

◆ DoDispose()

void ns3::NoOpComponentCarrierManager::DoDispose ( )

overrideprotectedvirtual

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::LteEnbComponentCarrierManager.

Definition at line 40 of file no-op-component-carrier-manager.cc.

References ns3::LteEnbComponentCarrierManager::m_ccmMacSapUser, ns3::LteEnbComponentCarrierManager::m_ccmRrcSapProvider, ns3::LteEnbComponentCarrierManager::m_macSapProvider, and NS_LOG_FUNCTION.

◆ DoInitialize()

void ns3::NoOpComponentCarrierManager::DoInitialize ( )

overrideprotectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 59 of file no-op-component-carrier-manager.cc.

References ns3::Object::DoInitialize(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoNotifyHarqDeliveryFailure()

void ns3::NoOpComponentCarrierManager::DoNotifyHarqDeliveryFailure ( )

protectedvirtual

Notify HARQ delivery failure.

Definition at line 113 of file no-op-component-carrier-manager.cc.

References NS_LOG_FUNCTION.

◆ DoNotifyPrbOccupancy()

void ns3::NoOpComponentCarrierManager::DoNotifyPrbOccupancy	(	double	prbOccupancy,
		uint8_t	componentCarrierId )

protectedvirtual

Function implements the function of the SAP interface of CCM instance which is used by MAC to notify the PRB occupancy reported by scheduler.

Parameters

prbOccupancy	the PRB occupancy
componentCarrierId	the component carrier ID

Definition at line 294 of file no-op-component-carrier-manager.cc.

References m_ccPrbOccupancy, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ DoNotifyTxOpportunity()

void ns3::NoOpComponentCarrierManager::DoNotifyTxOpportunity ( LteMacSapUser::TxOpportunityParameters txOpParams )

protectedvirtual

Notify transmit opportunity.

Parameters

txOpParams the LteMacSapUser::TxOpportunityParameters

Definition at line 92 of file no-op-component-carrier-manager.cc.

References ns3::LteMacSapUser::TxOpportunityParameters::componentCarrierId, ns3::LteMacSapUser::TxOpportunityParameters::layer, ns3::LteMacSapUser::TxOpportunityParameters::lcid, ns3::LteEnbComponentCarrierManager::m_ueInfo, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::LteMacSapUser::TxOpportunityParameters::rnti.

◆ DoReceivePdu()

void ns3::NoOpComponentCarrierManager::DoReceivePdu ( LteMacSapUser::ReceivePduParameters rxPduParams )

protectedvirtual

Receive PDU.

Parameters

rxPduParams the LteMacSapUser::ReceivePduParameters

Definition at line 102 of file no-op-component-carrier-manager.cc.

References ns3::LteMacSapUser::ReceivePduParameters::lcid, ns3::LteEnbComponentCarrierManager::m_ueInfo, NS_LOG_FUNCTION, and ns3::LteMacSapUser::ReceivePduParameters::rnti.

◆ DoReleaseDataRadioBearer()

std::vector< uint8_t > ns3::NoOpComponentCarrierManager::DoReleaseDataRadioBearer	(	uint16_t	rnti,
		uint8_t	lcid )

protectedvirtual

Release data radio bearer.

Parameters

rnti	the RNTI
lcid	the LCID

Returns: updated data radio bearer list

Definition at line 241 of file no-op-component-carrier-manager.cc.

References ns3::LteEnbComponentCarrierManager::m_ueInfo, NS_ASSERT_MSG, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ DoRemoveUe()

void ns3::NoOpComponentCarrierManager::DoRemoveUe ( uint16_t rnti )

protectedvirtual

Remove UE.

Parameters

rnti the RNTI

Definition at line 159 of file no-op-component-carrier-manager.cc.

References ns3::LteEnbComponentCarrierManager::m_ueInfo, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ DoReportBufferStatus()

void ns3::NoOpComponentCarrierManager::DoReportBufferStatus ( LteMacSapProvider::ReportBufferStatusParameters params )

protectedvirtual

Report buffer status.

Parameters

params the report buffer status parameters

Reimplemented in ns3::RrComponentCarrierManager.

Definition at line 81 of file no-op-component-carrier-manager.cc.

References ns3::LteCcmRrcSapUser::GetUeManager(), ns3::LteEnbComponentCarrierManager::m_ccmRrcSapUser, ns3::LteEnbComponentCarrierManager::m_macSapProvidersMap, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoReportUeMeas()

void ns3::NoOpComponentCarrierManager::DoReportUeMeas	(	uint16_t	rnti,
		LteRrcSap::MeasResults	measResults )

overrideprotectedvirtual

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

Implements ns3::LteEnbComponentCarrierManager.

Definition at line 119 of file no-op-component-carrier-manager.cc.

References ns3::LteRrcSap::MeasResults::measId, and NS_LOG_FUNCTION.

◆ DoSetupDataRadioBearer()

std::vector< LteCcmRrcSapProvider::LcsConfig > ns3::NoOpComponentCarrierManager::DoSetupDataRadioBearer	(	EpsBearer	bearer,
		uint8_t	bearerId,
		uint16_t	rnti,
		uint8_t	lcid,
		uint8_t	lcGroup,
		LteMacSapUser *	msu )