A Discrete-Event Network Simulator
API
ns3::ComponentCarrier Class Reference

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 ()
 
virtual ~ComponentCarrier (void)
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
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...
 
virtual void SetDlBandwidth (uint8_t bw)
 
void SetDlEarfcn (uint32_t earfcn)
 
virtual 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...
 
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 (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...
 

Public Attributes

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

Protected Attributes

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

Additional Inherited Members

Detailed Description

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


Introspection did not find any typical Config paths.

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


Attributes

  • 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 48 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ ComponentCarrier()

ns3::ComponentCarrier::ComponentCarrier ( )

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

References NS_LOG_FUNCTION.

◆ ~ComponentCarrier()

ns3::ComponentCarrier::~ComponentCarrier ( void  )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

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

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

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

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

+ Here is the call graph for this function:

◆ DoInitialize()

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

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

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

References m_isConstructed, and NS_LOG_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 190 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 203 of file component-carrier.cc.

References m_csgIndication.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetDlBandwidth()

uint8_t ns3::ComponentCarrier::GetDlBandwidth ( ) const
Returns
the downlink bandwidth in RBs

Definition at line 137 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 164 of file component-carrier.cc.

References m_dlEarfcn.

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

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

References GetCsgId(), GetCsgIndication(), GetDlBandwidth(), GetUlBandwidth(), IsPrimary(), m_dlEarfcn, m_ulEarfcn, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeUintegerAccessor(), SetAsPrimary(), SetCsgId(), SetCsgIndication(), SetDlBandwidth(), ns3::TypeId::SetParent(), and SetUlBandwidth().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetUlBandwidth()

uint8_t ns3::ComponentCarrier::GetUlBandwidth ( ) const
Returns
the uplink bandwidth in RBs

Definition at line 110 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 177 of file component-carrier.cc.

References m_ulEarfcn.

Referenced by ns3::CcHelper::CreateSingleCc(), 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 216 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
primaryCarriertrue to set as primary carrier

Definition at line 222 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
csgIdthe 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 196 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
csgIndicationif 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 209 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 ( uint8_t  bw)
virtual
Parameters
bwthe downlink bandwidth in RBs

Definition at line 143 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
earfcnthe downlink carrier frequency (EARFCN)

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

References m_dlEarfcn, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

◆ SetUlBandwidth()

void ns3::ComponentCarrier::SetUlBandwidth ( uint8_t  bw)
virtual
Parameters
bwthe uplink bandwidth in RBs

Definition at line 116 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
earfcnthe uplink carrier frequency (EARFCN)

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

References m_ulEarfcn, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_csgId

uint16_t ns3::ComponentCarrier::m_csgId
protected

CSG ID.

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

Referenced by GetCsgId(), and SetCsgId().

◆ m_csgIndication

bool ns3::ComponentCarrier::m_csgIndication
protected

CSG indication.

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

Referenced by GetCsgIndication(), and SetCsgIndication().

◆ m_dlBandwidth

uint8_t ns3::ComponentCarrier::m_dlBandwidth

downlink bandwidth in RBs

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

Referenced by GetDlBandwidth(), and SetDlBandwidth().

◆ m_dlEarfcn

uint32_t ns3::ComponentCarrier::m_dlEarfcn

downlink carrier frequency

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

Referenced by GetDlEarfcn(), GetTypeId(), and SetDlEarfcn().

◆ m_isConstructed

bool ns3::ComponentCarrier::m_isConstructed
protected

whether the instance is constructed

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

Referenced by ns3::ComponentCarrierUe::DoInitialize(), ns3::ComponentCarrierEnb::DoInitialize(), and DoInitialize().

◆ m_primaryCarrier

bool ns3::ComponentCarrier::m_primaryCarrier
protected

whether the carrier is primary

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

Referenced by IsPrimary(), and SetAsPrimary().

◆ m_ulBandwidth

uint8_t ns3::ComponentCarrier::m_ulBandwidth

uplink bandwidth in RBs

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

Referenced by GetUlBandwidth(), and SetUlBandwidth().

◆ m_ulEarfcn

uint32_t ns3::ComponentCarrier::m_ulEarfcn

uplink carrier frequency

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

Referenced by GetTypeId(), GetUlEarfcn(), and SetUlEarfcn().


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