ns-3
ns3::LtePhy Class Reference

#include <lte-phy.h>

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

List of all members.

Public Member Functions

void SetDevice (Ptr< LteNetDevice > d)
 Set the device where the phy layer is attached.
Ptr< LteNetDeviceGetDevice ()
 Get the device where the phy layer is attached.
virtual bool SendPacket (Ptr< PacketBurst > pb)=0
 Start a transmission. StartTx is called by the LTE device to start packet transmission.
void SetDownlinkSpectrumPhy (Ptr< LteSpectrumPhy > s)
void SetUplinkSpectrumPhy (Ptr< LteSpectrumPhy > s)
Ptr< LteSpectrumPhyGetDownlinkSpectrumPhy ()
Ptr< LteSpectrumPhyGetUplinkSpectrumPhy ()
void SetDownlinkChannel (Ptr< SpectrumChannel > c)
Ptr< SpectrumChannelGetDownlinkChannel ()
void SetUplinkChannel (Ptr< SpectrumChannel > c)
Ptr< SpectrumChannelGetUplinkChannel ()
void SetDownlinkSubChannels (std::vector< int > mask)
 set a list of sub channel to use in the downlink. A sub channel is composed by a couple of resource bloks (180KHz x 1 ms)
virtual void DoSetDownlinkSubChannels ()
 do some operation after the set of a list of DL sub channels
void SetUplinkSubChannels (std::vector< int > mask)
 set a list of sub channel to use in the uplink. A sub channel is composed by a couple of resource bloks (180KHz x 1 ms)
virtual void DoSetUplinkSubChannels ()
 do some operation after the set of a list of UL sub channels
std::vector< int > GetDownlinkSubChannels (void)
 get a list of sub channel to use in the downlink
std::vector< int > GetUplinkSubChannels (void)
 get a list of sub channel to use in the downlink
virtual Ptr< SpectrumValueCreateTxPowerSpectralDensity ()=0
 Compute the TX Power Spectral Density.
void SetTxPower (double pw)
 Set the power transmisison, expressed in dBm.
double GetTxPower (void)
 Get the power transmission, expressed in dBm.
void DoDispose ()
virtual void SendIdealControlMessage (Ptr< IdealControlMessage > msg)=0
 Send SendIdealControlMessage (PDCCH map, CQI feedbacks) using the ideal control channel.
virtual void ReceiveIdealControlMessage (Ptr< IdealControlMessage > msg)=0
 Receive SendIdealControlMessage (PDCCH map, CQI feedbacks) using the ideal control channel.
void SetTti (double tti)
double GetTti (void) const
void SetNrFrames (uint32_t nrFrames)
uint32_t GetNrFrames (void) const
void SetNrSubFrames (uint32_t nrSubFrames)
uint32_t GetNrSubFrames (void) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::LtePhy.

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.


Member Function Documentation

Compute the TX Power Spectral Density.

Returns:
a Ptr to a created SpectrumValue

Implemented in ns3::UeLtePhy, and ns3::EnbLtePhy.

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.

References NS_LOG_FUNCTION.

Get the device where the phy layer is attached.

Returns:
the pointer to the device

References NS_LOG_FUNCTION.

Referenced by ns3::UeLtePhy::CreateCqiFeedbacks(), ns3::EnbLtePhy::ReceiveIdealControlMessage(), ns3::UeLtePhy::ReceiveIdealControlMessage(), and ns3::EnbLtePhy::StartSubFrame().

Get the downlink channel

Returns:
a Ptr to the downlink SpectrumChannel

References ns3::LteSpectrumPhy::GetChannel(), and NS_LOG_FUNCTION.

std::vector< int > ns3::LtePhy::GetDownlinkSubChannels ( void  )

get a list of sub channel to use in the downlink

Returns:

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::CreateTxPowerSpectralDensity(), and ns3::JakesFadingLossModel::SetValue().

uint32_t ns3::LtePhy::GetNrFrames ( void  ) const
Returns:
the number of the current LTE frame.

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::StartFrame().

uint32_t ns3::LtePhy::GetNrSubFrames ( void  ) const
Returns:
the number of the current LTE sub-frame.

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::EndSubFrame(), and ns3::EnbLtePhy::StartSubFrame().

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

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::StartSubFrame().

double ns3::LtePhy::GetTxPower ( void  )

Get the power transmission, expressed in dBm.

Returns:
the power transmission

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::CreateTxPowerSpectralDensity(), and ns3::UeLtePhy::CreateTxPowerSpectralDensity().

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

This method returns the TypeId associated to ns3::LtePhy.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::LteNetDevice/Phy
  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::LtePhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/Phy
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::LteNetDevice/Phy
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::LtePhy

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::EnbLtePhy, and ns3::UeLtePhy.

