A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::SimpleUeComponentCarrierManager Class Reference

Component carrier manager implementation which simply does nothing. More...

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

+ Inheritance diagram for ns3::SimpleUeComponentCarrierManager:
+ Collaboration diagram for ns3::SimpleUeComponentCarrierManager:

Public Member Functions

 SimpleUeComponentCarrierManager ()
 Creates a No-op CCS algorithm instance.
 
 ~SimpleUeComponentCarrierManager () override
 
LteMacSapProviderGetLteMacSapProvider () override
 Returns the MAC sap provider interface that if forwarding calls to the instance of the LteUeComponentCarrierManager.
 
- Public Member Functions inherited from ns3::LteUeComponentCarrierManager
 LteUeComponentCarrierManager ()
 
 ~LteUeComponentCarrierManager () override
 
virtual LteUeCcmRrcSapProviderGetLteCcmRrcSapProvider ()
 Exports the "provider" part of the ComponentCarrier Management SAP interface.
 
bool SetComponentCarrierMacSapProviders (uint8_t componentCarrierId, LteMacSapProvider *sap)
 Sets a pointer to SAP interface of MAC instance for the specified carrier.
 
virtual void SetLteCcmRrcSapUser (LteUeCcmRrcSapUser *s)
 Set the "user" part of the ComponentCarrier Management SAP interface that this UE component carrier manager will interact with.
 
void SetNumberOfComponentCarriers (uint8_t noOfComponentCarriers)
 Sets number of component carriers that are supported by this UE.
 
- 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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::LteUeComponentCarrierManager
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 std::vector< LteUeCcmRrcSapProvider::LcsConfigDoAddLc (uint8_t lcId, LteUeCmacSapProvider::LogicalChannelConfig lcConfig, LteMacSapUser *msu)
 Add LC function.
 
virtual LteMacSapUserDoConfigureSignalBearer (uint8_t lcId, LteUeCmacSapProvider::LogicalChannelConfig lcConfig, LteMacSapUser *msu)
 Configure signal bearer function.
 
void DoDispose () override
 Destructor implementation.
 
void DoInitialize () override
 Initialize() implementation.
 
void DoNotifyHarqDeliveryFailure ()
 Notify HARQ deliver failure.
 
void DoNotifyTxOpportunity (LteMacSapUser::TxOpportunityParameters txOpParams)
 Notify TX opportunity function.
 
void DoReceivePdu (LteMacSapUser::ReceivePduParameters rxPduParams)
 Receive PDU function.
 
std::vector< uint16_t > DoRemoveLc (uint8_t lcid)
 Remove LC function.
 
virtual void DoReportBufferStatus (LteMacSapProvider::ReportBufferStatusParameters params)
 Report buffer status function.
 
void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults)
 Report Ue Measure function.
 
void DoReset ()
 Reset LC map.
 
void DoTransmitPdu (LteMacSapProvider::TransmitPduParameters params)
 Transmit PDU function.
 
- 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

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

Friends

class MemberLteUeCcmRrcSapProvider< SimpleUeComponentCarrierManager >
 let the forwarder class access the protected and private members
 
class SimpleUeCcmMacSapProvider
 allow SimpleUeCcmMacSapProvider class friend access
 
class SimpleUeCcmMacSapUser
 allow SimpleUeCcmMacSapUser class friend access
 

Additional Inherited Members

Detailed Description

Component carrier manager implementation which simply does nothing.

Selecting this component carrier selection algorithm is equivalent to disabling automatic triggering of component carrier selection. This is the default choice.

Definition at line 30 of file simple-ue-component-carrier-manager.h.

Constructor & Destructor Documentation

◆ SimpleUeComponentCarrierManager()

ns3::SimpleUeComponentCarrierManager::SimpleUeComponentCarrierManager ( )

◆ ~SimpleUeComponentCarrierManager()

ns3::SimpleUeComponentCarrierManager::~SimpleUeComponentCarrierManager ( )
override

Definition at line 126 of file simple-ue-component-carrier-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoAddLc()

◆ DoConfigureSignalBearer()

LteMacSapUser * ns3::SimpleUeComponentCarrierManager::DoConfigureSignalBearer ( uint8_t lcId,
LteUeCmacSapProvider::LogicalChannelConfig lcConfig,
LteMacSapUser * msu )
protectedvirtual

◆ DoDispose()

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

Definition at line 132 of file simple-ue-component-carrier-manager.cc.

References m_ccmMacSapProvider, m_ccmMacSapUser, ns3::LteUeComponentCarrierManager::m_ccmRrcSapProvider, and NS_LOG_FUNCTION.

◆ DoInitialize()

void ns3::SimpleUeComponentCarrierManager::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 158 of file simple-ue-component-carrier-manager.cc.

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

+ Here is the call graph for this function:

◆ DoNotifyHarqDeliveryFailure()

void ns3::SimpleUeComponentCarrierManager::DoNotifyHarqDeliveryFailure ( )
protected

Notify HARQ deliver failure.

