ComponentCarrier Object, it defines a single Carrier This is the parent class for both ComponentCarrierBaseStation and ComponentCarrierUe. More...

#include "component-carrier.h"

Inheritance diagram for ns3::ComponentCarrier:

Collaboration diagram for ns3::ComponentCarrier:

Public Member Functions
	ComponentCarrier ()

	~ComponentCarrier () override

void	DoDispose () override
	Destructor implementation.

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::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Attributes
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 *‍/

Additional Inherited Members
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.

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

ComponentCarrier Object, it defines a single Carrier This is the parent class for both ComponentCarrierBaseStation and ComponentCarrierUe.

This class contains the main physical configuration parameters for a carrier. Does not contain pointers to the MAC/PHY objects of the carrier.

Definition at line 27 of file component-carrier.h.

Constructor & Destructor Documentation

◆ ComponentCarrier()

ns3::ComponentCarrier::ComponentCarrier ( )

Definition at line 83 of file component-carrier.cc.

References NS_LOG_FUNCTION.

◆ ~ComponentCarrier()

ns3::ComponentCarrier::~ComponentCarrier ( )

override

Definition at line 89 of file component-carrier.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

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

Reimplemented in ns3::ComponentCarrierEnb, and ns3::ComponentCarrierUe.

Definition at line 95 of file component-carrier.cc.

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

Here is the call graph for this function:

◆ GetCsgId()

uint32_t ns3::ComponentCarrier::GetCsgId ( ) const

Returns the CSG ID of the eNodeB.

Returns: the Closed Subscriber Group identity

See also: LteEnbNetDevice::SetCsgId

Definition at line 182 of file component-carrier.cc.

References m_csgId.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetCsgIndication()

bool ns3::ComponentCarrier::GetCsgIndication ( ) const

Returns the CSG indication flag of the eNodeB.

Returns: the CSG indication flag

See also: LteEnbNetDevice::SetCsgIndication

Definition at line 195 of file component-carrier.cc.

References m_csgIndication.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetDlBandwidth()

uint16_t ns3::ComponentCarrier::GetDlBandwidth ( ) const

Returns: the downlink bandwidth in RBs

Definition at line 129 of file component-carrier.cc.

References m_dlBandwidth.

Referenced by GetTypeId(), and Print().

Here is the caller graph for this function:

◆ GetDlEarfcn()

uint32_t ns3::ComponentCarrier::GetDlEarfcn ( ) const

Returns: the downlink carrier frequency (EARFCN)

Definition at line 156 of file component-carrier.cc.

References m_dlEarfcn.

Referenced by ns3::CcHelper::CreateSingleCc(), GetTypeId(), and Print().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ComponentCarrier::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 24 of file component-carrier.cc.

References GetCsgId(), GetCsgIndication(), GetDlBandwidth(), GetDlEarfcn(), GetUlBandwidth(), GetUlEarfcn(), IsPrimary(), ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), SetAsPrimary(), SetCsgId(), SetCsgIndication(), SetDlBandwidth(), SetDlEarfcn(), ns3::TypeId::SetParent(), SetUlBandwidth(), and SetUlEarfcn().

Referenced by ns3::CcHelper::CcHelper().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUlBandwidth()

uint16_t ns3::ComponentCarrier::GetUlBandwidth ( ) const

Returns: the uplink bandwidth in RBs

Definition at line 102 of file component-carrier.cc.

References m_ulBandwidth.

Referenced by GetTypeId(), and Print().

Here is the caller graph for this function:

◆ GetUlEarfcn()

uint32_t ns3::ComponentCarrier::GetUlEarfcn ( ) const

Returns: the uplink carrier frequency (EARFCN)

Definition at line 169 of file component-carrier.cc.

References m_ulEarfcn.

Referenced by ns3::CcHelper::CreateSingleCc(), GetTypeId(), and Print().

Here is the caller graph for this function:

◆ IsPrimary()

bool ns3::ComponentCarrier::IsPrimary ( ) const

Checks if the carrier is the primary carrier.

Returns: true if the carrier is primary

Definition at line 208 of file component-carrier.cc.

References m_primaryCarrier.

Referenced by GetTypeId(), and Print().

Here is the caller graph for this function:

◆ SetAsPrimary()

void ns3::ComponentCarrier::SetAsPrimary ( bool primaryCarrier )

Set as primary carrier.

Parameters

primaryCarrier true to set as primary carrier

Definition at line 214 of file component-carrier.cc.

References m_primaryCarrier, and NS_LOG_FUNCTION.

Referenced by ns3::CcHelper::CreateSingleCc(), and GetTypeId().

Here is the caller graph for this function:

◆ SetCsgId()

void ns3::ComponentCarrier::SetCsgId ( uint32_t csgId )

Associate the eNodeB device with a particular CSG.

Parameters

csgId the intended Closed Subscriber Group identity

CSG identity is a number identifying a Closed Subscriber Group which the cell belongs to. eNodeB is associated with a single CSG identity.

