A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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)
 
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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
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)
 

Protected Member Functions

void DoDispose ()
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Private Member Functions

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

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
 
Time m_lastChangeTime
 the time of the last change in m_TotalPower More...
 
Ptr< const SpectrumValuem_noise
 
bool m_receiving
 
Ptr< const SpectrumValuem_rxSignal
 stores the power spectral density of the signal whose RX is being attempted More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. 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 spectrum-interference.h.

Constructor & Destructor Documentation

ns3::SpectrumInterference::SpectrumInterference ( )

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

References NS_LOG_FUNCTION.

ns3::SpectrumInterference::~SpectrumInterference ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::SpectrumInterference::AbortRx ( )

notify that the PHY has aborted RX

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

References m_receiving.

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

+ Here is the caller graph for this function:

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

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

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::SpectrumInterference::ConditionallyEvaluateChunk ( )
private

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

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

Definition at line 96 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:

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

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 50 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:

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

Definition at line 105 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:

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

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

set the SpectrumErrorModel to be used.

Parameters
e

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

References m_errorModel, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

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

References m_allSignals, m_noise, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

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

Referenced by DoDispose(), and SetNoisePowerSpectralDensity().

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

the time of the last change in m_TotalPower

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

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

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

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

Referenced by DoDispose(), and SetNoisePowerSpectralDensity().

bool ns3::SpectrumInterference::m_receiving
private

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

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

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

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

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

Referenced by DoDispose(), and StartRx().


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