#include <spectrum-interference.h>

Inheritance diagram for ns3::SpectrumInterference:

Public Member Functions
void	AbortRx ()

void	AddSignal (Ptr< const SpectrumValue > spd, const Time duration)

bool	EndRx ()

void	SetErrorModel (Ptr< SpectrumErrorModel > e)

void	SetNoisePowerSpectralDensity (Ptr< const SpectrumValue > noisePsd)

void	StartRx (Ptr< const Packet > p, Ptr< const SpectrumValue > rxPsd)

Public Member Functions inherited from ns3::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	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::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)

Protected Member Functions
void	DoDispose ()

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Private Member Functions
void	ConditionallyEvaluateChunk ()

void	DoAddSignal (Ptr< const SpectrumValue > spd)

void	DoSubtractSignal (Ptr< const SpectrumValue > spd)

Private Attributes
Ptr< SpectrumValue >	m_allSignals

Ptr< SpectrumErrorModel >	m_errorModel

Time	m_lastChangeTime

Ptr< const SpectrumValue >	m_noise

bool	m_receiving

Ptr< const SpectrumValue >	m_rxSignal

Additional Inherited Members
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (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 spectrum-interference.h.

Member Function Documentation

void ns3::SpectrumInterference::AbortRx ( )

notify that the PHY has aborted RX

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

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

spd	the power spectral density of the new signal
duration	the duration of the new signal

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

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

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

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_rxSignal, and NS_LOG_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.