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

#include <lte-interference.h>

+ Inheritance diagram for ns3::LteInterference:
+ Collaboration diagram for ns3::LteInterference:

Public Member Functions

 LteInterference ()
virtual ~LteInterference ()
void AddSignal (Ptr< const SpectrumValue > spd, const Time duration)
void AddSinrChunkProcessor (Ptr< LteSinrChunkProcessor > p)
virtual void DoDispose ()
void EndRx ()
void SetNoisePowerSpectralDensity (Ptr< const SpectrumValue > noisePsd)
void StartRx (Ptr< const SpectrumValue > rxPsd)
- 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 Start (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)
 This method returns the TypeId associated to ns3::Object.

Private Member Functions

void ConditionallyEvaluateChunk ()
void DoAddSignal (Ptr< const SpectrumValue > spd)
void DoSubtractSignal (Ptr< const SpectrumValue > spd)

Private Attributes

Ptr< SpectrumValuem_allSignals
Time m_lastChangeTime
Ptr< const SpectrumValuem_noise
bool m_receiving
Ptr< SpectrumValuem_rxSignal
std::list< Ptr
< LteSinrChunkProcessor > > 
m_sinrChunkProcessorList

Additional Inherited Members

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

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

ns3::LteInterference::LteInterference ( )

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

References NS_LOG_FUNCTION.

ns3::LteInterference::~LteInterference ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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 wether they're useful signals or interferers.

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

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

References DoAddSignal(), DoSubtractSignal(), ns3::SpectrumValue::GetSpectrumModel(), m_allSignals, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

Referenced by ns3::LteSpectrumPhy::StartRx().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Add a LteSinrChunkProcessor that will use the time-vs-frequency SINR calculated by this LteInterference instance. Note that all the added LteSinrChunkProcessors will work in parallel.

Parameters
p

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

References m_sinrChunkProcessorList, and NS_LOG_FUNCTION.

Referenced by ns3::LteSpectrumPhy::AddSinrChunkProcessor().

+ Here is the caller graph for this function:

void ns3::LteInterference::ConditionallyEvaluateChunk ( )
private

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

References list, m_allSignals, m_lastChangeTime, m_noise, m_receiving, m_rxSignal, m_sinrChunkProcessorList, ns3::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by DoAddSignal(), DoSubtractSignal(), and EndRx().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

References ConditionallyEvaluateChunk(), m_lastChangeTime, ns3::Now(), and NS_LOG_FUNCTION.

Referenced by AddSignal().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::LteInterference::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 46 of file lte-interference.cc.

References m_allSignals, m_noise, m_rxSignal, m_sinrChunkProcessorList, and NS_LOG_FUNCTION.

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

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

References ConditionallyEvaluateChunk(), m_lastChangeTime, ns3::Now(), and NS_LOG_FUNCTION.

Referenced by AddSignal().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 95 of file lte-interference.cc.

References ConditionallyEvaluateChunk(), list, m_receiving, m_sinrChunkProcessorList, and NS_LOG_FUNCTION.

Referenced by ns3::LteSpectrumPhy::EndRx().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

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

Reimplemented from ns3::Object.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

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

References ns3::SpectrumValue::GetSpectrumModel(), m_allSignals, m_noise, and NS_LOG_FUNCTION.

Referenced by ns3::LteSpectrumPhy::SetNoisePowerSpectralDensity().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 68 of file lte-interference.cc.

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

Referenced by ns3::LteSpectrumPhy::StartRx().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

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 113 of file lte-interference.h.

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

Time ns3::LteInterference::m_lastChangeTime
private

the time of the last change in m_TotalPower

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

Referenced by ConditionallyEvaluateChunk(), DoAddSignal(), DoSubtractSignal(), and StartRx().

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

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

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

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

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

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

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

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

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

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

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


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