Searching...

No Matches

#include "nr-component-carrier.h"

Inheritance diagram for ns3::NrComponentCarrier:

Collaboration diagram for ns3::NrComponentCarrier:

Public Member Functions
void	DoDispose () 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)

Static Public Member Functions
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 *‍/

Detailed Description

NrComponentCarrier Object, it defines a single Carrier This is the parent class for both NrComponentCarrier 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.

Introspection did not find any typical Config paths.

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: ns3::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: ns3::BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read

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

Definition at line 25 of file nr-component-carrier.h.

Constructor & Destructor Documentation

◆ NrComponentCarrier()

ns3::NrComponentCarrier::NrComponentCarrier ( )

Definition at line 82 of file nr-component-carrier.cc.

◆ ~NrComponentCarrier()

ns3::NrComponentCarrier::~NrComponentCarrier ( )

override

Definition at line 88 of file nr-component-carrier.cc.

Member Function Documentation

◆ DoDispose()

void ns3::NrComponentCarrier::DoDispose ( )

override

Definition at line 94 of file nr-component-carrier.cc.

◆ GetCsgId()

uint32_t ns3::NrComponentCarrier::GetCsgId ( ) const

Returns the CSG ID of the eNodeB.

Returns: the Closed Subscriber Group identity

See also: NrGnbNetDevice::SetCsgId

Definition at line 181 of file nr-component-carrier.cc.

References m_csgId.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetCsgIndication()

bool ns3::NrComponentCarrier::GetCsgIndication ( ) const

Returns the CSG indication flag of the eNodeB.

Returns: the CSG indication flag

See also: NrGnbNetDevice::SetCsgIndication

Definition at line 194 of file nr-component-carrier.cc.

References m_csgIndication.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetDlBandwidth()

uint16_t ns3::NrComponentCarrier::GetDlBandwidth ( ) const

Returns: the downlink bandwidth in RBs

Definition at line 128 of file nr-component-carrier.cc.

References m_dlBandwidth.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetDlEarfcn()

uint32_t ns3::NrComponentCarrier::GetDlEarfcn ( ) const

Returns: the downlink carrier frequency (EARFCN)

Definition at line 155 of file nr-component-carrier.cc.

References m_dlEarfcn.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::NrComponentCarrier::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 22 of file nr-component-carrier.cc.

References GetCsgId(), GetCsgIndication(), GetDlBandwidth(), GetDlEarfcn(), GetUlBandwidth(), GetUlEarfcn(), IsPrimary(), SetAsPrimary(), SetCsgId(), SetCsgIndication(), SetDlBandwidth(), SetDlEarfcn(), SetUlBandwidth(), and SetUlEarfcn().

Here is the call graph for this function:

◆ GetUlBandwidth()

uint16_t ns3::NrComponentCarrier::GetUlBandwidth ( ) const

Returns: the uplink bandwidth in RBs

Definition at line 101 of file nr-component-carrier.cc.

References m_ulBandwidth.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetUlEarfcn()

uint32_t ns3::NrComponentCarrier::GetUlEarfcn ( ) const

Returns: the uplink carrier frequency (EARFCN)

Definition at line 168 of file nr-component-carrier.cc.

References m_ulEarfcn.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ IsPrimary()

bool ns3::NrComponentCarrier::IsPrimary ( ) const

Checks if the carrier is the primary carrier.

Returns: true if the carrier is primary

Definition at line 207 of file nr-component-carrier.cc.

References m_primaryCarrier.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetAsPrimary()

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

Set as primary carrier.

Parameters

primaryCarrier true to set as primary carrier

Definition at line 213 of file nr-component-carrier.cc.

References m_primaryCarrier.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetCsgId()

void ns3::NrComponentCarrier::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: NrGnbNetDevice::SetCsgIndication

Definition at line 187 of file nr-component-carrier.cc.

References m_csgId.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetCsgIndication()

void ns3::NrComponentCarrier::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: NrGnbNetDevice::SetCsgIndication

Definition at line 200 of file nr-component-carrier.cc.

References m_csgIndication.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetDlBandwidth()

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

virtual

Parameters

bw	the downlink bandwidth in RBs

Reimplemented in ns3::BandwidthPartGnb, and ns3::BandwidthPartUe.

Definition at line 134 of file nr-component-carrier.cc.

References m_dlBandwidth.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetDlEarfcn()

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

Parameters

earfcn the downlink carrier frequency (EARFCN)

Definition at line 161 of file nr-component-carrier.cc.

References m_dlEarfcn.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetUlBandwidth()

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

virtual

Parameters

bw	the uplink bandwidth in RBs

Reimplemented in ns3::BandwidthPartGnb, and ns3::BandwidthPartUe.

Definition at line 107 of file nr-component-carrier.cc.

References m_ulBandwidth.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetUlEarfcn()

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

Parameters

earfcn the uplink carrier frequency (EARFCN)

Definition at line 174 of file nr-component-carrier.cc.

References m_ulEarfcn.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_csgId

uint32_t ns3::NrComponentCarrier::m_csgId {0}

protected

CSG ID.

Definition at line 137 of file nr-component-carrier.h.

Referenced by GetCsgId(), and SetCsgId().

◆ m_csgIndication

bool ns3::NrComponentCarrier::m_csgIndication {false}

protected

CSG indication.

Definition at line 138 of file nr-component-carrier.h.

Referenced by GetCsgIndication(), and SetCsgIndication().

◆ m_dlBandwidth

uint16_t ns3::NrComponentCarrier::m_dlBandwidth {0}

protected

downlink bandwidth in RBs *‍/

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

Referenced by GetDlBandwidth(), SetDlBandwidth(), ns3::BandwidthPartGnb::SetDlBandwidth(), and ns3::BandwidthPartUe::SetDlBandwidth().

◆ m_dlEarfcn

uint32_t ns3::NrComponentCarrier::m_dlEarfcn {0}

protected

downlink carrier frequency *‍/

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

Referenced by GetDlEarfcn(), and SetDlEarfcn().

◆ m_primaryCarrier

bool ns3::NrComponentCarrier::m_primaryCarrier {false}

protected

whether the carrier is primary

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

Referenced by IsPrimary(), and SetAsPrimary().

◆ m_ulBandwidth

uint16_t ns3::NrComponentCarrier::m_ulBandwidth {0}

protected

uplink bandwidth in RBs *‍/

Definition at line 143 of file nr-component-carrier.h.

Referenced by GetUlBandwidth(), SetUlBandwidth(), ns3::BandwidthPartGnb::SetUlBandwidth(), and ns3::BandwidthPartUe::SetUlBandwidth().

◆ m_ulEarfcn

uint32_t ns3::NrComponentCarrier::m_ulEarfcn {0}

protected

uplink carrier frequency *‍/

Definition at line 146 of file nr-component-carrier.h.

Referenced by GetUlEarfcn(), and SetUlEarfcn().

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ NrComponentCarrier()

◆ ~NrComponentCarrier()

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