A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::LteSpectrumPhy Class Reference

#include <lte-spectrum-phy.h>

+ Inheritance diagram for ns3::LteSpectrumPhy:
+ Collaboration diagram for ns3::LteSpectrumPhy:

Public Types

enum  State { IDLE, TX, RX_DATA, RX_CTRL }

Public Member Functions

 LteSpectrumPhy ()
virtual ~LteSpectrumPhy ()
void AddCtrlSinrChunkProcessor (Ptr< LteSinrChunkProcessor > p)
void AddDataSinrChunkProcessor (Ptr< LteSinrChunkProcessor > p)
void AddExpectedTb (uint16_t rnti, uint8_t ndi, uint16_t size, uint8_t mcs, std::vector< int > map, uint8_t layer, uint8_t harqId, uint8_t rv, bool downlink)
void AddInterferenceChunkProcessor (Ptr< LteSinrChunkProcessor > p)
void AddRsPowerChunkProcessor (Ptr< LteSinrChunkProcessor > p)
int64_t AssignStreams (int64_t stream)
virtual void DoDispose ()
Ptr< SpectrumChannelGetChannel ()
Ptr< NetDeviceGetDevice ()
Ptr< MobilityModelGetMobility ()
Ptr< AntennaModelGetRxAntenna ()
Ptr< const SpectrumModelGetRxSpectrumModel () const
void Reset ()
void SetAntenna (Ptr< AntennaModel > a)
void SetCellId (uint16_t cellId)
void SetChannel (Ptr< SpectrumChannel > c)
void SetDevice (Ptr< NetDevice > d)
void SetHarqPhyModule (Ptr< LteHarqPhy > harq)
void SetLtePhyDlHarqFeedbackCallback (LtePhyDlHarqFeedbackCallback c)
void SetLtePhyRxCtrlEndErrorCallback (LtePhyRxCtrlEndErrorCallback c)
void SetLtePhyRxCtrlEndOkCallback (LtePhyRxCtrlEndOkCallback c)
void SetLtePhyRxDataEndErrorCallback (LtePhyRxDataEndErrorCallback c)
void SetLtePhyRxDataEndOkCallback (LtePhyRxDataEndOkCallback c)
void SetLtePhyTxEndCallback (LtePhyTxEndCallback c)
void SetLtePhyUlHarqFeedbackCallback (LtePhyUlHarqFeedbackCallback c)
void SetMobility (Ptr< MobilityModel > m)
void SetNoisePowerSpectralDensity (Ptr< const SpectrumValue > noisePsd)
 set the noise power spectral density
void SetState (State newState)
 Set the state of the phy layer.
void SetTransmissionMode (uint8_t txMode)
void SetTxPowerSpectralDensity (Ptr< SpectrumValue > txPsd)
void StartRx (Ptr< SpectrumSignalParameters > params)
void StartRxCtrl (Ptr< SpectrumSignalParameters > params)
void StartRxData (Ptr< LteSpectrumSignalParametersDataFrame > params)
bool StartTxDataFrame (Ptr< PacketBurst > pb, std::list< Ptr< LteControlMessage > > ctrlMsgList, Time duration)
bool StartTxDlCtrlFrame (std::list< Ptr< LteControlMessage > > ctrlMsgList)
bool StartTxUlSrsFrame ()
void UpdateSinrPerceived (const SpectrumValue &sinr)
- Public Member Functions inherited from ns3::SpectrumPhy
 SpectrumPhy ()
virtual ~SpectrumPhy ()
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~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 ()
 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
virtual ~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)

Private Member Functions

void ChangeState (State newState)
void EndRxData ()
void EndRxDlCtrl ()
void EndRxUlSrs ()
void EndTx ()
void SetTxModeGain (uint8_t txMode, double gain)

Private Attributes

