A Discrete-Event Network Simulator
API
ns3::ObssPdAlgorithm Class Referenceabstract

OBSS PD algorithm interfaceThis object provides the interface for all OBSS_PD algorithms and is designed to be subclassed. More...

#include "obss-pd-algorithm.h"

+ Inheritance diagram for ns3::ObssPdAlgorithm:
+ Collaboration diagram for ns3::ObssPdAlgorithm:

Public Types

typedef void(* ResetTracedCallback) (uint8_t bssColor, double rssiDbm, bool powerRestricted, double txPowerMaxDbmSiso, double txPowerMaxDbmMimo)
 TracedCallback signature for OBSS_PD reset events. More...
 

Public Member Functions

virtual void ConnectWifiNetDevice (const Ptr< WifiNetDevice > device)
 Connect the WifiNetDevice and setup eventual callbacks. More...
 
virtual void ReceiveHeSigA (HeSigAParameters params)=0
 
void ResetPhy (HeSigAParameters params)
 Reset PHY to IDLE. 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated 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 () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
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...
 
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::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...
 

Protected Member Functions

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

Protected Attributes

Ptr< WifiNetDevicem_device
 Pointer to the WifiNetDevice. More...
 
double m_obssPdLevel
 Current OBSS PD level (dBm) More...
 

Private Attributes

double m_obssPdLevelMax
 Maximum OBSS PD level (dBm) More...
 
double m_obssPdLevelMin
 Minimum OBSS PD level (dBm) More...
 
TracedCallback< uint8_t, double, bool, double, double > m_resetEvent
 TracedCallback signature for PHY reset events. More...
 
double m_txPowerRefMimo
 MIMO reference TX power level (dBm) More...
 
double m_txPowerRefSiso
 SISO reference TX power level (dBm) More...
 

Additional Inherited Members

Detailed Description

OBSS PD algorithm interface

This object provides the interface for all OBSS_PD algorithms and is designed to be subclassed.


Introspection did not find any typical Config paths.

OBSS_PD stands for Overlapping Basic Service Set Preamble-Detection. OBSS_PD is an 802.11ax feature that allows a STA, under specific conditions, to ignore an inter-BSS PPDU.


Attributes

  • ObssPdLevel: The current OBSS PD level (dBm).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -101:-62
    • Initial value: -82
    • Flags: construct write read
  • ObssPdLevelMin: Minimum value (dBm) of OBSS PD level.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -101:-62
    • Initial value: -82
    • Flags: construct write read
  • ObssPdLevelMax: Maximum value (dBm) of OBSS PD level.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -101:-62
    • Initial value: -62
    • Flags: construct write read
  • TxPowerRefSiso: The SISO reference TX power level (dBm).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 21
    • Flags: construct write read
  • TxPowerRefMimo: The MIMO reference TX power level (dBm).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 25
    • Flags: construct write read

TraceSources

Size of this type is 96 bytes (on a 64-bit architecture).

Definition at line 45 of file obss-pd-algorithm.h.

Member Typedef Documentation

◆ ResetTracedCallback

typedef void(* ns3::ObssPdAlgorithm::ResetTracedCallback) (uint8_t bssColor, double rssiDbm, bool powerRestricted, double txPowerMaxDbmSiso, double txPowerMaxDbmMimo)

TracedCallback signature for OBSS_PD reset events.

Parameters
[in]bssColorThe BSS color of frame triggering the reset
[in]rssiDbmThe RSSI (dBm) of frame triggering the reset
[in]powerRestrictedWhether a TX power restriction is triggered
[in]txPowerMaxDbmSisoThe SISO TX power restricted level (dBm)
[in]txPowerMaxDbmMimoThe MIMO TX power restricted level (dBm)

Definition at line 83 of file obss-pd-algorithm.h.

Member Function Documentation

◆ ConnectWifiNetDevice()

void ns3::ObssPdAlgorithm::ConnectWifiNetDevice ( const Ptr< WifiNetDevice device)
virtual

Connect the WifiNetDevice and setup eventual callbacks.

Parameters
devicethe WifiNetDevice

Reimplemented in ns3::ConstantObssPdAlgorithm.

Definition at line 80 of file obss-pd-algorithm.cc.

References m_device, and NS_LOG_FUNCTION.

Referenced by ns3::ConstantObssPdAlgorithm::ConnectWifiNetDevice().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::ObssPdAlgorithm::DoDispose ( void  )
protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden 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 73 of file obss-pd-algorithm.cc.

References m_device, and NS_LOG_FUNCTION.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 35 of file obss-pd-algorithm.cc.

References m_obssPdLevel, m_obssPdLevelMax, m_obssPdLevelMin, m_resetEvent, m_txPowerRefMimo, m_txPowerRefSiso, ns3::MakeDoubleAccessor(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ ReceiveHeSigA()

virtual void ns3::ObssPdAlgorithm::ReceiveHeSigA ( HeSigAParameters  params)
pure virtual
Parameters
paramsthe HE-SIG-A parameters

Evaluate the receipt of HE-SIG-A.

Implemented in ns3::ConstantObssPdAlgorithm.

◆ ResetPhy()

void ns3::ObssPdAlgorithm::ResetPhy ( HeSigAParameters  params)

Member Data Documentation

◆ m_device

Ptr<WifiNetDevice> ns3::ObssPdAlgorithm::m_device
protected

◆ m_obssPdLevel

double ns3::ObssPdAlgorithm::m_obssPdLevel
protected

Current OBSS PD level (dBm)

Definition at line 89 of file obss-pd-algorithm.h.

Referenced by GetTypeId(), ns3::ConstantObssPdAlgorithm::ReceiveHeSigA(), and ResetPhy().

◆ m_obssPdLevelMax

double ns3::ObssPdAlgorithm::m_obssPdLevelMax
private

Maximum OBSS PD level (dBm)

Definition at line 94 of file obss-pd-algorithm.h.

Referenced by GetTypeId(), and ResetPhy().

◆ m_obssPdLevelMin

double ns3::ObssPdAlgorithm::m_obssPdLevelMin
private

Minimum OBSS PD level (dBm)

Definition at line 93 of file obss-pd-algorithm.h.

Referenced by GetTypeId(), and ResetPhy().

◆ m_resetEvent

TracedCallback<uint8_t, double, bool, double, double> ns3::ObssPdAlgorithm::m_resetEvent
private

TracedCallback signature for PHY reset events.

Definition at line 101 of file obss-pd-algorithm.h.

Referenced by GetTypeId(), and ResetPhy().

◆ m_txPowerRefMimo

double ns3::ObssPdAlgorithm::m_txPowerRefMimo
private

MIMO reference TX power level (dBm)

Definition at line 96 of file obss-pd-algorithm.h.

Referenced by GetTypeId(), and ResetPhy().

◆ m_txPowerRefSiso

double ns3::ObssPdAlgorithm::m_txPowerRefSiso
private

SISO reference TX power level (dBm)

Definition at line 95 of file obss-pd-algorithm.h.

Referenced by GetTypeId(), and ResetPhy().


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