References ns3::TypeId::SetParent().

Get the uplink channel

Returns:
a Ptr to the uplink SpectrumChannel

References ns3::LteSpectrumPhy::GetChannel(), and NS_LOG_FUNCTION.

std::vector< int > ns3::LtePhy::GetUplinkSubChannels ( void  )

get a list of sub channel to use in the downlink

Returns:

References NS_LOG_FUNCTION.

Referenced by ns3::UeLtePhy::DoSetUplinkSubChannels().

virtual void ns3::LtePhy::ReceiveIdealControlMessage ( Ptr< IdealControlMessage msg) [pure virtual]

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

Parameters:
msgthe Ideal Control Message to receive

Implemented in ns3::UeLtePhy, and ns3::EnbLtePhy.

Referenced by ns3::UeLtePhy::SendIdealControlMessage().

virtual void ns3::LtePhy::SendIdealControlMessage ( Ptr< IdealControlMessage msg) [pure virtual]

Send SendIdealControlMessage (PDCCH map, CQI feedbacks) using the ideal control channel.

Parameters:
msgthe Ideal Control Message to send

Implemented in ns3::UeLtePhy, and ns3::EnbLtePhy.

virtual bool ns3::LtePhy::SendPacket ( Ptr< PacketBurst pb) [pure virtual]

Start a transmission. StartTx is called by the LTE device to start packet transmission.

Parameters:
pbthe packet of packets to be transmitted
Returns:
true if an error occurred and the transmission was not started, false otherwise.

Implemented in ns3::UeLtePhy, and ns3::EnbLtePhy.

Referenced by ns3::EnbNetDevice::StartTransmission(), and ns3::UeNetDevice::StartTransmission().

Set the device where the phy layer is attached.

Parameters:
dthe device

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::EnbLtePhy(), ns3::LteHelper::Install(), and ns3::UeLtePhy::UeLtePhy().

Set the downlink channel

Parameters:
cthe downlink channel

References NS_LOG_FUNCTION, and ns3::LteSpectrumPhy::SetChannel().

Set the LTE SpectrumPhy for the downlink

Parameters:
sthe LTE SpectrumPhy

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::EnbLtePhy(), and ns3::UeLtePhy::UeLtePhy().

void ns3::LtePhy::SetDownlinkSubChannels ( std::vector< int >  mask)

set a list of sub channel to use in the downlink. A sub channel is composed by a couple of resource bloks (180KHz x 1 ms)

Parameters:
maska vector of intefer values. Each elements of this vector carries information about the corresponding DL sub channel. If the i-th value of mask is equal to 1 (0) it means that the corresponding sub channel is used (not used) for the downlink.

References DoSetDownlinkSubChannels(), and NS_LOG_FUNCTION.

void ns3::LtePhy::SetNrFrames ( uint32_t  nrFrames)
Parameters:
nrFramesthe number of the current LTE frame.

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::EnbLtePhy(), ns3::EnbLtePhy::StartFrame(), and ns3::UeLtePhy::UeLtePhy().

void ns3::LtePhy::SetNrSubFrames ( uint32_t  nrSubFrames)
Parameters:
nrSubFramesthe number of the current LTE sub-frame.

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::EnbLtePhy(), ns3::EnbLtePhy::StartFrame(), ns3::EnbLtePhy::StartSubFrame(), and ns3::UeLtePhy::UeLtePhy().

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

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::EnbLtePhy(), and ns3::UeLtePhy::UeLtePhy().

void ns3::LtePhy::SetTxPower ( double  pw)

Set the power transmisison, expressed in dBm.

Parameters:
pwthe power transmission

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::EnbLtePhy(), and ns3::UeLtePhy::UeLtePhy().

Set the uplink channel

Parameters:
cthe uplink channel

References NS_LOG_FUNCTION, and ns3::LteSpectrumPhy::SetChannel().

Set the LTE SpectrumPhy for the uplink

Parameters:
sthe LTE SpectrumPhy

References NS_LOG_FUNCTION.

Referenced by ns3::EnbLtePhy::EnbLtePhy(), and ns3::UeLtePhy::UeLtePhy().

void ns3::LtePhy::SetUplinkSubChannels ( std::vector< int >  mask)

set a list of sub channel to use in the uplink. A sub channel is composed by a couple of resource bloks (180KHz x 1 ms)

Parameters:
maska vector of intefer values. Each elements of this vector carries information about the corresponding UL sub channel. If the i-th value of mask is equal to 1 (0) it means that the corresponding sub channel is used (not used) for the uplink.

References DoSetUplinkSubChannels(), and NS_LOG_FUNCTION.


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