Definition at line 207 of file simple-ue-component-carrier-manager.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::SimpleUeCcmMacSapUser::NotifyHarqDeliveryFailure().

+ Here is the caller graph for this function:

◆ DoNotifyTxOpportunity()

void ns3::SimpleUeComponentCarrierManager::DoNotifyTxOpportunity ( LteMacSapUser::TxOpportunityParameters txOpParams)
protected

◆ DoReceivePdu()

void ns3::SimpleUeComponentCarrierManager::DoReceivePdu ( LteMacSapUser::ReceivePduParameters rxPduParams)
protected

Receive PDU function.

Parameters
rxPduParamsthe LteMacSapUser::ReceivePduParameters

Definition at line 232 of file simple-ue-component-carrier-manager.cc.

References ns3::LteMacSapUser::ReceivePduParameters::lcid, ns3::LteUeComponentCarrierManager::m_lcAttached, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Referenced by ns3::SimpleUeCcmMacSapUser::ReceivePdu().

+ Here is the caller graph for this function:

◆ DoRemoveLc()

std::vector< uint16_t > ns3::SimpleUeComponentCarrierManager::DoRemoveLc ( uint8_t lcid)
protected

Remove LC function.

Parameters
lcidthe LCID
Returns
updated LC list

Definition at line 248 of file simple-ue-component-carrier-manager.cc.

References ns3::LteUeComponentCarrierManager::m_componentCarrierLcMap, ns3::LteUeComponentCarrierManager::m_lcAttached, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

◆ DoReportBufferStatus()

void ns3::SimpleUeComponentCarrierManager::DoReportBufferStatus ( LteMacSapProvider::ReportBufferStatusParameters params)
protectedvirtual

Report buffer status function.

Parameters
paramsLteMacSapProvider::ReportBufferStatusParameters

Definition at line 183 of file simple-ue-component-carrier-manager.cc.

References ns3::LteUeComponentCarrierManager::m_componentCarrierLcMap, ns3::LteUeComponentCarrierManager::m_macSapProvidersMap, NS_ABORT_MSG_IF, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by ns3::SimpleUeCcmMacSapProvider::ReportBufferStatus().

+ Here is the caller graph for this function:

◆ DoReportUeMeas()

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

Report Ue Measure function.

Parameters
rntithe RNTI
measResultsthe measure results

Definition at line 165 of file simple-ue-component-carrier-manager.cc.

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

◆ DoReset()

void ns3::SimpleUeComponentCarrierManager::DoReset ( )
protected

◆ DoTransmitPdu()

void ns3::SimpleUeComponentCarrierManager::DoTransmitPdu ( LteMacSapProvider::TransmitPduParameters params)
protected

Transmit PDU function.

Parameters
paramsLteMacSapProvider::TransmitPduParameters

Definition at line 171 of file simple-ue-component-carrier-manager.cc.

References ns3::LteUeComponentCarrierManager::m_macSapProvidersMap, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Referenced by ns3::SimpleUeCcmMacSapProvider::TransmitPdu().

+ Here is the caller graph for this function:

◆ GetLteMacSapProvider()

LteMacSapProvider * ns3::SimpleUeComponentCarrierManager::GetLteMacSapProvider ( )
overridevirtual

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

Implements ns3::LteUeComponentCarrierManager.

Definition at line 151 of file simple-ue-component-carrier-manager.cc.

References m_ccmMacSapProvider, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::SimpleUeComponentCarrierManager::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 141 of file simple-ue-component-carrier-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ MemberLteUeCcmRrcSapProvider< SimpleUeComponentCarrierManager >

let the forwarder class access the protected and private members

Definition at line 45 of file simple-ue-component-carrier-manager.h.

Referenced by SimpleUeComponentCarrierManager().

◆ SimpleUeCcmMacSapProvider

friend class SimpleUeCcmMacSapProvider
friend

allow SimpleUeCcmMacSapProvider class friend access

Definition at line 52 of file simple-ue-component-carrier-manager.h.

Referenced by SimpleUeComponentCarrierManager().

◆ SimpleUeCcmMacSapUser

friend class SimpleUeCcmMacSapUser
friend

allow SimpleUeCcmMacSapUser class friend access

Definition at line 54 of file simple-ue-component-carrier-manager.h.

Referenced by SimpleUeComponentCarrierManager().

Member Data Documentation

◆ m_ccmMacSapProvider

LteMacSapProvider* ns3::SimpleUeComponentCarrierManager::m_ccmMacSapProvider
protected

Receive API calls from the UE RLC instance.

Definition at line 130 of file simple-ue-component-carrier-manager.h.

Referenced by SimpleUeComponentCarrierManager(), DoDispose(), and GetLteMacSapProvider().

◆ m_ccmMacSapUser

LteMacSapUser* ns3::SimpleUeComponentCarrierManager::m_ccmMacSapUser
protected

Interface to the UE RLC instance.

Definition at line 129 of file simple-ue-component-carrier-manager.h.

Referenced by SimpleUeComponentCarrierManager(), DoAddLc(), DoConfigureSignalBearer(), and DoDispose().


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