Ptr< AntennaModelm_antenna
uint16_t m_cellId
Ptr< SpectrumChannelm_channel
bool m_ctrlErrorModelEnabled
bool m_dataErrorModelEnabled
Ptr< NetDevicem_device
TracedCallback
< PhyReceptionStatParameters
m_dlPhyReception
EventId m_endRxDataEvent
EventId m_endRxDlCtrlEvent
EventId m_endRxUlSrsEvent
EventId m_endTxEvent
expectedTbs_t m_expectedTbs
Time m_firstRxDuration
Time m_firstRxStart
Ptr< LteHarqPhym_harqPhyModule
Ptr< LteInterferencem_interferenceCtrl
Ptr< LteInterferencem_interferenceData
uint8_t m_layersNum
LtePhyDlHarqFeedbackCallback m_ltePhyDlHarqFeedbackCallback
LtePhyRxCtrlEndErrorCallback m_ltePhyRxCtrlEndErrorCallback
LtePhyRxCtrlEndOkCallback m_ltePhyRxCtrlEndOkCallback
LtePhyRxDataEndErrorCallback m_ltePhyRxDataEndErrorCallback
LtePhyRxDataEndOkCallback m_ltePhyRxDataEndOkCallback
LtePhyTxEndCallback m_ltePhyTxEndCallback
LtePhyUlHarqFeedbackCallback m_ltePhyUlHarqFeedbackCallback
Ptr< MobilityModelm_mobility
TracedCallback< Ptr< const
Packet > > 
m_phyRxEndErrorTrace
TracedCallback< Ptr< const
Packet > > 
m_phyRxEndOkTrace
TracedCallback< Ptr< const
PacketBurst > > 
m_phyRxStartTrace
TracedCallback< Ptr< const
PacketBurst > > 
m_phyTxEndTrace
TracedCallback< Ptr< const
PacketBurst > > 
m_phyTxStartTrace
Ptr< UniformRandomVariablem_random
 Provides uniform random variables.
std::list< Ptr
< LteControlMessage > > 
m_rxControlMessageList
std::list< Ptr< PacketBurst > > m_rxPacketBurstList
Ptr< const SpectrumModelm_rxSpectrumModel
SpectrumValue m_sinrPerceived
State m_state
uint8_t m_transmissionMode
std::list< Ptr
< LteControlMessage > > 
m_txControlMessageList
std::vector< double > m_txModeGain
Ptr< PacketBurstm_txPacketBurst
Ptr< SpectrumValuem_txPsd
TracedCallback
< PhyReceptionStatParameters
m_ulPhyReception

Friends

class LteUePhy

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoInitialize (void)
virtual void NotifyNewAggregate (void)

Detailed Description

The LteSpectrumPhy models the physical layer of LTE

It supports a single antenna model instance which is used for both transmission and reception.

Config Paths

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

  • /NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbPhy/DlSpectrumPhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteEnbPhy/UlSpectrumPhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbPhy/DlSpectrumPhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteEnbPhy/UlSpectrumPhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteUeNetDevice/LteUePhy/DlSpectrumPhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteUeNetDevice/LteUePhy/UlSpectrumPhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUePhy/DlSpectrumPhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::LteUeNetDevice/LteUePhy/UlSpectrumPhy

Attributes

  • DataErrorModelEnabled: Activate/Deactivate the error model of data (TBs of PDSCH and PUSCH) [by default is active].
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read
  • CtrlErrorModelEnabled: Activate/Deactivate the error model of control (PCFICH-PDCCH decodification) [by default is active].
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

TraceSources

  • TxStart: Trace fired when a new transmission is started
  • TxEnd: Trace fired when a previosuly started transmission is finished
  • RxStart: Trace fired when the start of a signal is detected
  • RxEndOk: Trace fired when a previosuly started RX terminates successfully
  • RxEndError: Trace fired when a previosuly started RX terminates with an error
  • DlPhyReception: DL reception PHY layer statistics.
  • UlPhyReception: DL reception PHY layer statistics.

Definition at line 146 of file lte-spectrum-phy.h.

Member Enumeration Documentation

PHY states

Enumerator:
IDLE 
TX 
RX_DATA 
RX_CTRL 

Definition at line 156 of file lte-spectrum-phy.h.

Constructor & Destructor Documentation

ns3::LteSpectrumPhy::LteSpectrumPhy ( )

Definition at line 115 of file lte-spectrum-phy.cc.

References m_interferenceCtrl, m_interferenceData, m_random, m_txModeGain, NS_LOG_FUNCTION, and ns3::ObjectBase::SetAttribute().

+ Here is the call graph for this function:

ns3::LteSpectrumPhy::~LteSpectrumPhy ( )
virtual

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

References m_expectedTbs, m_txModeGain, and NS_LOG_FUNCTION.

Member Function Documentation

void ns3::LteSpectrumPhy::AddCtrlSinrChunkProcessor ( Ptr< LteSinrChunkProcessor p)
Parameters
pthe new LteSinrChunkProcessor to be added to the ctrl processing chain

Definition at line 1114 of file lte-spectrum-phy.cc.

References ns3::LteInterference::AddSinrChunkProcessor(), and m_interferenceCtrl.

Referenced by ns3::LteLinkAdaptationTestCase::DoRun().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::AddDataSinrChunkProcessor ( Ptr< LteSinrChunkProcessor p)
Parameters
pthe new LteSinrChunkProcessor to be added to the data processing chain

Definition at line 1102 of file lte-spectrum-phy.cc.

