A threshold-based model for detecting PHY preamble. More...

#include "threshold-preamble-detection-model.h"

Inheritance diagram for ns3::ThresholdPreambleDetectionModel:

Collaboration diagram for ns3::ThresholdPreambleDetectionModel:

Public Member Functions
	ThresholdPreambleDetectionModel ()

	~ThresholdPreambleDetectionModel () override

bool	IsPreambleDetected (double rssi, double snr, double channelWidth) const override
	This method returns whether the preamble detection was successful.

virtual bool	IsPreambleDetected (double rssi, double snr, double channelWidth) const =0
	A pure virtual method that must be implemented in the subclass.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::PreambleDetectionModel
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
double	m_rssiMin
	Minimum RSSI in dBm that shall be received to start the decision.

double	m_threshold
	SNR threshold in dB used to decide whether a preamble is successfully received.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

A threshold-based model for detecting PHY preamble.

This model assumes that a preamble is successfully detected if SNR is at or above a given threshold (set to 4 dB by default). However, if RSSI is below a minimum RSSI (set to -82 dBm by default), the PHY preamble is not detected.

Config Paths

ns3::ThresholdPreambleDetectionModel is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/PreambleDetectionModel/$ns3::ThresholdPreambleDetectionModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/PreambleDetectionModel/$ns3::ThresholdPreambleDetectionModel"

Attributes

MinimumRssi: Preamble is dropped if the RSSI is below this value (expressed in dBm).
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: -82
- Flags: constructwriteread
Threshold: Preamble is successfully detected if the SNR is at or above this value (expressed in dB).
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 4
- Flags: constructwriteread

No TraceSources are defined for this type.
Size of this type is 48 bytes (on a 64-bit architecture).

Definition at line 35 of file threshold-preamble-detection-model.h.

Constructor & Destructor Documentation

◆ ThresholdPreambleDetectionModel()

ns3::ThresholdPreambleDetectionModel::ThresholdPreambleDetectionModel ( )

Definition at line 56 of file threshold-preamble-detection-model.cc.

References NS_LOG_FUNCTION.

◆ ~ThresholdPreambleDetectionModel()

ns3::ThresholdPreambleDetectionModel::~ThresholdPreambleDetectionModel ( )

override

Definition at line 61 of file threshold-preamble-detection-model.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::ThresholdPreambleDetectionModel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 35 of file threshold-preamble-detection-model.cc.

References m_rssiMin, m_threshold, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ IsPreambleDetected()

bool ns3::ThresholdPreambleDetectionModel::IsPreambleDetected	(	double	rssi,
		double	snr,
		double	channelWidth
	)		const

overridevirtual

This method returns whether the preamble detection was successful.

Parameters

rssi	the RSSI of the received signal (in Watts).
snr	the SNR ratio (linear scale) of the received signal.
channelWidth	the channel width of the received signal in MHz.