ns3::BandwidthPartUe Class Reference

Bandwidth part representation for a UE. More...

#include "bandwidth-part-ue.h"

Inheritance diagram for ns3::BandwidthPartUe:

Collaboration diagram for ns3::BandwidthPartUe:

Public Member Functions
	BandwidthPartUe ()
	BandwidthPartUe constructor.
	~BandwidthPartUe () override
	~BandwidthPartUe
Ptr< NrUeMac >	GetMac () const
Ptr< NrUePhy >	GetPhy () const
void	SetDlBandwidth (uint16_t bw) override
void	SetMac (Ptr< NrUeMac > s)
void	SetPhy (Ptr< NrUePhy > s)
void	SetUlBandwidth (uint16_t bw) override
Public Member Functions inherited from ns3::NrComponentCarrier
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.
void	SetDlEarfcn (uint32_t earfcn)
void	SetUlEarfcn (uint32_t earfcn)

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

Protected Member Functions
void	DoDispose () override
	DoDispose method inherited from Object.

Additional Inherited Members
Protected Attributes inherited from ns3::NrComponentCarrier
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

Bandwidth part representation for a UE.

Config Paths

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

• /NodeList/[i]/DeviceList/[i]/$ns3::NrNetDevice/$ns3::NrUeNetDevice/ComponentCarrierMapUe/[i]
• /NodeList/[i]/DeviceList/[i]/$ns3::NrUeNetDevice/ComponentCarrierMapUe/[i]

Attributes

• NrUePhy: The PHY associated to this BandwidthPartUe
  • Set with class: ns3::PointerValue
  • Underlying type: ns3::Ptr< ns3::NrUePhy>
  • Initial value: 0
  • Flags: construct write read
• NrUeMac: The MAC associated to this BandwidthPartUe
  • Set with class: ns3::PointerValue
  • Underlying type: ns3::Ptr< ns3::NrUeMac>
  • Initial value: 0
  • Flags: construct write read

Attributes defined in parent class ns3::NrComponentCarrier

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

Definition at line 24 of file bandwidth-part-ue.h.

Constructor & Destructor Documentation

BandwidthPartUe()

ns3::BandwidthPartUe::BandwidthPartUe

(

)

BandwidthPartUe constructor.

Definition at line 41 of file bandwidth-part-ue.cc.

~BandwidthPartUe()

ns3::BandwidthPartUe::~BandwidthPartUe ( )

override

~BandwidthPartUe

Definition at line 48 of file bandwidth-part-ue.cc.

Member Function Documentation

DoDispose()

void ns3::BandwidthPartUe::DoDispose ( )

overrideprotected

DoDispose method inherited from Object.

Definition at line 54 of file bandwidth-part-ue.cc.

GetMac()

Ptr< NrUeMac > ns3::BandwidthPartUe::GetMac

(

)

const

Returns

a pointer to the MAC layer.

Definition at line 87 of file bandwidth-part-ue.cc.

GetPhy()

Ptr< NrUePhy > ns3::BandwidthPartUe::GetPhy

(

)

const

Returns

a pointer to the physical layer.

Definition at line 73 of file bandwidth-part-ue.cc.

GetTypeId()

TypeId ns3::BandwidthPartUe::GetTypeId ( )

static

Get the type ID.

Returns

the object TypeId

Definition at line 23 of file bandwidth-part-ue.cc.

SetDlBandwidth()

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

inlineoverridevirtual

Parameters

bw	the downlink bandwidth in RBs

Reimplemented from ns3::NrComponentCarrier.

Definition at line 65 of file bandwidth-part-ue.h.

References ns3::NrComponentCarrier::m_dlBandwidth.

SetMac()

void ns3::BandwidthPartUe::SetMac

(

Ptr< NrUeMac >

s

)

Set the NrGnbMac

Parameters

s	a pointer to the NrGnbMac

Definition at line 80 of file bandwidth-part-ue.cc.

SetPhy()

void ns3::BandwidthPartUe::SetPhy

(

Ptr< NrUePhy >

s

)

Set NrUePhy

Parameters

s	a pointer to the NrUePhy

Definition at line 65 of file bandwidth-part-ue.cc.

SetUlBandwidth()

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

inlineoverridevirtual

Parameters

bw	the uplink bandwidth in RBs

Reimplemented from ns3::NrComponentCarrier.

Definition at line 70 of file bandwidth-part-ue.h.

References ns3::NrComponentCarrier::m_ulBandwidth.

---

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

• bandwidth-part-ue.h
• bandwidth-part-ue.cc