References ns3::LteInterference::AddSinrChunkProcessor(), and m_interferenceData.

Referenced by ns3::LteInterferenceTestCase::DoRun(), and ns3::LteEnbAntennaTestCase::DoRun().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::AddExpectedTb ( uint16_t  rnti,
uint8_t  ndi,
uint16_t  size,
uint8_t  mcs,
std::vector< int >  map,
uint8_t  layer,
uint8_t  harqId,
uint8_t  rv,
bool  downlink 
)
Parameters
rntithe rnti of the source of the TB
ndinew data indicator flag
sizethe size of the TB
mcsthe MCS of the TB
mapthe map of RB(s) used
layerthe layer (in case of MIMO tx)
harqIdthe id of the HARQ process (valid only for DL)
downlinktrue when the TB is for DL

Definition at line 812 of file lte-spectrum-phy.cc.

References m_expectedTbs, ns3::TbId_t::m_layer, ns3::TbId_t::m_rnti, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::AddInterferenceChunkProcessor ( Ptr< LteSinrChunkProcessor p)

LteSinrChunkProcessor devoted to evaluate intefrerence + noise power in data frame

Parameters
pthe new LteSinrChunkProcessor to be added to the data processing chain

Definition at line 1108 of file lte-spectrum-phy.cc.

References ns3::LteInterference::AddInterferenceChunkProcessor(), and m_interferenceData.

+ Here is the call graph for this function:

void ns3::LteSpectrumPhy::AddRsPowerChunkProcessor ( Ptr< LteSinrChunkProcessor p)
Parameters
pthe new LteSinrChunkProcessor to be added to the RS power chain

Definition at line 1095 of file lte-spectrum-phy.cc.

References ns3::LteInterference::AddRsPowerChunkProcessor(), and m_interferenceCtrl.

+ Here is the call graph for this function:

int64_t ns3::LteSpectrumPhy::AssignStreams ( int64_t  stream)

Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Definition at line 1156 of file lte-spectrum-phy.cc.

References m_random, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

Referenced by ns3::LteHelper::AssignStreams().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::ChangeState ( State  newState)
private

Definition at line 393 of file lte-spectrum-phy.cc.

References m_state, and NS_LOG_LOGIC.

Referenced by EndRxData(), EndRxDlCtrl(), EndRxUlSrs(), EndTx(), SetState(), StartRxCtrl(), StartRxData(), StartTxDataFrame(), StartTxDlCtrlFrame(), and StartTxUlSrsFrame().

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::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.

Definition at line 141 of file lte-spectrum-phy.cc.

References ns3::Object::Dispose(), m_channel, m_device, m_interferenceCtrl, m_interferenceData, m_ltePhyDlHarqFeedbackCallback, m_ltePhyRxCtrlEndErrorCallback, m_ltePhyRxCtrlEndOkCallback, m_ltePhyRxDataEndErrorCallback, m_ltePhyRxDataEndOkCallback, m_ltePhyTxEndCallback, m_ltePhyUlHarqFeedbackCallback, m_mobility, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::LteSpectrumPhy::EndRxData ( )
private

Definition at line 832 of file lte-spectrum-phy.cc.

References ns3::DlInfoListElement_s::ACK, ChangeState(), ns3::EffectiveCodingRate, ns3::LteInterference::EndRx(), ns3::LteHarqPhy::GetHarqProcessInfoDl(), ns3::LteHarqPhy::GetHarqProcessInfoUl(), ns3::LteRadioBearerTag::GetLayer(), ns3::Time::GetMilliSeconds(), ns3::LteRadioBearerTag::GetRnti(), ns3::LteMiErrorModel::GetTbDecodificationStats(), ns3::UniformRandomVariable::GetValue(), IDLE, ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), list, ns3::PhyReceptionStatParameters::m_cellId, m_cellId, ns3::PhyReceptionStatParameters::m_correctness, m_dataErrorModelEnabled, m_dlPhyReception, m_expectedTbs, m_harqPhyModule, ns3::DlInfoListElement_s::m_harqProcessId, ns3::DlInfoListElement_s::m_harqStatus, ns3::PhyReceptionStatParameters::m_imsi, m_interferenceData, ns3::TbId_t::m_layer, ns3::PhyReceptionStatParameters::m_layer, m_layersNum, m_ltePhyDlHarqFeedbackCallback, m_ltePhyRxCtrlEndOkCallback, m_ltePhyRxDataEndOkCallback, m_ltePhyUlHarqFeedbackCallback, ns3::PhyReceptionStatParameters::m_mcs, ns3::PhyReceptionStatParameters::m_ndi, m_phyRxEndErrorTrace, m_phyRxEndOkTrace, m_random, ns3::UlInfoListElement_s::m_receptionStatus, ns3::TbId_t::m_rnti, ns3::PhyReceptionStatParameters::m_rnti, ns3::UlInfoListElement_s::m_rnti, ns3::DlInfoListElement_s::m_rnti, ns3::PhyReceptionStatParameters::m_rv, m_rxControlMessageList, m_rxPacketBurstList, m_sinrPerceived, ns3::PhyReceptionStatParameters::m_size, m_state, ns3::PhyReceptionStatParameters::m_timestamp, ns3::UlInfoListElement_s::m_tpc, m_transmissionMode, ns3::PhyReceptionStatParameters::m_txMode, m_txModeGain, m_ulPhyReception, ns3::TbStats_t::mi, ns3::DlInfoListElement_s::NACK, ns3::UlInfoListElement_s::NotOk, ns3::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::UlInfoListElement_s::Ok, ns3::LteHarqPhy::ResetDlHarqProcessStatus(), ns3::LteHarqPhy::ResetUlHarqProcessStatus(), RX_DATA, ns3::TbStats_t::tbler, ns3::LteHarqPhy::UpdateDlHarqProcessStatus(), and ns3::LteHarqPhy::UpdateUlHarqProcessStatus().

