A Discrete-Event Network Simulator
API
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. More...
 
virtual ~SimpleUeComponentCarrierManager ()
 
virtual LteUeCcmRrcSapProviderGetLteCcmRrcSapProvider ()
 Exports the "provider" part of the ComponentCarrier Management SAP interface. More...
 
virtual LteMacSapProviderGetLteMacSapProvider ()
 Returns the MAC sap provider interface that if forwarding calls to the instance of the LteUeComponentCarrierManager. 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...
 
- Public Member Functions inherited from ns3::LteUeComponentCarrierManager
 LteUeComponentCarrierManager ()
 
virtual ~LteUeComponentCarrierManager ()
 
bool SetComponentCarrierMacSapProviders (uint8_t componentCarrierId, LteMacSapProvider *sap)
 Sets a pointer to SAP interface of MAC instance for the specified carrier. 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. 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...
 
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::LteUeComponentCarrierManager
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

std::vector< LteUeCcmRrcSapProvider::LcsConfigDoAddLc (uint8_t lcId, LteUeCmacSapProvider::LogicalChannelConfig lcConfig, LteMacSapUser *msu)
 Add LC function. More...
 
LteMacSapUserDoConfigureSignalBearer (uint8_t lcId, LteUeCmacSapProvider::LogicalChannelConfig lcConfig, LteMacSapUser *msu)
 Configure signal bearer function. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
void DoNotifyConnectionReconfigurationMsg ()
 Notify connection reconfiguration message. More...
 
void DoNotifyHarqDeliveryFailure ()
 Notify HARQ deliver failure. More...
 
void DoNotifyTxOpportunity (uint32_t bytes, uint8_t layer, uint8_t harqId, uint8_t componentCarrierId, uint16_t rnti, uint8_t lcid)
 Notify TX opportunity function. More...
 
void DoReceivePdu (Ptr< Packet > p, uint16_t rnti, uint8_t lcid)
 Receive PDU function. More...
 
std::vector< uint16_t > DoRemoveLc (uint8_t lcid)
 Remove LC function. More...
 
void DoReportBufferStatus (LteMacSapProvider::ReportBufferStatusParameters params)
 Report buffer status function. More...
 
void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults)
 Report Ue Measure function. More...
 
void DoTransmitPdu (LteMacSapProvider::TransmitPduParameters params)
 Transmit PDU function. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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...
 

Private Attributes

LteMacSapProviderm_ccmMacSapProvider
 Receive API calls from the eNodeB RLC instance. More...
 
LteMacSapUserm_ccmMacSapUser
 Interface to the eNodeB RLC instance. More...
 
LteUeCcmRrcSapProviderm_ccmRrcSapProvider
 Receive API calls from the eNodeB RRC instance. More...
 
LteUeCcmRrcSapUserm_ccmRrcSapUser
 Interface to the eNodeB RRC instance. More...
 

Friends

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

Additional Inherited Members

- Protected Attributes inherited from ns3::LteUeComponentCarrierManager
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...
 
uint16_t m_noOfComponentCarriersEnabled
 The number of enabled component carriers that are enabled for this UE. More...
 

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.

Config Paths

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

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

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

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

Constructor & Destructor Documentation

ns3::SimpleUeComponentCarrierManager::SimpleUeComponentCarrierManager ( )
ns3::SimpleUeComponentCarrierManager::~SimpleUeComponentCarrierManager ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

Configure signal bearer function.

Parameters
lcIdthe LCID
lcConfigthe logical channel config
msuthe MSU
Returns
LteMacSapUser *

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

References m_ccmMacSapUser, ns3::LteUeComponentCarrierManager::m_lcAttached, and NS_LOG_FUNCTION.

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

References m_ccmMacSapProvider, m_ccmMacSapUser, m_ccmRrcSapProvider, and NS_LOG_FUNCTION.

void ns3::SimpleUeComponentCarrierManager::DoInitialize ( void  )
protectedvirtual

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 194 of file simple-ue-component-carrier-manager.cc.

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

+ Here is the call graph for this function:

void ns3::SimpleUeComponentCarrierManager::DoNotifyConnectionReconfigurationMsg ( )
protected
void ns3::SimpleUeComponentCarrierManager::DoNotifyHarqDeliveryFailure ( )
protected

Notify HARQ deliver failure.

Definition at line 229 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:

void ns3::SimpleUeComponentCarrierManager::DoNotifyTxOpportunity ( uint32_t  bytes,
uint8_t  layer,
uint8_t  harqId,
uint8_t  componentCarrierId,
uint16_t  rnti,
uint8_t  lcid 
)
protected

Notify TX opportunity function.

Parameters
bytesthe number of bytes
layerthe layer
harqIdthe HARQ ID
componentCarrierIdthe component carrier ID
rntithe RNTI
lcidthe LCID

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

References ns3::LteUeComponentCarrierManager::m_lcAttached, NS_ASSERT_MSG, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

void ns3::SimpleUeComponentCarrierManager::DoReceivePdu ( Ptr< Packet p,
uint16_t  rnti,
uint8_t  lcid 
)
protected

Receive PDU function.

Parameters
pthe packet
rntithe RNTI
lcidthe LCID

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

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

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

+ Here is the caller graph for this function:

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

Remove LC function.

Parameters
lcidthe LCID
Returns
updated LC list

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

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

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

Report buffer status function.

Parameters
paramsLteMacSapProvider::ReportBufferStatusParameters

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

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

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

+ Here is the caller graph for this function:

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

Report Ue Measure function.

Parameters
rntithe RNTI
measResultsthe measure results

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

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

void ns3::SimpleUeComponentCarrierManager::DoTransmitPdu ( LteMacSapProvider::TransmitPduParameters  params)
protected
LteUeCcmRrcSapProvider * ns3::SimpleUeComponentCarrierManager::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

Implements ns3::LteUeComponentCarrierManager.

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

References m_ccmRrcSapProvider, and NS_LOG_FUNCTION.

LteMacSapProvider * ns3::SimpleUeComponentCarrierManager::GetLteMacSapProvider ( )
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

Implements ns3::LteUeComponentCarrierManager.

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

References m_ccmMacSapProvider, and NS_LOG_FUNCTION.

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

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

Implements ns3::LteUeComponentCarrierManager.

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

References m_ccmRrcSapUser, and NS_LOG_FUNCTION.

Friends And Related Function Documentation

let the forwarder class access the protected and private members

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

friend class SimpleUeCcmMacSapProvider
friend

allow SimpleUeCcmMacSapProvider class friend access

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

Referenced by SimpleUeComponentCarrierManager().

friend class SimpleUeCcmMacSapUser
friend

allow SimpleUeCcmMacSapUser class friend access

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

Referenced by SimpleUeComponentCarrierManager().

Member Data Documentation

LteMacSapProvider* ns3::SimpleUeComponentCarrierManager::m_ccmMacSapProvider
private

Receive API calls from the eNodeB RLC instance.

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

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

LteMacSapUser* ns3::SimpleUeComponentCarrierManager::m_ccmMacSapUser
private

Interface to the eNodeB RLC instance.

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

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

LteUeCcmRrcSapProvider* ns3::SimpleUeComponentCarrierManager::m_ccmRrcSapProvider
private

Receive API calls from the eNodeB RRC instance.

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

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

LteUeCcmRrcSapUser* ns3::SimpleUeComponentCarrierManager::m_ccmRrcSapUser
private

Interface to the eNodeB RRC instance.

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

Referenced by DoNotifyConnectionReconfigurationMsg(), and SetLteCcmRrcSapUser().


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