Defines a single carrier for enb, and contains pointers to LteEnbPhy, LteEnbMac, LteFfrAlgorithm, and FfMacScheduler objects. More...

#include "component-carrier-enb.h"

Inheritance diagram for ns3::ComponentCarrierEnb:

Public Member Functions
	ComponentCarrierEnb ()

virtual	~ComponentCarrierEnb (void)

virtual void	DoDispose (void)
	Destructor implementation. More...

uint16_t	GetCellId ()
	Get cell identifier. More...

Ptr< FfMacScheduler >	GetFfMacScheduler ()

Ptr< LteFfrAlgorithm >	GetFfrAlgorithm ()

Ptr< LteEnbMac >	GetMac (void)

Ptr< LteEnbPhy >	GetPhy (void)

void	SetCellId (uint16_t cellId)
	Set physical cell identifier. More...

void	SetFfMacScheduler (Ptr< FfMacScheduler > s)
	Set the FfMacScheduler Algorithm. More...

void	SetFfrAlgorithm (Ptr< LteFfrAlgorithm > s)
	Set the LteFfrAlgorithm. More...

void	SetMac (Ptr< LteEnbMac > s)
	Set the LteEnbMac. More...

void	SetPhy (Ptr< LteEnbPhy > s)
	Set the LteEnbPhy. More...

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

virtual	~ComponentCarrier (void)

uint32_t	GetCsgId () const
	Returns the CSG ID of the eNodeB. More...

bool	GetCsgIndication () const
	Returns the CSG indication flag of the eNodeB. More...

uint8_t	GetDlBandwidth () const

uint32_t	GetDlEarfcn () const

uint8_t	GetUlBandwidth () const

uint32_t	GetUlEarfcn () const

bool	IsPrimary () const
	Checks if the carrier is the primary carrier. More...

void	SetAsPrimary (bool primaryCarrier)
	Set as primary carrier. More...

void	SetCsgId (uint32_t csgId)
	Associate the eNodeB device with a particular CSG. More...

void	SetCsgIndication (bool csgIndication)
	Enable or disable the CSG indication flag. More...

void	SetDlBandwidth (uint8_t bw)

void	SetDlEarfcn (uint32_t earfcn)

void	SetUlBandwidth (uint8_t bw)

void	SetUlEarfcn (uint32_t earfcn)

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

SimpleRefCount &	operator= (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 (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::ComponentCarrier
static TypeId	GetTypeId (void)
	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	DoInitialize (void)
	Initialize() implementation. 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
uint16_t	m_cellId
	Cell identifier. More...

Ptr< LteFfrAlgorithm >	m_ffrAlgorithm
	the FFR algorithm instance of this eNodeB component carrier More...

Ptr< LteEnbMac >	m_mac
	the MAC instance of this eNodeB component carrier More...

Ptr< LteEnbPhy >	m_phy
	the Phy instance of this eNodeB component carrier More...

Ptr< FfMacScheduler >	m_scheduler
	the scheduler instance of this eNodeB component carrier More...

Additional Inherited Members
Public Attributes inherited from ns3::ComponentCarrier
uint8_t	m_dlBandwidth
	downlink bandwidth in RBs More...

uint32_t	m_dlEarfcn
	downlink carrier frequency More...

uint8_t	m_ulBandwidth
	uplink bandwidth in RBs More...

uint32_t	m_ulEarfcn
	uplink carrier frequency More...

Protected Attributes inherited from ns3::ComponentCarrier
uint16_t	m_csgId
	CSG ID. More...

bool	m_csgIndication
	CSG indication. More...

bool	m_isConstructed
	whether the instance is constructed More...

bool	m_primaryCarrier
	whether the carrier is primary More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Defines a single carrier for enb, and contains pointers to LteEnbPhy, LteEnbMac, LteFfrAlgorithm, and FfMacScheduler objects.

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/ComponentCarrierMap/[i]"
"/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/ComponentCarrierMap/[i]"

Attributes

LteEnbPhy: The PHY associated to this EnbNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::LteEnbPhy>
- Initial value: 0x0
- Flags: construct write read
LteEnbMac: The MAC associated to this EnbNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::LteEnbMac>
- Initial value: 0x0
- Flags: construct write read
FfMacScheduler: The scheduler associated to this EnbNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::FfMacScheduler>
- Initial value: 0x0
- Flags: construct write read
LteFfrAlgorithm: The FFR algorithm associated to this EnbNetDevice
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::LteFfrAlgorithm>
- Initial value: 0x0
- Flags: construct write read

Attributes defined in parent class ns3::ComponentCarrier

UlBandwidth: Uplink Transmission Bandwidth Configuration in number of Resource Blocks
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 25
- Flags: construct write read
DlBandwidth: Downlink Transmission Bandwidth Configuration in number of Resource Blocks
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 25
- Flags: construct write read
DlEarfcn: Downlink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) as per 3GPP 36.101 Section 5.7.3.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:262143
- Initial value: 100
- Flags: construct write read
UlEarfcn: Uplink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) as per 3GPP 36.101 Section 5.7.3.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 18000:262143
- Initial value: 18100
- Flags: construct write read
CsgId: The Closed Subscriber Group (CSG) identity that this eNodeB belongs to
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- Flags: construct write read
CsgIndication: If true, only UEs which are members of the CSG (i.e. same CSG ID) can gain access to the eNodeB, therefore enforcing closed access mode. Otherwise, the eNodeB operates as a non-CSG cell and implements open access mode.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
PrimaryCarrier: If true, this Carrier Component will be the Primary Carrier Component (PCC) Only one PCC per eNodeB is (currently) allowed
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read

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

Definition at line 48 of file component-carrier-enb.h.

Constructor & Destructor Documentation

◆ ComponentCarrierEnb()

ns3::ComponentCarrierEnb::ComponentCarrierEnb ( )

Definition at line 68 of file component-carrier-enb.cc.

References NS_LOG_FUNCTION.

◆ ~ComponentCarrierEnb()

ns3::ComponentCarrierEnb::~ComponentCarrierEnb ( void )

virtual

Definition at line 73 of file component-carrier-enb.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::ComponentCarrierEnb::DoDispose ( void )

virtual

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

Definition at line 79 of file component-carrier-enb.cc.

References ns3::Object::DoDispose(), m_ffrAlgorithm, m_mac, m_phy, m_scheduler, and NS_LOG_FUNCTION.

◆ DoInitialize()

void ns3::ComponentCarrierEnb::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::ComponentCarrier.

Definition at line 108 of file component-carrier-enb.cc.

References m_ffrAlgorithm, ns3::ComponentCarrier::m_isConstructed, m_mac, m_phy, m_scheduler, and NS_LOG_FUNCTION.