Referenced by StartRxData().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::EndRxUlSrs ( )
private

Definition at line 1079 of file lte-spectrum-phy.cc.

References ChangeState(), ns3::LteInterference::EndRx(), IDLE, m_interferenceCtrl, m_state, NS_ASSERT, and RX_CTRL.

Referenced by StartRxCtrl().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::EndTx ( )
private
Ptr< SpectrumChannel > ns3::LteSpectrumPhy::GetChannel ( void  )
Returns
the previously set channel

Definition at line 266 of file lte-spectrum-phy.cc.

References m_channel.

Referenced by ns3::LteUePhy::DoSetDlBandwidth(), and ns3::LteUePhy::DoSyncronizeWithEnb().

+ Here is the caller graph for this function:

Ptr< NetDevice > ns3::LteSpectrumPhy::GetDevice ( )
virtual

get the associated NetDevice instance

Returns
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 227 of file lte-spectrum-phy.cc.

References m_device, and NS_LOG_FUNCTION.

Ptr< MobilityModel > ns3::LteSpectrumPhy::GetMobility ( )
virtual

get the associated MobilityModel instance

Returns
a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

Definition at line 235 of file lte-spectrum-phy.cc.

References m_mobility, and NS_LOG_FUNCTION.

Ptr< AntennaModel > ns3::LteSpectrumPhy::GetRxAntenna ( )
virtual

get the AntennaModel used by the NetDevice for reception

Returns
a Ptr to the AntennaModel used by the NetDevice for reception

Implements ns3::SpectrumPhy.

Definition at line 373 of file lte-spectrum-phy.cc.

References m_antenna.

Ptr< const SpectrumModel > ns3::LteSpectrumPhy::GetRxSpectrumModel ( ) const
virtual
Returns
returns the SpectrumModel that this SpectrumPhy expects to be used for all SpectrumValues that are passed to StartRx. If 0 is returned, it means that any model will be accepted.

Implements ns3::SpectrumPhy.

Definition at line 272 of file lte-spectrum-phy.cc.

References m_rxSpectrumModel.

TypeId ns3::LteSpectrumPhy::GetTypeId ( void  )
static
void ns3::LteSpectrumPhy::Reset ( void  )

reset the internal state

Definition at line 299 of file lte-spectrum-phy.cc.

References ns3::EventId::Cancel(), IDLE, m_cellId, m_endRxDataEvent, m_endRxDlCtrlEvent, m_endRxUlSrsEvent, m_endTxEvent, m_expectedTbs, m_layersNum, m_rxControlMessageList, m_rxPacketBurstList, m_rxSpectrumModel, m_state, m_transmissionMode, m_txControlMessageList, m_txPacketBurst, and NS_LOG_FUNCTION.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::SetAntenna ( Ptr< AntennaModel a)

set the AntennaModel to be used

Parameters
athe Antenna Model

Definition at line 379 of file lte-spectrum-phy.cc.

References m_antenna, and NS_LOG_FUNCTION.

void ns3::LteSpectrumPhy::SetCellId ( uint16_t  cellId)
Parameters
cellIdthe Cell Identifier

Definition at line 1088 of file lte-spectrum-phy.cc.

References m_cellId.

Referenced by ns3::LtePhy::DoSetCellId(), and ns3::LteUePhy::DoSyncronizeWithEnb().

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::SetChannel ( Ptr< SpectrumChannel c)
virtual

