A Discrete-Event Network Simulator
API
ns3::LteUeComponentCarrierManager Class Referenceabstract

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

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

+ Inheritance diagram for ns3::LteUeComponentCarrierManager:
+ Collaboration diagram for ns3::LteUeComponentCarrierManager:

Public Member Functions

 LteUeComponentCarrierManager ()
 
virtual ~LteUeComponentCarrierManager ()
 
virtual LteUeCcmRrcSapProviderGetLteCcmRrcSapProvider ()
 Exports the "provider" part of the ComponentCarrier Management SAP interface. More...
 
virtual LteMacSapProviderGetLteMacSapProvider ()=0
 Returns the MAC sap provider interface that if forwarding calls to the instance of the LteUeComponentCarrierManager. More...
 
bool SetComponentCarrierMacSapProviders (uint8_t componentCarrierId, LteMacSapProvider *sap)
 Sets a pointer to SAP interface of MAC instance for the specified carrier. More...
 
virtual void SetLteCcmRrcSapUser (LteUeCcmRrcSapUser *s)
 Set the "user" part of the ComponentCarrier Management SAP interface that this UE component carrier manager will interact with. More...
 
void SetNumberOfComponentCarriers (uint8_t noOfComponentCarriers)
 Sets number of component carriers that are supported by this UE. 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< ObjectGetObject () 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< ObjectGetObject (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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. 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

LteUeCcmRrcSapProviderm_ccmRrcSapProvider
 Receive API calls from the UE RRC instance. More...
 
LteUeCcmRrcSapUserm_ccmRrcSapUser
 Interface to the UE RRC instance. More...
 
std::map< uint8_t, std::map< uint8_t, LteMacSapProvider * > > m_componentCarrierLcMap
 Flow configuration per flow Id of this UE. More...
 
std::map< uint8_t, LteMacSapUser * > m_lcAttached
 Map of pointers to SAP interfaces of the RLC instance of the flows of this UE. More...
 
std::map< uint8_t, LteMacSapProvider * > m_macSapProvidersMap
 Map of pointers to SAP to interfaces of the MAC instance if the flows of this UE. More...
 
uint16_t m_noOfComponentCarriers
 // The number of component carriers that this UE can support. More...
 

Additional Inherited Members

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::LteUeComponentCarrierManager is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteUeNetDevice/LteUeComponentCarrierManager"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUeComponentCarrierManager"

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

Definition at line 50 of file lte-ue-component-carrier-manager.h.

Constructor & Destructor Documentation

◆ LteUeComponentCarrierManager()

ns3::LteUeComponentCarrierManager::LteUeComponentCarrierManager ( )

Definition at line 30 of file lte-ue-component-carrier-manager.cc.

References NS_LOG_FUNCTION.

◆ ~LteUeComponentCarrierManager()

ns3::LteUeComponentCarrierManager::~LteUeComponentCarrierManager ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::LteUeComponentCarrierManager::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::SimpleUeComponentCarrierManager.

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

References NS_LOG_FUNCTION.

◆ GetLteCcmRrcSapProvider()

LteUeCcmRrcSapProvider * ns3::LteUeComponentCarrierManager::GetLteCcmRrcSapProvider ( )
virtual

Exports 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 LteUeRrc instance

Definition at line 64 of file lte-ue-component-carrier-manager.cc.

References m_ccmRrcSapProvider, and NS_LOG_FUNCTION.

◆ GetLteMacSapProvider()

virtual LteMacSapProvider * ns3::LteUeComponentCarrierManager::GetLteMacSapProvider ( )
pure virtual

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

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

Implemented in ns3::SimpleUeComponentCarrierManager.

◆ GetTypeId()

TypeId ns3::LteUeComponentCarrierManager::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 42 of file lte-ue-component-carrier-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetComponentCarrierMacSapProviders()

bool ns3::LteUeComponentCarrierManager::SetComponentCarrierMacSapProviders ( uint8_t  componentCarrierId,
LteMacSapProvider 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 72 of file lte-ue-component-carrier-manager.cc.

References m_macSapProvidersMap, m_noOfComponentCarriers, NS_FATAL_ERROR, NS_LOG_FUNCTION, and test-ns3::result.

◆ SetLteCcmRrcSapUser()

void ns3::LteUeComponentCarrierManager::SetLteCcmRrcSapUser ( LteUeCcmRrcSapUser s)
virtual

Set the "user" part of the ComponentCarrier 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 LteEnbRrc instance

Definition at line 57 of file lte-ue-component-carrier-manager.cc.

References m_ccmRrcSapUser, and NS_LOG_FUNCTION.

◆ SetNumberOfComponentCarriers()

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

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

Parameters
noOfComponentCarriersnumber of component carriers

Definition at line 96 of file lte-ue-component-carrier-manager.cc.

References m_ccmRrcSapUser, m_noOfComponentCarriers, MAX_NO_CC, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, and ns3::LteUeCcmRrcSapUser::SetNumberOfComponentCarriers().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_ccmRrcSapProvider

LteUeCcmRrcSapProvider* ns3::LteUeComponentCarrierManager::m_ccmRrcSapProvider
protected

◆ m_ccmRrcSapUser

LteUeCcmRrcSapUser* ns3::LteUeComponentCarrierManager::m_ccmRrcSapUser
protected

Interface to the UE RRC instance.

Definition at line 104 of file lte-ue-component-carrier-manager.h.

Referenced by SetLteCcmRrcSapUser(), and SetNumberOfComponentCarriers().

◆ m_componentCarrierLcMap

std::map<uint8_t, std::map<uint8_t, LteMacSapProvider*> > ns3::LteUeComponentCarrierManager::m_componentCarrierLcMap
protected

◆ m_lcAttached

◆ m_macSapProvidersMap

std::map<uint8_t, LteMacSapProvider*> ns3::LteUeComponentCarrierManager::m_macSapProvidersMap
protected

◆ m_noOfComponentCarriers

uint16_t ns3::LteUeComponentCarrierManager::m_noOfComponentCarriers
protected

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