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:

Collaboration diagram for ns3::ComponentCarrierEnb:

Public Member Functions
	ComponentCarrierEnb ()

	~ComponentCarrierEnb () override

void	DoDispose () override
	Destructor implementation.

Ptr< FfMacScheduler >	GetFfMacScheduler ()

Ptr< LteFfrAlgorithm >	GetFfrAlgorithm ()

Ptr< LteEnbMac >	GetMac ()

Ptr< LteEnbPhy >	GetPhy ()

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

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

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

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

Public Member Functions inherited from ns3::ComponentCarrierBaseStation
	ComponentCarrierBaseStation ()
	Constructor.

	~ComponentCarrierBaseStation () override
	~ComponentCarrierBaseStation

uint16_t	GetCellId () const
	Get cell identifier.

void	SetCellId (uint16_t cellId)
	Set physical cell identifier.

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

	~ComponentCarrier () override

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

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

uint16_t	GetDlBandwidth () const

uint32_t	GetDlEarfcn () const

uint16_t	GetUlBandwidth () const

uint32_t	GetUlEarfcn () const

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

void	SetAsPrimary (bool primaryCarrier)
	Set as primary carrier.

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

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

virtual void	SetDlBandwidth (uint16_t bw)

void	SetDlEarfcn (uint32_t earfcn)

virtual void	SetUlBandwidth (uint16_t bw)

void	SetUlEarfcn (uint32_t earfcn)

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::ComponentCarrierBaseStation
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ComponentCarrier
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	DoInitialize () override
	Initialize() implementation.

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.

Private Attributes
Ptr< LteFfrAlgorithm >	m_ffrAlgorithm
	the FFR algorithm instance of this eNodeB component carrier

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

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

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

Additional Inherited Members
Protected Attributes inherited from ns3::ComponentCarrierBaseStation
uint16_t	m_cellId {0}
	Cell identifier.

Protected Attributes inherited from ns3::ComponentCarrier
uint32_t	m_csgId {0}
	CSG ID.

bool	m_csgIndication {false}
	CSG indication.

uint16_t	m_dlBandwidth {0}
	downlink bandwidth in RBs *‍/

uint32_t	m_dlEarfcn {0}
	downlink carrier frequency *‍/

bool	m_primaryCarrier {false}
	whether the carrier is primary

uint16_t	m_ulBandwidth {0}
	uplink bandwidth in RBs *‍/

uint32_t	m_ulEarfcn {0}
	uplink carrier frequency *‍/

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

Detailed Description

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

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

Constructor & Destructor Documentation

◆ ComponentCarrierEnb()

ns3::ComponentCarrierEnb::ComponentCarrierEnb ( )

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

References NS_LOG_FUNCTION.

◆ ~ComponentCarrierEnb()

ns3::ComponentCarrierEnb::~ComponentCarrierEnb ( )

override

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::ComponentCarrierEnb::DoDispose ( )

overridevirtual

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 69 of file component-carrier-enb.cc.

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

Here is the call graph for this function:

◆ DoInitialize()

void ns3::ComponentCarrierEnb::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 97 of file component-carrier-enb.cc.

References m_ffrAlgorithm, m_mac, m_phy, m_scheduler, and NS_LOG_FUNCTION.