Set the channel attached to this device.

Parameters
cthe channel

Implements ns3::SpectrumPhy.

Definition at line 259 of file lte-spectrum-phy.cc.

References m_channel, and NS_LOG_FUNCTION.

Referenced by ns3::LtePhy::SetDownlinkChannel(), and ns3::LtePhy::SetUplinkChannel().

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::SetDevice ( Ptr< NetDevice d)
virtual

set the associated NetDevice instance

Parameters
dthe NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 243 of file lte-spectrum-phy.cc.

References m_device, and NS_LOG_FUNCTION.

void ns3::LteSpectrumPhy::SetHarqPhyModule ( Ptr< LteHarqPhy harq)

Definition at line 401 of file lte-spectrum-phy.cc.

References m_harqPhyModule.

Referenced by ns3::LteEnbPhy::LteEnbPhy().

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::SetLtePhyDlHarqFeedbackCallback ( LtePhyDlHarqFeedbackCallback  c)

set the callback for the DL HARQ feedback as part of the interconnections betweenthe LteSpectrumPhy and the PHY

Parameters
cthe callback

Definition at line 358 of file lte-spectrum-phy.cc.

References m_ltePhyDlHarqFeedbackCallback, and NS_LOG_FUNCTION.

void ns3::LteSpectrumPhy::SetLtePhyRxCtrlEndErrorCallback ( LtePhyRxCtrlEndErrorCallback  c)

set the callback for the erroneous end of a RX ctrl frame, as part of the interconnections betweenthe LteSpectrumPhy and the PHY

Parameters
cthe callback

Definition at line 351 of file lte-spectrum-phy.cc.

References m_ltePhyRxCtrlEndErrorCallback, and NS_LOG_FUNCTION.

void ns3::LteSpectrumPhy::SetLtePhyRxCtrlEndOkCallback ( LtePhyRxCtrlEndOkCallback  c)

set the callback for the successful end of a RX ctrl frame, as part of the interconnections betweenthe LteSpectrumPhy and the PHY

Parameters
cthe callback

Definition at line 344 of file lte-spectrum-phy.cc.

References m_ltePhyRxCtrlEndOkCallback, and NS_LOG_FUNCTION.

void ns3::LteSpectrumPhy::SetLtePhyRxDataEndErrorCallback ( LtePhyRxDataEndErrorCallback  c)

set the callback for the end of a RX in error, as part of the interconnections betweenthe PHY and the MAC

Parameters
cthe callback

Definition at line 329 of file lte-spectrum-phy.cc.

References m_ltePhyRxDataEndErrorCallback, and NS_LOG_FUNCTION.

void ns3::LteSpectrumPhy::SetLtePhyRxDataEndOkCallback ( LtePhyRxDataEndOkCallback  c)

set the callback for the successful end of a RX, as part of the interconnections betweenthe PHY and the MAC

Parameters
cthe callback

Definition at line 337 of file lte-spectrum-phy.cc.

References m_ltePhyRxDataEndOkCallback, and NS_LOG_FUNCTION.

void ns3::LteSpectrumPhy::SetLtePhyTxEndCallback ( LtePhyTxEndCallback  c)

set the callback for the end of a TX, as part of the interconnections betweenthe PHY and the MAC

Parameters
cthe callback

Definition at line 321 of file lte-spectrum-phy.cc.

References m_ltePhyTxEndCallback, and NS_LOG_FUNCTION.

void ns3::LteSpectrumPhy::SetLtePhyUlHarqFeedbackCallback ( LtePhyUlHarqFeedbackCallback  c)

set the callback for the UL HARQ feedback as part of the interconnections betweenthe LteSpectrumPhy and the PHY

Parameters
cthe callback

Definition at line 365 of file lte-spectrum-phy.cc.

References m_ltePhyUlHarqFeedbackCallback, and NS_LOG_FUNCTION.

void ns3::LteSpectrumPhy::SetMobility ( Ptr< MobilityModel m)
virtual

Set the mobility model associated with this device.

Parameters
mthe mobility model

Implements ns3::SpectrumPhy.

Definition at line 251 of file lte-spectrum-phy.cc.

References m_mobility, and NS_LOG_FUNCTION.

void ns3::LteSpectrumPhy::SetNoisePowerSpectralDensity ( Ptr< const SpectrumValue noisePsd)

set the noise power spectral density

Parameters
noisePsdthe Noise Power Spectral Density in power units (Watt, Pascal...) per Hz.

Definition at line 288 of file lte-spectrum-phy.cc.

