A Discrete-Event Network Simulator
API
ns3::LtePhy Class Referenceabstract

The LtePhy models the physical layer of LTE. More...

#include "lte-phy.h"

+ Inheritance diagram for ns3::LtePhy:
+ Collaboration diagram for ns3::LtePhy:

Public Member Functions

 LtePhy ()
 
 LtePhy (Ptr< LteSpectrumPhy > dlPhy, Ptr< LteSpectrumPhy > ulPhy)
 
virtual ~LtePhy ()
 
virtual Ptr< SpectrumValueCreateTxPowerSpectralDensity ()=0
 Compute the TX Power Spectral Density. More...
 
void DoDispose ()
 Destructor implementation. More...
 
virtual void DoSendMacPdu (Ptr< Packet > p)=0
 Queue the MAC PDU to be sent (according to m_macChTtiDelay) More...
 
void DoSetCellId (uint16_t cellId)
 
virtual void GenerateCtrlCqiReport (const SpectrumValue &sinr)=0
 generate a CQI report based on the given SINR of Ctrl frame More...
 
virtual void GenerateDataCqiReport (const SpectrumValue &sinr)=0
 generate a CQI report based on the given SINR of Data frame (used for PUSCH CQIs) More...
 
uint8_t GetComponentCarrierId ()
 Get the component carrier ID. More...
 
std::list< Ptr< LteControlMessage > > GetControlMessages (void)
 
Ptr< LteNetDeviceGetDevice () const
 Get the device where the phy layer is attached. More...
 
Ptr< LteSpectrumPhyGetDownlinkSpectrumPhy ()
 
Ptr< PacketBurstGetPacketBurst (void)
 
uint8_t GetRbgSize (void) const
 
uint16_t GetSrsPeriodicity (uint16_t srcCi) const
 
uint16_t GetSrsSubframeOffset (uint16_t srcCi) const
 
double GetTti (void) const
 
Ptr< LteSpectrumPhyGetUplinkSpectrumPhy ()
 
virtual void ReportInterference (const SpectrumValue &interf)=0
 generate a report based on the linear interference and noise power perceived during DATA frame NOTE: used only by eNB More...
 
virtual void ReportRsReceivedPower (const SpectrumValue &power)=0
 generate a report based on the linear RS power perceived during CTRL frame NOTE: used only by UE for evaluating RSRP More...
 
void SetComponentCarrierId (uint8_t index)
 Set the component carrier ID. More...
 
void SetControlMessages (Ptr< LteControlMessage > m)
 
void SetDevice (Ptr< LteNetDevice > d)
 Set the device where the phy layer is attached. More...
 
void SetDownlinkChannel (Ptr< SpectrumChannel > c)
 Set the downlink channel. More...
 
void SetMacPdu (Ptr< Packet > p)
 
void SetTti (double tti)
 
void SetUplinkChannel (Ptr< SpectrumChannel > c)
 Set the uplink channel. More...
 
- 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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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...
 

Protected Attributes

uint16_t m_cellId
 Cell identifier. More...
 
uint8_t m_componentCarrierId
 component carrier Id used to address sap More...
 
std::vector< std::list< Ptr< LteControlMessage > > > m_controlMessagesQueue
 A queue of control messages to be sent. More...
 
uint16_t m_dlBandwidth
 The DL bandwidth in number of PRBs. More...
 
uint32_t m_dlEarfcn
 The downlink carrier frequency. More...
 
Ptr< LteSpectrumPhym_downlinkSpectrumPhy
 The downlink LteSpectrumPhy associated to this LtePhy. More...
 
uint8_t m_macChTtiDelay
 Delay between MAC and channel layer in terms of TTIs. More...
 
Ptr< LteNetDevicem_netDevice
 Pointer to the NetDevice where this PHY layer is attached. More...
 
double m_noiseFigure
 Loss (dB) in the Signal-to-Noise-Ratio due to non-idealities in the receiver. More...
 
std::vector< Ptr< PacketBurst > > m_packetBurstQueue
 A queue of packet bursts to be sent. More...
 
