A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::LteInterference Class Reference

This class implements a gaussian interference model, i.e., all incoming signals are added to the total interference. More...

#include "lte-interference.h"

+ Inheritance diagram for ns3::LteInterference:

Public Member Functions

 LteInterference ()
 
virtual ~LteInterference ()
 
void AddInterferenceChunkProcessor (Ptr< LteChunkProcessor > p)
 Add a LteChunkProcessor that will use the time-vs-frequency interference calculated by this LteInterference instance. More...
 
void AddRsPowerChunkProcessor (Ptr< LteChunkProcessor > p)
 Add a LteChunkProcessor that will use the time-vs-frequency power calculated by this LteInterference instance. More...
 
void AddSignal (Ptr< const SpectrumValue > spd, const Time duration)
 notify that a new signal is being perceived in the medium. More...
 
void AddSinrChunkProcessor (Ptr< LteChunkProcessor > p)
 Add a LteChunkProcessor that will use the time-vs-frequency SINR calculated by this LteInterference instance. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
void EndRx ()
 notify that the RX attempt has ended. More...
 
void SetNoisePowerSpectralDensity (Ptr< const SpectrumValue > noisePsd)
 
void StartRx (Ptr< const SpectrumValue > rxPsd)
 notify that the PHY is starting a RX attempt 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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...
 

Private Member Functions

void ConditionallyEvaluateChunk ()
 Considitionally evaluate chunk. More...
 
void DoAddSignal (Ptr< const SpectrumValue > spd)
 Add signal function. More...
 
void DoSubtractSignal (Ptr< const SpectrumValue > spd, uint32_t signalId)
 Subtract signal. More...
 

Private Attributes

Ptr< SpectrumValuem_allSignals
 stores the spectral power density of the sum of incoming signals; does not include noise, includes the SPD of the signal being RX More...
 
std::list< Ptr< LteChunkProcessor > > m_interfChunkProcessorList
 all the processor instances that need to be notified whenever a new interference chunk is calculated More...
 
Time m_lastChangeTime
 the time of the last change in m_TotalPower More...
 
uint32_t m_lastSignalId
 the last signal ID More...
 
uint32_t m_lastSignalIdBeforeReset
 the last signal ID before reset More...
 
Ptr< const SpectrumValuem_noise
 the noise value More...
 
bool m_receiving
 are we receiving? More...
 
std::list< Ptr< LteChunkProcessor > > m_rsPowerChunkProcessorList
 all the processor instances that need to be notified whenever a new interference chunk is calculated More...
 
Ptr< SpectrumValuem_rxSignal
 stores the power spectral density of the signal whose RX is being attempted More...
 
std::list< Ptr< LteChunkProcessor > > m_sinrChunkProcessorList
 all the processor instances that need to be notified whenever a new SINR chunk is calculated 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

This class implements a gaussian interference model, i.e., all incoming signals are added to the total interference.

Definition at line 46 of file lte-interference.h.

Constructor & Destructor Documentation

◆ LteInterference()

ns3::LteInterference::LteInterference ( )

Definition at line 33 of file lte-interference.cc.

References NS_LOG_FUNCTION.

◆ ~LteInterference()

ns3::LteInterference::~LteInterference ( )
virtual

Definition at line 41 of file lte-interference.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddInterferenceChunkProcessor()

void ns3::LteInterference::AddInterferenceChunkProcessor ( Ptr< LteChunkProcessor p)

Add a LteChunkProcessor that will use the time-vs-frequency interference calculated by this LteInterference instance.

Note that all the added LteChunkProcessors will work in parallel.

Parameters
p

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

References m_interfChunkProcessorList, and NS_LOG_FUNCTION.

◆ AddRsPowerChunkProcessor()

void ns3::LteInterference::AddRsPowerChunkProcessor ( Ptr< LteChunkProcessor p)

Add a LteChunkProcessor that will use the time-vs-frequency power calculated by this LteInterference instance.

Note that all the added LteChunkProcessors will work in parallel.

Parameters
p

Definition at line 231 of file lte-interference.cc.

References m_rsPowerChunkProcessorList, and NS_LOG_FUNCTION.

◆ AddSignal()

void ns3::LteInterference::AddSignal ( Ptr< const SpectrumValue spd,
const Time  duration 
)

notify that a new signal is being perceived in the medium.

This method is to be called for all incoming signal, regardless of whether they're useful signals or interferers.

Parameters
spdthe power spectral density of the new signal
durationthe duration of the new signal

Definition at line 135 of file lte-interference.cc.

References DoAddSignal(), DoSubtractSignal(), m_lastSignalId, m_lastSignalIdBeforeReset, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

◆ AddSinrChunkProcessor()

void ns3::LteInterference::AddSinrChunkProcessor ( Ptr< LteChunkProcessor p)

Add a LteChunkProcessor that will use the time-vs-frequency SINR calculated by this LteInterference instance.

Note that all the added LteChunkProcessors will work in parallel.

Parameters
p

Definition at line 238 of file lte-interference.cc.

References m_sinrChunkProcessorList, and NS_LOG_FUNCTION.

◆ ConditionallyEvaluateChunk()

void ns3::LteInterference::ConditionallyEvaluateChunk ( )
private

◆ DoAddSignal()

void ns3::LteInterference::DoAddSignal ( Ptr< const SpectrumValue spd)
private

Add signal function.

Parameters
spdthe power spectral density of the new signal

Definition at line 154 of file lte-interference.cc.

References ConditionallyEvaluateChunk(), and NS_LOG_FUNCTION.

Referenced by AddSignal().