The same CSG identity can also be associated to several UEs, which is equivalent as enlisting these UEs as the members of this particular CSG.

See also: LteEnbNetDevice::SetCsgIndication

Definition at line 188 of file component-carrier.cc.

References m_csgId, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetCsgIndication()

void ns3::ComponentCarrier::SetCsgIndication ( bool csgIndication )

Enable or disable the CSG indication flag.

Parameters

csgIndication if TRUE, only CSG members are allowed to access this cell

When the CSG indication field is set to 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.

Note: This restriction only applies to initial cell selection and EPC-enabled simulation.

See also: LteEnbNetDevice::SetCsgIndication

Definition at line 201 of file component-carrier.cc.

References m_csgIndication, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetDlBandwidth()

void ns3::ComponentCarrier::SetDlBandwidth ( uint16_t bw )

virtual

Parameters

bw	the downlink bandwidth in RBs

Definition at line 135 of file component-carrier.cc.

References m_dlBandwidth, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by ns3::CcHelper::CreateSingleCc(), and GetTypeId().

Here is the caller graph for this function:

◆ SetDlEarfcn()

void ns3::ComponentCarrier::SetDlEarfcn ( uint32_t earfcn )

Parameters

earfcn the downlink carrier frequency (EARFCN)

Definition at line 162 of file component-carrier.cc.

References m_dlEarfcn, and NS_LOG_FUNCTION.

Referenced by ns3::CcHelper::CreateSingleCc(), and GetTypeId().

Here is the caller graph for this function:

◆ SetUlBandwidth()

void ns3::ComponentCarrier::SetUlBandwidth ( uint16_t bw )

virtual

Parameters

bw	the uplink bandwidth in RBs

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

References m_ulBandwidth, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by ns3::CcHelper::CreateSingleCc(), and GetTypeId().

Here is the caller graph for this function:

◆ SetUlEarfcn()

void ns3::ComponentCarrier::SetUlEarfcn ( uint32_t earfcn )

Parameters

earfcn the uplink carrier frequency (EARFCN)

Definition at line 175 of file component-carrier.cc.

References m_ulEarfcn, and NS_LOG_FUNCTION.

Referenced by ns3::CcHelper::CreateSingleCc(), and GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_csgId

uint32_t ns3::ComponentCarrier::m_csgId {0}

protected

CSG ID.

Definition at line 139 of file component-carrier.h.

Referenced by GetCsgId(), and SetCsgId().

◆ m_csgIndication

bool ns3::ComponentCarrier::m_csgIndication {false}

protected

CSG indication.

Definition at line 140 of file component-carrier.h.

Referenced by GetCsgIndication(), and SetCsgIndication().

◆ m_dlBandwidth

uint16_t ns3::ComponentCarrier::m_dlBandwidth {0}

protected

downlink bandwidth in RBs *‍/

Definition at line 144 of file component-carrier.h.

Referenced by GetDlBandwidth(), and SetDlBandwidth().

◆ m_dlEarfcn

uint32_t ns3::ComponentCarrier::m_dlEarfcn {0}

protected

downlink carrier frequency *‍/

Definition at line 147 of file component-carrier.h.

Referenced by GetDlEarfcn(), and SetDlEarfcn().

◆ m_primaryCarrier

bool ns3::ComponentCarrier::m_primaryCarrier {false}

protected

whether the carrier is primary

Definition at line 142 of file component-carrier.h.

Referenced by IsPrimary(), and SetAsPrimary().

◆ m_ulBandwidth

uint16_t ns3::ComponentCarrier::m_ulBandwidth {0}

protected

uplink bandwidth in RBs *‍/

Definition at line 145 of file component-carrier.h.

Referenced by GetUlBandwidth(), and SetUlBandwidth().

◆ m_ulEarfcn

uint32_t ns3::ComponentCarrier::m_ulEarfcn {0}

protected

uplink carrier frequency *‍/

Definition at line 148 of file component-carrier.h.

Referenced by GetUlEarfcn(), and SetUlEarfcn().

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

src/lte/model/component-carrier.h
src/lte/model/component-carrier.cc

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ComponentCarrier()

◆ ~ComponentCarrier()

Member Function Documentation

◆ DoDispose()

◆ GetCsgId()

◆ GetCsgIndication()

◆ GetDlBandwidth()

◆ GetDlEarfcn()

◆ GetTypeId()

◆ GetUlBandwidth()

◆ GetUlEarfcn()

◆ IsPrimary()

◆ SetAsPrimary()

◆ SetCsgId()

◆ SetCsgIndication()

◆ SetDlBandwidth()

◆ SetDlEarfcn()

◆ SetUlBandwidth()

◆ SetUlEarfcn()

Member Data Documentation

◆ m_csgId

◆ m_csgIndication

◆ m_dlBandwidth

◆ m_dlEarfcn

◆ m_primaryCarrier

◆ m_ulBandwidth

◆ m_ulEarfcn