References ns3::SpectrumValue::GetSpectrumModel(), m_interferenceCtrl, m_interferenceData, m_rxSpectrumModel, NS_ASSERT, NS_LOG_FUNCTION, and ns3::LteInterference::SetNoisePowerSpectralDensity().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::SetState ( State  newState)

Set the state of the phy layer.

Parameters
newStatethe state

Definition at line 386 of file lte-spectrum-phy.cc.

References ChangeState().

+ Here is the call graph for this function:

void ns3::LteSpectrumPhy::SetTransmissionMode ( uint8_t  txMode)
Parameters
txModeUE transmission mode (SISO, MIMO tx diversity, ...)

Definition at line 1120 of file lte-spectrum-phy.cc.

References m_layersNum, m_transmissionMode, m_txModeGain, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::TransmissionModesLayers::TxMode2LayerNum().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::SetTxModeGain ( uint8_t  txMode,
double  gain 
)
private

Definition at line 1130 of file lte-spectrum-phy.cc.

References m_txModeGain, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::SetTxPowerSpectralDensity ( Ptr< SpectrumValue txPsd)

set the Power Spectral Density of outgoing signals in W/Hz.

Parameters
txPsd

Definition at line 279 of file lte-spectrum-phy.cc.

References m_txPsd, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::LteEnbPhy::SetDownlinkSubChannels(), and ns3::LteUePhy::SetSubChannelsForTransmission().

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::StartRx ( Ptr< SpectrumSignalParameters params)
virtual

Notify the SpectrumPhy instance of an incoming signal

Parameters
paramsthe parameters of the signals being received

Implements ns3::SpectrumPhy.

Definition at line 603 of file lte-spectrum-phy.cc.

References ns3::LteInterference::AddSignal(), m_interferenceCtrl, m_interferenceData, m_state, NS_LOG_FUNCTION, NS_LOG_LOGIC, StartRxCtrl(), and StartRxData().

Referenced by ns3::LteDownlinkDataSinrTestCase::DoRun(), ns3::LteUplinkDataSinrTestCase::DoRun(), ns3::LteDownlinkCtrlSinrTestCase::DoRun(), and ns3::LteUplinkSrsSinrTestCase::DoRun().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::LteSpectrumPhy::StartTxDataFrame ( Ptr< PacketBurst pb,
std::list< Ptr< LteControlMessage > >  ctrlMsgList,
Time  duration 
)

Start a transmission of data frame in DL and UL

Parameters
pbthe burst of packets to be transmitted in PDSCH/PUSCH
ctrlMsgListthe list of LteControlMessage to send
durationthe duration of the data frame
Returns
true if an error occurred and the transmission was not started, false otherwise.

Definition at line 410 of file lte-spectrum-phy.cc.

References ChangeState(), EndTx(), IDLE, m_antenna, m_cellId, m_channel, m_endTxEvent, m_phyTxStartTrace, m_state, m_txPacketBurst, m_txPsd, NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, RX_CTRL, RX_DATA, ns3::Simulator::Schedule(), ns3::SpectrumChannel::StartTx(), and TX.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::LteSpectrumPhy::StartTxDlCtrlFrame ( std::list< Ptr< LteControlMessage > >  ctrlMsgList)

Start a transmission of control frame in DL

Parameters
dlDcithe burst of DL-DCIs to be transmitted
ulDcithe burst of UL-DCIs to be transmitted
Returns
true if an error occurred and the transmission was not started, false otherwise.

Definition at line 466 of file lte-spectrum-phy.cc.

References ChangeState(), ns3::DL_CTRL_DURATION, EndTx(), IDLE, m_antenna, m_cellId, m_channel, m_endTxEvent, m_state, m_txPsd, NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, RX_CTRL, RX_DATA, ns3::Simulator::Schedule(), ns3::SpectrumChannel::StartTx(), and TX.

Referenced by ns3::LteEnbPhy::SendControlChannels().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::LteSpectrumPhy::StartTxUlSrsFrame ( )

Start a transmission of control frame in UL

Parameters
pbthe burst of control messages to be transmitted
Returns
true if an error occurred and the transmission was not started, false otherwise.

Definition at line 522 of file lte-spectrum-phy.cc.

References ChangeState(), EndTx(), IDLE, m_antenna, m_cellId, m_channel, m_endTxEvent, m_state, m_txPsd, NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, RX_CTRL, RX_DATA, ns3::Simulator::Schedule(), ns3::SpectrumChannel::StartTx(), TX, and ns3::UL_SRS_DURATION.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteSpectrumPhy::UpdateSinrPerceived ( const SpectrumValue sinr)
Parameters
sinrvector of sinr perceived per each RB

Definition at line 804 of file lte-spectrum-phy.cc.

