OBSS PD algorithm interface. 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.

Public Member Functions
virtual void	ConnectWifiNetDevice (const Ptr< WifiNetDevice > device)
	Connect the WifiNetDevice and setup eventual callbacks.

dBm_u	GetObssPdLevel () const

virtual void	ReceiveHeSigA (HeSigAParameters params)=0

void	ResetPhy (HeSigAParameters params)
	Reset PHY to IDLE.

void	SetObssPdLevel (dBm_u level)

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.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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, bool permissive=false) 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.

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::Object
static TypeId	GetTypeId ()
	Register this type.

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

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

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

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.

Protected Attributes
Ptr< WifiNetDevice >	m_device
	Pointer to the WifiNetDevice.

Private Attributes
dBm_u	m_obssPdLevel
	Current OBSS PD level.

dBm_u	m_obssPdLevelMax
	Maximum OBSS PD level.

dBm_u	m_obssPdLevelMin
	Minimum OBSS PD level.

TracedCallback< uint8_t, double, bool, double, double >	m_resetEvent
	TracedCallback signature for PHY reset events.

dBm_u	m_txPowerRefMimo
	MIMO reference TX power level.

dBm_u	m_txPowerRefSiso
	SISO reference TX power level.

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

Detailed Description

OBSS PD algorithm interface.

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

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.

Definition at line 36 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]	bssColor	The BSS color of frame triggering the reset
[in]	rssiDbm	The RSSI (dBm) of frame triggering the reset
[in]	powerRestricted	Whether a TX power restriction is triggered
[in]	txPowerMaxDbmSiso	The SISO TX power restricted level (dBm)
[in]	txPowerMaxDbmMimo	The MIMO TX power restricted level (dBm)

Definition at line 74 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

device the WifiNetDevice

Reimplemented in ns3::ConstantObssPdAlgorithm.

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

References ns3::DynamicCast(), m_device, NS_ASSERT, NS_LOG_FUNCTION, ns3::WIFI_MOD_CLASS_EHT, ns3::WIFI_MOD_CLASS_HE, and ns3::WIFI_STANDARD_80211be.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDispose()

void ns3::ObssPdAlgorithm::DoDispose ( )

overrideprotectedvirtual

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 65 of file obss-pd-algorithm.cc.

References m_device, and NS_LOG_FUNCTION.

◆ GetObssPdLevel()

dBm_u ns3::ObssPdAlgorithm::GetObssPdLevel ( ) const

Returns: the current OBSS PD level

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

References m_obssPdLevel.

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

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ObssPdAlgorithm::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

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

Here is the call graph for this function:

◆ ReceiveHeSigA()

virtual void ns3::ObssPdAlgorithm::ReceiveHeSigA ( HeSigAParameters params )

pure virtual

Parameters

params the HE-SIG-A parameters

Evaluate the receipt of HE-SIG-A.

Implemented in ns3::ConstantObssPdAlgorithm.

◆ ResetPhy()

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

Reset PHY to IDLE.

Parameters

params HeSigAParameters causing PHY reset

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

References m_device, m_obssPdLevel, m_obssPdLevelMax, m_obssPdLevelMin, m_resetEvent, m_txPowerRefMimo, m_txPowerRefSiso, NS_ASSERT, and NS_LOG_DEBUG.

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

Here is the caller graph for this function:

◆ SetObssPdLevel()

void ns3::ObssPdAlgorithm::SetObssPdLevel ( dBm_u level )

Parameters

level the current OBSS PD level

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

References m_obssPdLevel, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_device

Ptr<WifiNetDevice> ns3::ObssPdAlgorithm::m_device

protected

Pointer to the WifiNetDevice.

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

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

◆ m_obssPdLevel

dBm_u ns3::ObssPdAlgorithm::m_obssPdLevel

private

Current OBSS PD level.

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

Referenced by GetObssPdLevel(), ResetPhy(), and SetObssPdLevel().

◆ m_obssPdLevelMax

dBm_u ns3::ObssPdAlgorithm::m_obssPdLevelMax

private

Maximum OBSS PD level.

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

Referenced by GetTypeId(), and ResetPhy().

◆ m_obssPdLevelMin

dBm_u ns3::ObssPdAlgorithm::m_obssPdLevelMin

private

Minimum OBSS PD level.

Definition at line 96 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 104 of file obss-pd-algorithm.h.

Referenced by GetTypeId(), and ResetPhy().

◆ m_txPowerRefMimo

dBm_u ns3::ObssPdAlgorithm::m_txPowerRefMimo

private

MIMO reference TX power level.

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

Referenced by GetTypeId(), and ResetPhy().

◆ m_txPowerRefSiso

dBm_u ns3::ObssPdAlgorithm::m_txPowerRefSiso

private

SISO reference TX power level.

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

Referenced by GetTypeId(), and ResetPhy().

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

src/wifi/model/he/obss-pd-algorithm.h
src/wifi/model/he/obss-pd-algorithm.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ResetTracedCallback

Member Function Documentation

◆ ConnectWifiNetDevice()

◆ DoDispose()

◆ GetObssPdLevel()

◆ GetTypeId()

◆ ReceiveHeSigA()

◆ ResetPhy()

◆ SetObssPdLevel()

Member Data Documentation

◆ m_device

◆ m_obssPdLevel

◆ m_obssPdLevelMax

◆ m_obssPdLevelMin

◆ m_resetEvent

◆ m_txPowerRefMimo

◆ m_txPowerRefSiso