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

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 ()
 
bool IsPreambleDetected (double rssi, double snr, double channelWidth) const override
 This method returns whether the preamble detection was successful. More...
 
virtual bool IsPreambleDetected (double rssi, double snr, double channelWidth) const =0
 A pure virtual method that must be implemented in the subclass. 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::PreambleDetectionModel
static TypeId GetTypeId (void)
 Get the type ID. 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...
 

Private Attributes

double m_rssiMin
 Minimum RSSI in dBm that shall be received to start the decision. More...
 
double m_threshold
 SNR threshold in dB used to decide whether a preamble is successfully received. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. 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...
 

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"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/RemoteStationManagers/[i]/PreambleDetectionModel/$ns3::ThresholdPreambleDetectionModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/PhyEntities/[i]/PreambleDetectionModel/$ns3::ThresholdPreambleDetectionModel"

Attributes

  • Threshold: Preamble is successfully detection 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
  • 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

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

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

Constructor & Destructor Documentation

◆ ThresholdPreambleDetectionModel()

ns3::ThresholdPreambleDetectionModel::ThresholdPreambleDetectionModel ( )

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

References NS_LOG_FUNCTION.

◆ ~ThresholdPreambleDetectionModel()

ns3::ThresholdPreambleDetectionModel::~ThresholdPreambleDetectionModel ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 33 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
rssithe RSSI of the received signal (in Watts).
snrthe SNR ratio (linear scale) of the received signal.
channelWidththe channel width of the received signal in MHz.
Returns
true if the preamble has been detected, false otherwise

Implements ns3::PreambleDetectionModel.

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

References m_rssiMin, m_threshold, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::RatioToDb(), and ns3::WToDbm().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_rssiMin

double ns3::ThresholdPreambleDetectionModel::m_rssiMin
private

Minimum RSSI in dBm that shall be received to start the decision.

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

Referenced by GetTypeId(), and IsPreambleDetected().

◆ m_threshold

double ns3::ThresholdPreambleDetectionModel::m_threshold
private

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

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

Referenced by GetTypeId(), and IsPreambleDetected().


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