uint8_t m_rbgSize
 The RB group size according to the bandwidth. More...
 
double m_tti
 Transmission time interval. More...
 
double m_txPower
 Transmission power in dBm. More...
 
uint16_t m_ulBandwidth
 The UL bandwidth in number of PRBs. More...
 
uint32_t m_ulEarfcn
 The uplink carrier frequency. More...
 
Ptr< LteSpectrumPhym_uplinkSpectrumPhy
 The uplink LteSpectrumPhy associated to this LtePhy. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. 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...
 

Detailed Description

The LtePhy models the physical layer of LTE.

Introspection did not find any typical Config paths.

It is composed by two LteSpectrumPhy, one for the downlink and one for the uplink.


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

Definition at line 52 of file lte-phy.h.

Constructor & Destructor Documentation

◆ LtePhy() [1/2]

ns3::LtePhy::LtePhy ( )
Warning
the default constructor should not be used

Definition at line 38 of file lte-phy.cc.

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ LtePhy() [2/2]

ns3::LtePhy::LtePhy ( Ptr< LteSpectrumPhy dlPhy,
Ptr< LteSpectrumPhy ulPhy 
)
Parameters
dlPhythe downlink LteSpectrumPhy instance
ulPhythe uplink LteSpectrumPhy instance

Definition at line 44 of file lte-phy.cc.

References NS_LOG_FUNCTION.

◆ ~LtePhy()

ns3::LtePhy::~LtePhy ( )
virtual

Definition at line 72 of file lte-phy.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CreateTxPowerSpectralDensity()

virtual Ptr<SpectrumValue> ns3::LtePhy::CreateTxPowerSpectralDensity ( )
pure virtual

Compute the TX Power Spectral Density.

Returns
a pointer to a newly allocated SpectrumValue representing the TX Power Spectral Density in W/Hz for each Resource Block

Implemented in ns3::LteTestUePhy, ns3::LteUePhy, and ns3::LteEnbPhy.

◆ DoDispose()

void ns3::LtePhy::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::LteUePhy, and ns3::LteTestUePhy.

Definition at line 78 of file lte-phy.cc.

References ns3::Object::DoDispose(), m_controlMessagesQueue, m_downlinkSpectrumPhy, m_netDevice, m_packetBurstQueue, m_uplinkSpectrumPhy, and NS_LOG_FUNCTION.

Referenced by ns3::LteTestUePhy::DoDispose(), ns3::LteEnbPhy::DoDispose(), and ns3::LteUePhy::DoDispose().

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

◆ DoSendMacPdu()

virtual void ns3::LtePhy::DoSendMacPdu ( Ptr< Packet p)
pure virtual

Queue the MAC PDU to be sent (according to m_macChTtiDelay)

Parameters
pthe MAC PDU to sent

Implemented in ns3::LteTestUePhy, ns3::LteUePhy, and ns3::LteEnbPhy.

◆ DoSetCellId()

void ns3::LtePhy::DoSetCellId ( uint16_t  cellId)
Parameters
cellIdthe Cell Identifier

Definition at line 248 of file lte-phy.cc.

References m_cellId, m_downlinkSpectrumPhy, and m_uplinkSpectrumPhy.

Referenced by ns3::EnbMemberLteEnbPhySapProvider::SetCellId().

+ Here is the caller graph for this function:

◆ GenerateCtrlCqiReport()

virtual void ns3::LtePhy::GenerateCtrlCqiReport ( const SpectrumValue sinr)
pure virtual

generate a CQI report based on the given SINR of Ctrl frame

Parameters
sinrthe SINR vs frequency measured by the device

Implemented in ns3::LteTestUePhy, ns3::LteUePhy, and ns3::LteEnbPhy.

◆ GenerateDataCqiReport()

virtual void ns3::LtePhy::GenerateDataCqiReport ( const SpectrumValue sinr)
pure virtual

generate a CQI report based on the given SINR of Data frame (used for PUSCH CQIs)

