A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::LtePhy Class Referenceabstract

#include <lte-phy.h>

+ Inheritance diagram for ns3::LtePhy:

Public Member Functions

 LtePhy ()
 
 LtePhy (Ptr< LteSpectrumPhy > dlPhy, Ptr< LteSpectrumPhy > ulPhy)
 
virtual Ptr< SpectrumValueCreateTxPowerSpectralDensity ()=0
 Compute the TX Power Spectral Density. More...
 
void DoDispose ()
 
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
 
virtual void GenerateDataCqiReport (const SpectrumValue &sinr)=0
 
std::list< Ptr
< LteControlMessage > > 
GetControlMessages (void)
 
Ptr< LteNetDeviceGetDevice ()
 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 &power)=0
 
virtual void ReportRsReceivedPower (const SpectrumValue &interf)=0
 
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)
 
void SetMacPdu (Ptr< Packet > p)
 
void SetTti (double tti)
 Receive SendLteControlMessage (PDCCH map, CQI feedbacks) using the ideal control channel. More...
 
void SetUplinkChannel (Ptr< SpectrumChannel > c)
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Protected Attributes

uint16_t m_cellId
 
std::vector< std::list< Ptr
< LteControlMessage > > > 
m_controlMessagesQueue
 
uint8_t m_dlBandwidth
 
uint16_t m_dlEarfcn
 
Ptr< LteSpectrumPhym_downlinkSpectrumPhy
 
uint8_t m_macChTtiDelay
 
Ptr< LteNetDevicem_netDevice
 
double m_noiseFigure
 
std::vector< Ptr< PacketBurst > > m_packetBurstQueue
 
uint8_t m_rbgSize
 
double m_tti
 
double m_txPower
 
uint8_t m_ulBandwidth
 
uint16_t m_ulEarfcn
 
Ptr< LteSpectrumPhym_uplinkSpectrumPhy
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

The LtePhy models the physical layer of LTE. It is composed by two LteSpectrumPhy, one for the downlink and one for the uplink.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

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

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

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

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

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

void ns3::LtePhy::DoDispose ( void  )
virtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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 75 of file lte-phy.cc.

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

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

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

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

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

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

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

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

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

References NS_LOG_FUNCTION.

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

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

Get the device where the phy layer is attached.

Returns
the pointer to the device

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

References NS_LOG_FUNCTION.

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

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

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

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

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

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

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

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

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

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 147 of file lte-phy.cc.

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 165 of file lte-phy.cc.

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

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

References NS_LOG_FUNCTION.

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

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

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

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

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

Parameters
sinrthe interference + noise power measured by the device

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

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

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

Parameters
sinrthe RS power measured by the device

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

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

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

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

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

Set the device where the phy layer is attached.

Parameters
dthe device

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

References NS_LOG_FUNCTION.

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

Set the downlink channel

Parameters
cthe downlink channel

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

References NS_LOG_FUNCTION.

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

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

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

void ns3::LtePhy::SetTti ( double  tti)

Receive SendLteControlMessage (PDCCH map, CQI feedbacks) using the ideal control channel.

Parameters
msgthe Ideal Control Message to receive
ttitransmission time interval

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

References NS_LOG_FUNCTION.

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

Set the uplink channel

Parameters
cthe uplink channel

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

References NS_LOG_FUNCTION.


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