References m_sinrPerceived, and NS_LOG_FUNCTION.

Referenced by ns3::LteCtrlSinrChunkProcessor::End(), and ns3::LteDataSinrChunkProcessor::End().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

friend class LteUePhy
friend

Definition at line 381 of file lte-spectrum-phy.h.

Member Data Documentation

Ptr<AntennaModel> ns3::LteSpectrumPhy::m_antenna
private
uint16_t ns3::LteSpectrumPhy::m_cellId
private
Ptr<SpectrumChannel> ns3::LteSpectrumPhy::m_channel
private
bool ns3::LteSpectrumPhy::m_ctrlErrorModelEnabled
private

Definition at line 446 of file lte-spectrum-phy.h.

Referenced by EndRxDlCtrl(), and GetTypeId().

bool ns3::LteSpectrumPhy::m_dataErrorModelEnabled
private

Definition at line 445 of file lte-spectrum-phy.h.

Referenced by EndRxData(), and GetTypeId().

Ptr<NetDevice> ns3::LteSpectrumPhy::m_device
private

Definition at line 405 of file lte-spectrum-phy.h.

Referenced by DoDispose(), GetDevice(), and SetDevice().

TracedCallback<PhyReceptionStatParameters> ns3::LteSpectrumPhy::m_dlPhyReception
private

Trace information regarding PHY stats from DL Rx perspective PhyReceptionStatParameters (see lte-common.h)

Definition at line 461 of file lte-spectrum-phy.h.

Referenced by EndRxData(), and GetTypeId().

EventId ns3::LteSpectrumPhy::m_endRxDataEvent
private

Definition at line 471 of file lte-spectrum-phy.h.

Referenced by Reset(), and StartRxData().

EventId ns3::LteSpectrumPhy::m_endRxDlCtrlEvent
private

Definition at line 472 of file lte-spectrum-phy.h.

Referenced by Reset(), and StartRxCtrl().

EventId ns3::LteSpectrumPhy::m_endRxUlSrsEvent
private

Definition at line 473 of file lte-spectrum-phy.h.

Referenced by Reset(), and StartRxCtrl().

EventId ns3::LteSpectrumPhy::m_endTxEvent
private

Definition at line 470 of file lte-spectrum-phy.h.

Referenced by Reset(), StartTxDataFrame(), StartTxDlCtrlFrame(), and StartTxUlSrsFrame().

expectedTbs_t ns3::LteSpectrumPhy::m_expectedTbs
private

Definition at line 440 of file lte-spectrum-phy.h.

Referenced by AddExpectedTb(), EndRxData(), Reset(), and ~LteSpectrumPhy().

Time ns3::LteSpectrumPhy::m_firstRxDuration
private

Definition at line 420 of file lte-spectrum-phy.h.

Referenced by StartRxCtrl(), and StartRxData().

Time ns3::LteSpectrumPhy::m_firstRxStart
private

Definition at line 419 of file lte-spectrum-phy.h.

Referenced by StartRxCtrl(), and StartRxData().

Ptr<LteHarqPhy> ns3::LteSpectrumPhy::m_harqPhyModule
private

Definition at line 452 of file lte-spectrum-phy.h.

Referenced by EndRxData(), and SetHarqPhyModule().

uint8_t ns3::LteSpectrumPhy::m_layersNum
private

Definition at line 449 of file lte-spectrum-phy.h.

Referenced by EndRxData(), Reset(), and SetTransmissionMode().

LtePhyDlHarqFeedbackCallback ns3::LteSpectrumPhy::m_ltePhyDlHarqFeedbackCallback
private

Definition at line 453 of file lte-spectrum-phy.h.

Referenced by DoDispose(), EndRxData(), and SetLtePhyDlHarqFeedbackCallback().

LtePhyRxCtrlEndErrorCallback ns3::LteSpectrumPhy::m_ltePhyRxCtrlEndErrorCallback
private

Definition at line 433 of file lte-spectrum-phy.h.

Referenced by DoDispose(), EndRxDlCtrl(), and SetLtePhyRxCtrlEndErrorCallback().

LtePhyRxCtrlEndOkCallback ns3::LteSpectrumPhy::m_ltePhyRxCtrlEndOkCallback
private
LtePhyRxDataEndErrorCallback ns3::LteSpectrumPhy::m_ltePhyRxDataEndErrorCallback
private

Definition at line 429 of file lte-spectrum-phy.h.

Referenced by DoDispose(), and SetLtePhyRxDataEndErrorCallback().

LtePhyRxDataEndOkCallback ns3::LteSpectrumPhy::m_ltePhyRxDataEndOkCallback
private