Parameters
sinrthe SINR vs frequency measured by the device

Implemented in ns3::LteTestUePhy, ns3::LteUePhy, and ns3::LteEnbPhy.

◆ GetComponentCarrierId()

uint8_t ns3::LtePhy::GetComponentCarrierId ( )

Get the component carrier ID.

Returns
the component carrier ID index

Definition at line 264 of file lte-phy.cc.

References m_componentCarrierId.

◆ GetControlMessages()

std::list< Ptr< LteControlMessage > > ns3::LtePhy::GetControlMessages ( void  )
Returns
the list of control messages to be sent

Definition at line 225 of file lte-phy.cc.

References m_controlMessagesQueue, and NS_LOG_FUNCTION.

Referenced by ns3::LteEnbPhy::StartSubFrame(), and ns3::LteUePhy::SubframeIndication().

+ Here is the caller graph for this function:

◆ GetDevice()

Ptr< LteNetDevice > ns3::LtePhy::GetDevice ( void  ) const

Get the device where the phy layer is attached.

Returns
the pointer to the device

Definition at line 100 of file lte-phy.cc.

References m_netDevice, and NS_LOG_FUNCTION.

Referenced by ns3::LteUePhy::GenerateCqiRsrpRsrq().

+ Here is the caller graph for this function:

◆ GetDownlinkSpectrumPhy()

Ptr< LteSpectrumPhy > ns3::LtePhy::GetDownlinkSpectrumPhy ( )
Returns
a pointer to the LteSpectrumPhy instance that manages the downlink

Definition at line 107 of file lte-phy.cc.

References m_downlinkSpectrumPhy.

◆ GetPacketBurst()

Ptr< PacketBurst > ns3::LtePhy::GetPacketBurst ( void  )
Returns
the packet burst to be sent

Definition at line 198 of file lte-phy.cc.

References m_packetBurstQueue.

Referenced by ns3::LteEnbPhy::StartSubFrame(), and ns3::LteUePhy::SubframeIndication().

+ Here is the caller graph for this function:

◆ GetRbgSize()

uint8_t ns3::LtePhy::GetRbgSize ( void  ) const
Returns
the RB group size according to the bandwidth

Definition at line 186 of file lte-phy.cc.

References m_rbgSize.

Referenced by ns3::LteUePhy::CreateDlCqiFeedbackMessage(), ns3::LteUePhy::GenerateMixedCqiReport(), ns3::LteUePhy::ReceiveLteControlMessageList(), and ns3::LteEnbPhy::StartSubFrame().

+ Here is the caller graph for this function:

◆ GetSrsPeriodicity()

uint16_t ns3::LtePhy::GetSrsPeriodicity ( uint16_t  srcCi) const
Returns
the SRS periodicity (see Table 8.2-1 of 36.213)
Parameters
srcCithe SRS Configuration Index

Definition at line 150 of file lte-phy.cc.

Referenced by ns3::LteEnbPhy::DoSetSrsConfigurationIndex(), and ns3::LteUePhy::DoSetSrsConfigurationIndex().

+ Here is the caller graph for this function:

◆ GetSrsSubframeOffset()

uint16_t ns3::LtePhy::GetSrsSubframeOffset ( uint16_t  srcCi) const
Returns
the SRS Subframe offset (see Table 8.2-1 of 36.213)
Parameters
srcCithe SRS Configuration Index

Definition at line 168 of file lte-phy.cc.

Referenced by ns3::LteEnbPhy::DoSetSrsConfigurationIndex(), and ns3::LteUePhy::DoSetSrsConfigurationIndex().

+ Here is the caller graph for this function:

◆ GetTti()

double ns3::LtePhy::GetTti ( void  ) const
Returns
transmission time interval

Definition at line 142 of file lte-phy.cc.

References m_tti, and NS_LOG_FUNCTION.

Referenced by ns3::LteEnbPhy::StartSubFrame(), and ns3::LteUePhy::SubframeIndication().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 62 of file lte-phy.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetUplinkSpectrumPhy()

