ns-3
ns3::SpectrumInterference Class Reference

#include <spectrum-interference.h>

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

List of all members.

Public Member Functions

void SetErrorModel (Ptr< SpectrumErrorModel > e)
void StartRx (Ptr< const Packet > p, Ptr< const SpectrumValue > rxPsd)
void AbortRx ()
bool EndRx ()
void AddSignal (Ptr< const SpectrumValue > spd, const Time duration)
void SetNoisePowerSpectralDensity (Ptr< const SpectrumValue > noisePsd)

Protected Member Functions

void DoDispose ()

Detailed Description

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


Member Function Documentation

notify that the PHY has aborted RX

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

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

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

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

void ns3::SpectrumInterference::DoDispose ( void  ) [protected, 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.

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

References NS_LOG_FUNCTION.

set the SpectrumErrorModel to be used.

Parameters:
e

References NS_LOG_FUNCTION.

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

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

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

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

References ns3::Now(), and NS_LOG_FUNCTION.

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


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