A Discrete-Event Network Simulator
API
ns3::SpectrumInterference Class Reference

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

#include "spectrum-interference.h"

+ Inheritance diagram for ns3::SpectrumInterference:
+ Collaboration diagram for ns3::SpectrumInterference:

Public Member Functions

 SpectrumInterference ()
 
virtual ~SpectrumInterference ()
 
void AbortRx ()
 Notify that the PHY has aborted RX. More...
 
void AddSignal (Ptr< const SpectrumValue > spd, const Time duration)
 Notify that a new signal is being perceived in the medium. More...
 
bool EndRx ()
 Notify that the RX attempt has ended. More...
 
void SetErrorModel (Ptr< SpectrumErrorModel > e)
 Set the SpectrumErrorModel to be used. More...
 
void SetNoisePowerSpectralDensity (Ptr< const SpectrumValue > noisePsd)
 Set the Noise Power Spectral Density. More...
 
void StartRx (Ptr< const Packet > p, 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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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)
 Register this type. 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...
 

Protected Member Functions

void DoDispose ()
 Destructor implementation. More...
 
- 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...
 

Private Member Functions

void ConditionallyEvaluateChunk ()
 Evaluate a Chunk, depending on the Rx status and the last update time. More...
 
void DoAddSignal (Ptr< const SpectrumValue > spd)
 Adds a signal perceived in the medium. More...
 
void DoSubtractSignal (Ptr< const SpectrumValue > spd)
 Removes a signal perceived in the medium. 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...
 
Ptr< SpectrumErrorModelm_errorModel
 Error model. More...
 
Time m_lastChangeTime
 the time of the last change in m_TotalPower More...
 
Ptr< const SpectrumValuem_noise
 Noise spectral power density. More...
 
bool m_receiving
 True if in Rx status. More...
 
Ptr< const SpectrumValuem_rxSignal
 Stores the power spectral density of the signal whose RX is being attempted. More...
 

Additional Inherited Members

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 spectrum-interference.h.

Constructor & Destructor Documentation

◆ SpectrumInterference()

ns3::SpectrumInterference::SpectrumInterference ( )

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

References NS_LOG_FUNCTION.

◆ ~SpectrumInterference()

ns3::SpectrumInterference::~SpectrumInterference ( )
virtual

Definition at line 43 of file spectrum-interference.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AbortRx()

void ns3::SpectrumInterference::AbortRx ( )

Notify that the PHY has aborted RX.

Definition at line 81 of file spectrum-interference.cc.

References m_receiving.

Referenced by ns3::HalfDuplexIdealPhy::AbortRx().

+ Here is the caller graph for this function:

◆ AddSignal()

void ns3::SpectrumInterference::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 97 of file spectrum-interference.cc.

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ConditionallyEvaluateChunk()

void ns3::SpectrumInterference::ConditionallyEvaluateChunk ( )
private

Evaluate a Chunk, depending on the Rx status and the last update time.

Definition at line 125 of file spectrum-interference.cc.

References m_errorModel, m_lastChangeTime, m_receiving, ns3::Now(), 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:

◆ DoAddSignal()

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

Adds a signal perceived in the medium.

Parameters
spdthe power spectral density of the new signal

Definition at line 106 of file spectrum-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:

◆ DoDispose()

void ns3::SpectrumInterference::DoDispose ( void  )
protectedvirtual

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 60 of file spectrum-interference.cc.

References ns3::Object::DoDispose(), m_allSignals, m_errorModel, m_noise, m_rxSignal, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoSubtractSignal()

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

Removes a signal perceived in the medium.

Parameters
spdthe power spectral density of the new signal

Definition at line 115 of file spectrum-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:

◆ EndRx()

bool ns3::SpectrumInterference::EndRx ( )

Notify that the RX attempt has ended.

The receiving PHY must call this method upon RX end in order to: 1) know if RX was successful or not 2) free up resources that might eventually be used for the calculation of interference. Note that for this reason this method must also be called when RX is aborted.

Returns
true if RX was successful, false otherwise

Definition at line 87 of file spectrum-interference.cc.

References ConditionallyEvaluateChunk(), m_errorModel, m_receiving, and NS_LOG_FUNCTION.

Referenced by ns3::HalfDuplexIdealPhy::EndRx(), and SpectrumInterferenceTestCase::RetrieveTestResult().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

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

Register this type.

Returns
The TypeId.

Definition at line 49 of file spectrum-interference.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetErrorModel()

void ns3::SpectrumInterference::SetErrorModel ( Ptr< SpectrumErrorModel e)

Set the SpectrumErrorModel to be used.

Parameters
ethe error model

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

References m_errorModel, and NS_LOG_FUNCTION.

Referenced by ns3::HalfDuplexIdealPhy::HalfDuplexIdealPhy(), and SpectrumInterferenceTestCase::DoRun().

+ Here is the caller graph for this function:

◆ SetNoisePowerSpectralDensity()

void ns3::SpectrumInterference::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 142 of file spectrum-interference.cc.

References m_allSignals, m_noise, and NS_LOG_FUNCTION.

Referenced by SpectrumInterferenceTestCase::DoRun(), and ns3::HalfDuplexIdealPhy::SetNoisePowerSpectralDensity().

+ Here is the caller graph for this function:

◆ StartRx()

void ns3::SpectrumInterference::StartRx ( Ptr< const Packet p,
Ptr< const SpectrumValue rxPsd 
)

Notify that the PHY is starting a RX attempt.

Parameters
pthe packet corresponding to the signal being RX
rxPsdthe power spectral density of the signal being RX

Definition at line 71 of file spectrum-interference.cc.

References m_errorModel, m_lastChangeTime, m_receiving, m_rxSignal, ns3::Now(), and NS_LOG_FUNCTION.

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_allSignals

Ptr<SpectrumValue> ns3::SpectrumInterference::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 142 of file spectrum-interference.h.

Referenced by DoDispose(), and SetNoisePowerSpectralDensity().

◆ m_errorModel

Ptr<SpectrumErrorModel> ns3::SpectrumInterference::m_errorModel
private

Error model.

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

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

◆ m_lastChangeTime

Time ns3::SpectrumInterference::m_lastChangeTime
private

the time of the last change in m_TotalPower

Definition at line 146 of file spectrum-interference.h.

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

◆ m_noise

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

Noise spectral power density.

Definition at line 144 of file spectrum-interference.h.

Referenced by DoDispose(), and SetNoisePowerSpectralDensity().

◆ m_receiving

bool ns3::SpectrumInterference::m_receiving
private

True if in Rx status.

Definition at line 131 of file spectrum-interference.h.

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

◆ m_rxSignal

Ptr<const SpectrumValue> ns3::SpectrumInterference::m_rxSignal
private

Stores the power spectral density of the signal whose RX is being attempted.

Definition at line 136 of file spectrum-interference.h.

Referenced by DoDispose(), and StartRx().


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