Ptr< LteSpectrumPhy > ns3::LtePhy::GetUplinkSpectrumPhy ( )
Returns
a pointer to the LteSpectrumPhy instance that manages the uplink

Definition at line 113 of file lte-phy.cc.

References m_uplinkSpectrumPhy.

◆ ReportInterference()

virtual void ns3::LtePhy::ReportInterference ( const SpectrumValue interf)
pure virtual

generate a report based on the linear interference and noise power perceived during DATA frame NOTE: used only by eNB

Parameters
interfthe interference + noise power measured by the device

Implemented in ns3::LteTestUePhy, ns3::LteUePhy, and ns3::LteEnbPhy.

◆ ReportRsReceivedPower()

virtual void ns3::LtePhy::ReportRsReceivedPower ( const SpectrumValue power)
pure virtual

generate a report based on the linear RS power perceived during CTRL frame NOTE: used only by UE for evaluating RSRP

Parameters
powerthe RS power measured by the device

Implemented in ns3::LteTestUePhy, ns3::LteUePhy, and ns3::LteEnbPhy.

◆ SetComponentCarrierId()

void ns3::LtePhy::SetComponentCarrierId ( uint8_t  index)

Set the component carrier ID.

Parameters
indexthe component carrier ID index

Definition at line 256 of file lte-phy.cc.

References m_componentCarrierId, m_downlinkSpectrumPhy, and m_uplinkSpectrumPhy.

◆ SetControlMessages()

void ns3::LtePhy::SetControlMessages ( Ptr< LteControlMessage m)
Parameters
mthe control message to be sent

Definition at line 217 of file lte-phy.cc.

References m_controlMessagesQueue.

Referenced by ns3::LteEnbPhy::DoSendLteControlMessage(), ns3::LteUePhy::DoSendLteControlMessage(), and ns3::LteUePhy::EnqueueDlHarqFeedback().

+ Here is the caller graph for this function:

◆ SetDevice()

void ns3::LtePhy::SetDevice ( Ptr< LteNetDevice d)

Set the device where the phy layer is attached.

Parameters
dthe device

Definition at line 92 of file lte-phy.cc.

References m_netDevice, and NS_LOG_FUNCTION.

◆ SetDownlinkChannel()

void ns3::LtePhy::SetDownlinkChannel ( Ptr< SpectrumChannel c)

Set the downlink channel.

Parameters
cthe downlink channel

Definition at line 120 of file lte-phy.cc.

References m_downlinkSpectrumPhy, and NS_LOG_FUNCTION.

◆ SetMacPdu()

void ns3::LtePhy::SetMacPdu ( Ptr< Packet p)
Parameters
pqueue MAC PDU to be sent

Definition at line 192 of file lte-phy.cc.

References m_packetBurstQueue.

Referenced by ns3::LteEnbPhy::DoSendMacPdu(), and ns3::LteUePhy::DoSendMacPdu().

+ Here is the caller graph for this function:

◆ SetTti()

void ns3::LtePhy::SetTti ( double  tti)
Parameters
ttitransmission time interval

Definition at line 134 of file lte-phy.cc.

References m_tti, and NS_LOG_FUNCTION.

◆ SetUplinkChannel()

void ns3::LtePhy::SetUplinkChannel ( Ptr< SpectrumChannel c)

Set the uplink channel.

Parameters
cthe uplink channel

Definition at line 127 of file lte-phy.cc.

References m_uplinkSpectrumPhy, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_cellId

◆ m_componentCarrierId

◆ m_controlMessagesQueue

◆ m_dlBandwidth

◆ m_dlEarfcn

◆ m_downlinkSpectrumPhy

◆ m_macChTtiDelay

uint8_t ns3::LtePhy::m_macChTtiDelay
protected

Delay between MAC and channel layer in terms of TTIs.

It is the delay that occurs between a scheduling decision in the MAC and the actual start of the transmission by the PHY. This is intended to be used to model the latency of real PHY and MAC implementations.