Definition at line 430 of file lte-spectrum-phy.h.

Referenced by DoDispose(), EndRxData(), and SetLtePhyRxDataEndOkCallback().

LtePhyTxEndCallback ns3::LteSpectrumPhy::m_ltePhyTxEndCallback
private

Definition at line 428 of file lte-spectrum-phy.h.

Referenced by DoDispose(), EndTx(), and SetLtePhyTxEndCallback().

LtePhyUlHarqFeedbackCallback ns3::LteSpectrumPhy::m_ltePhyUlHarqFeedbackCallback
private

Definition at line 454 of file lte-spectrum-phy.h.

Referenced by DoDispose(), EndRxData(), and SetLtePhyUlHarqFeedbackCallback().

Ptr<MobilityModel> ns3::LteSpectrumPhy::m_mobility
private

Definition at line 403 of file lte-spectrum-phy.h.

Referenced by DoDispose(), GetMobility(), and SetMobility().

TracedCallback<Ptr<const Packet> > ns3::LteSpectrumPhy::m_phyRxEndErrorTrace
private

Definition at line 426 of file lte-spectrum-phy.h.

Referenced by EndRxData(), and GetTypeId().

TracedCallback<Ptr<const Packet> > ns3::LteSpectrumPhy::m_phyRxEndOkTrace
private

Definition at line 425 of file lte-spectrum-phy.h.

Referenced by EndRxData(), and GetTypeId().

TracedCallback<Ptr<const PacketBurst> > ns3::LteSpectrumPhy::m_phyRxStartTrace
private

Definition at line 424 of file lte-spectrum-phy.h.

Referenced by GetTypeId(), and StartRxData().

TracedCallback<Ptr<const PacketBurst> > ns3::LteSpectrumPhy::m_phyTxEndTrace
private

Definition at line 423 of file lte-spectrum-phy.h.

Referenced by EndTx(), and GetTypeId().

TracedCallback<Ptr<const PacketBurst> > ns3::LteSpectrumPhy::m_phyTxStartTrace
private

Definition at line 422 of file lte-spectrum-phy.h.

Referenced by GetTypeId(), and StartTxDataFrame().

Ptr<UniformRandomVariable> ns3::LteSpectrumPhy::m_random
private

Provides uniform random variables.

Definition at line 444 of file lte-spectrum-phy.h.

Referenced by AssignStreams(), EndRxData(), EndRxDlCtrl(), and LteSpectrumPhy().

std::list<Ptr<LteControlMessage> > ns3::LteSpectrumPhy::m_rxControlMessageList
private

Definition at line 415 of file lte-spectrum-phy.h.

Referenced by EndRxData(), EndRxDlCtrl(), Reset(), StartRxCtrl(), and StartRxData().

std::list<Ptr<PacketBurst> > ns3::LteSpectrumPhy::m_rxPacketBurstList
private

Definition at line 412 of file lte-spectrum-phy.h.

Referenced by EndRxData(), Reset(), and StartRxData().

Ptr<const SpectrumModel> ns3::LteSpectrumPhy::m_rxSpectrumModel
private

Definition at line 409 of file lte-spectrum-phy.h.

Referenced by GetRxSpectrumModel(), Reset(), and SetNoisePowerSpectralDensity().

SpectrumValue ns3::LteSpectrumPhy::m_sinrPerceived
private

Definition at line 441 of file lte-spectrum-phy.h.

Referenced by EndRxData(), EndRxDlCtrl(), and UpdateSinrPerceived().

uint8_t ns3::LteSpectrumPhy::m_transmissionMode
private

Definition at line 448 of file lte-spectrum-phy.h.

Referenced by EndRxData(), EndRxDlCtrl(), Reset(), and SetTransmissionMode().

std::list<Ptr<LteControlMessage> > ns3::LteSpectrumPhy::m_txControlMessageList
private

Definition at line 414 of file lte-spectrum-phy.h.

Referenced by Reset().

std::vector<double> ns3::LteSpectrumPhy::m_txModeGain
private
Ptr<PacketBurst> ns3::LteSpectrumPhy::m_txPacketBurst
private

Definition at line 411 of file lte-spectrum-phy.h.

Referenced by EndTx(), Reset(), and StartTxDataFrame().

Ptr<SpectrumValue> ns3::LteSpectrumPhy::m_txPsd
private
TracedCallback<PhyReceptionStatParameters> ns3::LteSpectrumPhy::m_ulPhyReception
private

Trace information regarding PHY stats from UL Rx perspective PhyReceptionStatParameters (see lte-common.h)

Definition at line 468 of file lte-spectrum-phy.h.

Referenced by EndRxData(), and GetTypeId().


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