◆ DoDispose()

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

Definition at line 47 of file lte-interference.cc.

References ns3::Object::DoDispose(), m_allSignals, m_interfChunkProcessorList, m_noise, m_rsPowerChunkProcessorList, m_rxSignal, m_sinrChunkProcessorList, and NS_LOG_FUNCTION.

◆ DoSubtractSignal()

void ns3::LteInterference::DoSubtractSignal ( Ptr< const SpectrumValue spd,
uint32_t  signalId 
)
private

Subtract signal.

Parameters
spdthe power spectral density of the new signal
signalIdthe signal ID

Definition at line 162 of file lte-interference.cc.

References ConditionallyEvaluateChunk(), m_lastSignalIdBeforeReset, NS_LOG_FUNCTION, and NS_LOG_INFO.

Referenced by AddSignal().

◆ EndRx()

void ns3::LteInterference::EndRx ( )

notify that the RX attempt has ended.

The receiving PHY must call this method when RX ends or RX is aborted.

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

References ConditionallyEvaluateChunk(), list, m_interfChunkProcessorList, m_receiving, m_rsPowerChunkProcessorList, m_sinrChunkProcessorList, NS_LOG_FUNCTION, and NS_LOG_INFO.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 61 of file lte-interference.cc.

References ns3::TypeId::SetParent().

◆ SetNoisePowerSpectralDensity()

void ns3::LteInterference::SetNoisePowerSpectralDensity ( Ptr< const SpectrumValue noisePsd)
Parameters
noisePsdthe Noise Power Spectral Density in power units (Watt, Pascal...) per Hz.

Definition at line 212 of file lte-interference.cc.

References ConditionallyEvaluateChunk(), m_allSignals, m_lastSignalId, m_lastSignalIdBeforeReset, m_noise, m_receiving, and NS_LOG_FUNCTION.

◆ StartRx()

void ns3::LteInterference::StartRx ( Ptr< const SpectrumValue rxPsd)

notify that the PHY is starting a RX attempt

Parameters
rxPsdthe power spectral density of the signal being RX

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

References list, m_interfChunkProcessorList, m_lastChangeTime, m_receiving, m_rsPowerChunkProcessorList, m_rxSignal, m_sinrChunkProcessorList, ns3::Now(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC(), and ns3::Sum().

Member Data Documentation

◆ m_allSignals

Ptr<SpectrumValue> ns3::LteInterference::m_allSignals
private

stores the spectral power density of the sum of incoming signals; does not include noise, includes the SPD of the signal being RX

Definition at line 148 of file lte-interference.h.

Referenced by ConditionallyEvaluateChunk(), DoDispose(), and SetNoisePowerSpectralDensity().

◆ m_interfChunkProcessorList

std::list<Ptr<LteChunkProcessor> > ns3::LteInterference::m_interfChunkProcessorList
private

all the processor instances that need to be notified whenever a new interference chunk is calculated

Definition at line 171 of file lte-interference.h.

Referenced by AddInterferenceChunkProcessor(), ConditionallyEvaluateChunk(), DoDispose(), EndRx(), and StartRx().

◆ m_lastChangeTime

Time ns3::LteInterference::m_lastChangeTime
private

the time of the last change in m_TotalPower

Definition at line 155 of file lte-interference.h.

Referenced by ConditionallyEvaluateChunk(), and StartRx().

◆ m_lastSignalId

uint32_t ns3::LteInterference::m_lastSignalId
private

the last signal ID

Definition at line 158 of file lte-interference.h.

Referenced by AddSignal(), and SetNoisePowerSpectralDensity().

◆ m_lastSignalIdBeforeReset

uint32_t ns3::LteInterference::m_lastSignalIdBeforeReset
private

the last signal ID before reset

Definition at line 159 of file lte-interference.h.

Referenced by AddSignal(), DoSubtractSignal(), and SetNoisePowerSpectralDensity().

◆ m_noise

Ptr<const SpectrumValue> ns3::LteInterference::m_noise
private

the noise value

Definition at line 153 of file lte-interference.h.

Referenced by ConditionallyEvaluateChunk(), DoDispose(), and SetNoisePowerSpectralDensity().

◆ m_receiving

bool ns3::LteInterference::m_receiving
private

are we receiving?

Definition at line 141 of file lte-interference.h.

Referenced by ConditionallyEvaluateChunk(), EndRx(), SetNoisePowerSpectralDensity(), and StartRx().

◆ m_rsPowerChunkProcessorList

std::list<Ptr<LteChunkProcessor> > ns3::LteInterference::m_rsPowerChunkProcessorList
private

all the processor instances that need to be notified whenever a new interference chunk is calculated

Definition at line 163 of file lte-interference.h.

Referenced by AddRsPowerChunkProcessor(), ConditionallyEvaluateChunk(), DoDispose(), EndRx(), and StartRx().

◆ m_rxSignal

Ptr<SpectrumValue> ns3::LteInterference::m_rxSignal
private

stores the power spectral density of the signal whose RX is being attempted

Definition at line 143 of file lte-interference.h.

Referenced by ConditionallyEvaluateChunk(), DoDispose(), and StartRx().

◆ m_sinrChunkProcessorList

std::list<Ptr<LteChunkProcessor> > ns3::LteInterference::m_sinrChunkProcessorList
private

all the processor instances that need to be notified whenever a new SINR chunk is calculated

Definition at line 167 of file lte-interference.h.

Referenced by AddSinrChunkProcessor(), ConditionallyEvaluateChunk(), DoDispose(), EndRx(), and StartRx().


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