The class implements Component Carrier Manager (CCM) that operates using the Component Carrier Manager SAP interfaces. More...
#include "lte-enb-component-carrier-manager.h"
Classes | |
struct | UeInfo |
Structure to represent UE info. More... | |
Public Member Functions | |
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::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 | |
void | DoDispose () override |
Destructor implementation. | |
virtual void | DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults)=0 |
Implementation of ReportUeMeas. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
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, 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. | |
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. | |
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.
ns3::LteEnbComponentCarrierManager 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.
Group: Lte
Size of this type is 248 bytes (on a 64-bit architecture).
Definition at line 68 of file lte-enb-component-carrier-manager.h.
ns3::LteEnbComponentCarrierManager::LteEnbComponentCarrierManager | ( | ) |
Definition at line 22 of file lte-enb-component-carrier-manager.cc.
|
override |
Definition at line 26 of file lte-enb-component-carrier-manager.cc.
|
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::Object.
Reimplemented in ns3::NoOpComponentCarrierManager.
Definition at line 39 of file lte-enb-component-carrier-manager.cc.
|
protectedpure virtual |
Implementation of ReportUeMeas.
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.
|
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.
Definition at line 65 of file lte-enb-component-carrier-manager.cc.
References m_ccmMacSapUser, and NS_LOG_FUNCTION.
|
virtual |
Export the "provider" part of the ComponentCarrier Management SAP interface.
Definition at line 51 of file lte-enb-component-carrier-manager.cc.
References m_ccmRrcSapProvider, and NS_LOG_FUNCTION.
|
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.
Definition at line 58 of file lte-enb-component-carrier-manager.cc.
References m_macSapProvider, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 31 of file lte-enb-component-carrier-manager.cc.
References ns3::TypeId::SetParent().
|
virtual |
Set LteCcmMacSapProvider 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.
componentCarrierId | component carrier ID |
sap | the MAC SAP provider |
Definition at line 96 of file lte-enb-component-carrier-manager.cc.
References m_ccmMacSapProviderMap, and NS_LOG_FUNCTION.
|
virtual |
Set the "user" part of the ComponentCarrier Management SAP interface that this ComponentCarrier algorithm instance will interact with.
s | a reference to the "user" part of the interface, typically a member of an LteEnbRrc instance |
Definition at line 44 of file lte-enb-component-carrier-manager.cc.
References m_ccmRrcSapUser, and NS_LOG_FUNCTION.
|
virtual |
Set LteMacSapProvider interface for the MAC object of the specified component carrier.
componentCarrierId | component carrier ID |
sap | the MAC SAP provider |
Definition at line 72 of file lte-enb-component-carrier-manager.cc.
References m_macSapProvidersMap, m_noOfComponentCarriers, NS_FATAL_ERROR, and NS_LOG_FUNCTION.
|
virtual |
Sets the total number of component carriers.
noOfComponentCarriers | number of component carriers |
Definition at line 114 of file lte-enb-component-carrier-manager.cc.
References m_ccmRrcSapUser, m_noOfComponentCarriers, ns3::MAX_NO_CC, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, and ns3::LteCcmRrcSapUser::SetNumberOfComponentCarriers().
|
protected |
A map of pointers to the SAP interfaces of CCM instance that provides the CCM specific functionalities to MAC, i.e.
ReportMacCeToScheduler.
Definition at line 202 of file lte-enb-component-carrier-manager.h.
Referenced by ns3::NoOpComponentCarrierManager::DoUlReceiveMacCe(), ns3::RrComponentCarrierManager::DoUlReceiveMacCe(), ns3::NoOpComponentCarrierManager::DoUlReceiveSr(), ns3::RrComponentCarrierManager::DoUlReceiveSr(), and SetCcmMacSapProviders().
|
protected |
LteCcmMacSapUser is extended version of LteMacSapUser interface.
Contains functions that allow reporting of UL BSR from MAC to CCM.
Definition at line 206 of file lte-enb-component-carrier-manager.h.
Referenced by ns3::NoOpComponentCarrierManager::NoOpComponentCarrierManager(), ns3::NoOpComponentCarrierManager::DoConfigureSignalBearer(), ns3::NoOpComponentCarrierManager::DoDispose(), ns3::NoOpComponentCarrierManager::DoSetupDataRadioBearer(), and GetLteCcmMacSapUser().
|
protected |
A pointer to the SAP interface of the CCM instance to receive API calls from the eNodeB RRC instance.
Definition at line 211 of file lte-enb-component-carrier-manager.h.
Referenced by ns3::NoOpComponentCarrierManager::NoOpComponentCarrierManager(), ns3::NoOpComponentCarrierManager::DoDispose(), and GetLteCcmRrcSapProvider().
|
protected |
A pointer to SAP interface of RRC instance, i.e.
to configure measurements reporting for CCM.
Definition at line 208 of file lte-enb-component-carrier-manager.h.
Referenced by ns3::NoOpComponentCarrierManager::NoOpComponentCarrierManager(), ns3::NoOpComponentCarrierManager::DoReportBufferStatus(), ns3::RrComponentCarrierManager::DoReportBufferStatus(), ns3::RrComponentCarrierManager::DoUlReceiveMacCe(), SetLteCcmRrcSapUser(), and SetNumberOfComponentCarriers().
|
protected |
A pointer to main SAP interface of the MAC instance, which is in this case handled by CCM.
Definition at line 187 of file lte-enb-component-carrier-manager.h.
Referenced by ns3::NoOpComponentCarrierManager::NoOpComponentCarrierManager(), ns3::NoOpComponentCarrierManager::DoDispose(), and GetLteMacSapProvider().
|
protected |
A map of pointers to real SAP interfaces of MAC instances.
Definition at line 193 of file lte-enb-component-carrier-manager.h.
Referenced by ns3::NoOpComponentCarrierManager::DoReportBufferStatus(), ns3::RrComponentCarrierManager::DoReportBufferStatus(), ns3::NoOpComponentCarrierManager::DoTransmitPdu(), and SetMacSapProvider().
|
protected |
The number component of carriers that are supported by this eNb.
Definition at line 169 of file lte-enb-component-carrier-manager.h.
Referenced by ns3::NoOpComponentCarrierManager::DoSetupDataRadioBearer(), SetMacSapProvider(), and SetNumberOfComponentCarriers().
A pointer to the RRC instance of this eNb.
Definition at line 173 of file lte-enb-component-carrier-manager.h.
|
protected |
The map from RNTI to UE information.
Definition at line 168 of file lte-enb-component-carrier-manager.h.
Referenced by ns3::NoOpComponentCarrierManager::DoAddLc(), ns3::NoOpComponentCarrierManager::DoAddUe(), ns3::NoOpComponentCarrierManager::DoConfigureSignalBearer(), ns3::NoOpComponentCarrierManager::DoNotifyTxOpportunity(), ns3::NoOpComponentCarrierManager::DoReceivePdu(), ns3::NoOpComponentCarrierManager::DoReleaseDataRadioBearer(), ns3::NoOpComponentCarrierManager::DoRemoveUe(), ns3::RrComponentCarrierManager::DoReportBufferStatus(), ns3::NoOpComponentCarrierManager::DoSetupDataRadioBearer(), ns3::RrComponentCarrierManager::DoUlReceiveMacCe(), and ns3::RrComponentCarrierManager::DoUlReceiveSr().