In LteEnbPhy, it is 2 TTIs by default and can be configured through the MacToChannelDelay attribute. In LteUePhy, it is 4 TTIs.

Definition at line 301 of file lte-phy.h.

Referenced by ns3::LteUePhy::LteUePhy(), ns3::LteEnbPhy::DoGetMacChTtiDelay(), ns3::LteUePhy::DoReset(), ns3::LteEnbPhy::DoSetSrsConfigurationIndex(), ns3::LteEnbPhy::GetMacChDelay(), ns3::LteUePhy::GetMacChDelay(), ns3::LteUePhy::QueueSubChannelsForTransmission(), ns3::LteEnbPhy::SetMacChDelay(), and ns3::LteUePhy::SubframeIndication().

◆ m_netDevice

Ptr<LteNetDevice> ns3::LtePhy::m_netDevice
protected

Pointer to the NetDevice where this PHY layer is attached.

Definition at line 232 of file lte-phy.h.

Referenced by DoDispose(), ns3::LteEnbPhy::DoInitialize(), ns3::LteUePhy::DoInitialize(), GetDevice(), and SetDevice().

◆ m_noiseFigure

double ns3::LtePhy::m_noiseFigure
protected

Loss (dB) in the Signal-to-Noise-Ratio due to non-idealities in the receiver.

Also available as attribute NoiseFigure in the child classes LteEnbPhy and LteUePhy.

According to Wikipedia, this is "the difference in decibels (dB) between the noise output of the actual receiver to the noise output of an ideal receiver with the same overall gain and bandwidth when the receivers are connected to sources at the standard noise temperature T0." In this model, we consider T0 = 290K.

Definition at line 261 of file lte-phy.h.

Referenced by ns3::LteEnbPhy::DoInitialize(), ns3::LteUePhy::DoSetDlBandwidth(), ns3::LteEnbPhy::GetNoiseFigure(), ns3::LteUePhy::GetNoiseFigure(), ns3::LteUePhy::SetNoiseFigure(), and ns3::LteEnbPhy::SetNoiseFigure().

◆ m_packetBurstQueue

std::vector< Ptr<PacketBurst> > ns3::LtePhy::m_packetBurstQueue
protected

A queue of packet bursts to be sent.

Definition at line 289 of file lte-phy.h.

Referenced by DoDispose(), ns3::LteUePhy::DoReset(), GetPacketBurst(), ns3::LteEnbPhy::SetMacChDelay(), and SetMacPdu().

◆ m_rbgSize

uint8_t ns3::LtePhy::m_rbgSize
protected

The RB group size according to the bandwidth.

Definition at line 276 of file lte-phy.h.

Referenced by ns3::LteEnbPhy::DoSetBandwidth(), ns3::LteUePhy::DoSetDlBandwidth(), and GetRbgSize().

◆ m_tti

double ns3::LtePhy::m_tti
protected

Transmission time interval.

Definition at line 264 of file lte-phy.h.

Referenced by GetTti(), and SetTti().

◆ m_txPower

◆ m_ulBandwidth

uint16_t ns3::LtePhy::m_ulBandwidth
protected

The UL bandwidth in number of PRBs.

Specified by the upper layer through CPHY SAP.

Definition at line 269 of file lte-phy.h.

Referenced by ns3::LteUePhy::CreateTxPowerSpectralDensity(), ns3::LteUePhy::DoConfigureUplink(), ns3::LteEnbPhy::DoInitialize(), ns3::LteEnbPhy::DoSetBandwidth(), and ns3::LteUePhy::SendSrs().

◆ m_ulEarfcn

uint32_t ns3::LtePhy::m_ulEarfcn
protected

The uplink carrier frequency.

Specified by the upper layer through CPHY SAP.

Definition at line 286 of file lte-phy.h.

Referenced by ns3::LteUePhy::CreateTxPowerSpectralDensity(), ns3::LteUePhy::DoConfigureUplink(), ns3::LteEnbPhy::DoInitialize(), and ns3::LteEnbPhy::DoSetEarfcn().

◆ m_uplinkSpectrumPhy


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