ns3::VhtConfiguration Class Reference

VHT configuration. More...

#include "vht-configuration.h"

Inheritance diagram for ns3::VhtConfiguration:

Collaboration diagram for ns3::VhtConfiguration:

Public Types
using	SecondaryCcaSensitivityThresholds
	Tuple identifying CCA sensitivity thresholds for secondary channels.

Public Member Functions
	VhtConfiguration ()
	~VhtConfiguration () override
bool	Get160MHzOperationSupported () const
SecondaryCcaSensitivityThresholds	GetSecondaryCcaSensitivityThresholds () const
const std::map< MHz_u, dBm_u > &	GetSecondaryCcaSensitivityThresholdsPerBw () const
void	Set160MHzOperationSupported (bool enable)
	Enable or disable 160 MHz operation support.
void	SetSecondaryCcaSensitivityThresholds (const SecondaryCcaSensitivityThresholds &thresholds)
	Sets the CCA sensitivity thresholds for PPDUs that do not occupy the primary channel.
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 final
	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.

Public Attributes
bool	m_160MHzSupported
	whether 160 MHz operation is supported

Private Attributes
std::map< MHz_u, dBm_u >	m_secondaryCcaSensitivityThresholds
	CCA sensitivity thresholds for signals that do not occupy the primary channel, indexed by signal bandwidth.

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 Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

VHT configuration.

This object stores VHT configuration information, for use in modifying AP or STA behavior and for constructing VHT-related information elements.

Config Paths

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

• "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/VhtConfiguration"

Attributes

• SecondaryCcaSensitivityThresholds: Tuple {threshold for 20MHz PPDUs, threshold for 40MHz PPDUs, threshold for 80MHz PPDUs} describing the CCA sensitivity thresholds for PPDUs that do not occupy the primary channel. The power of a received PPDU that does not occupy the primary channel should be higher than the threshold (dBm) associated to the PPDU bandwidth to allow the PHY layer to declare CCA BUSY state.
  • Set with class: ns3::TupleValue
  • Initial value: {-72.0, -72.0, -69.0}
  • Flags: constructwriteread
  • Support level: SUPPORTED
• Support160MHzOperation: Whether or not 160 MHz operation is to be supported.
  • Set with class: ns3::BooleanValue
  • Underlying type: bool
  • Initial value: true
  • Flags: constructwriteread
  • Support level: OBSOLETE: Set an initial channel via WifiPhy::ChannelSettings whose width corresponds to the maximum desired width instead

No TraceSources are defined for this type.
Group: Wifi

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

Definition at line 30 of file vht-configuration.h.

Member Typedef Documentation

SecondaryCcaSensitivityThresholds

using ns3::VhtConfiguration::SecondaryCcaSensitivityThresholds

Initial value:

 
        std::tuple<dBm_u, dBm_u, dBm_u>

Tuple identifying CCA sensitivity thresholds for secondary channels.

Definition at line 58 of file vht-configuration.h.

Constructor & Destructor Documentation

VhtConfiguration()

ns3::VhtConfiguration::VhtConfiguration

(

)

Definition at line 24 of file vht-configuration.cc.

References NS_LOG_FUNCTION.

~VhtConfiguration()

ns3::VhtConfiguration::~VhtConfiguration ( )

override

Definition at line 29 of file vht-configuration.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

Get160MHzOperationSupported()

bool ns3::VhtConfiguration::Get160MHzOperationSupported

(

)

const

Returns

true if 20 MHz, 40 MHz, 80 MHz and 160 MHz operation is supported, false if 20 MHz, 40 MHz and 80 MHz operation is supported

Deprecated

"Deprecated in ns-3.44: " "Use WifiPhy::GetChannelWidth instead"

Definition at line 79 of file vht-configuration.cc.

References m_160MHzSupported.

GetSecondaryCcaSensitivityThresholds()

VhtConfiguration::SecondaryCcaSensitivityThresholds ns3::VhtConfiguration::GetSecondaryCcaSensitivityThresholds

(

)

const

Returns

the CCA sensitivity thresholds for PPDUs that do not occupy the primary channel

Definition at line 95 of file vht-configuration.cc.

References m_secondaryCcaSensitivityThresholds.

Referenced by GetTypeId().

Here is the caller graph for this function:

GetSecondaryCcaSensitivityThresholdsPerBw()

const std::map< MHz_u, dBm_u > & ns3::VhtConfiguration::GetSecondaryCcaSensitivityThresholdsPerBw

(

)

const

Returns

the CCA sensitivity thresholds for PPDUs that do not occupy the primary channel, indexed by signal bandwidth

Definition at line 103 of file vht-configuration.cc.

References m_secondaryCcaSensitivityThresholds.

GetTypeId()

TypeId ns3::VhtConfiguration::GetTypeId ( )

static

Get the type ID.

Returns

the object TypeId

Definition at line 35 of file vht-configuration.cc.

References GetSecondaryCcaSensitivityThresholds(), m_160MHzSupported, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDoubleChecker(), ns3::MakeTupleAccessor(), ns3::MakeTupleChecker(), ns3::TypeId::OBSOLETE, ns3::TypeId::SetParent(), and SetSecondaryCcaSensitivityThresholds().

Here is the call graph for this function:

Set160MHzOperationSupported()

void ns3::VhtConfiguration::Set160MHzOperationSupported

(

bool

enable

)

Enable or disable 160 MHz operation support.

Parameters

enable

true if 20 MHz, 40 MHz, 80 MHz and 160 MHz operation is to be supported, false if 20 MHz, 40 MHz and 80 MHz operation is to be supported

Deprecated

"Deprecated in ns-3.44: " "Set the ChannelSettings of the WifiPhy instead"

Definition at line 72 of file vht-configuration.cc.

References m_160MHzSupported, and NS_LOG_FUNCTION.

SetSecondaryCcaSensitivityThresholds()

void ns3::VhtConfiguration::SetSecondaryCcaSensitivityThresholds

(

const SecondaryCcaSensitivityThresholds &

thresholds

)

Sets the CCA sensitivity thresholds for PPDUs that do not occupy the primary channel.

The thresholds are defined as a tuple {threshold for 20MHz PPDUs, threshold for 40MHz PPDUs, threshold for 80MHz PPDUs}.

Parameters

thresholds

the CCA sensitivity thresholds

Definition at line 85 of file vht-configuration.cc.

References m_secondaryCcaSensitivityThresholds, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

m_160MHzSupported

bool ns3::VhtConfiguration::m_160MHzSupported

whether 160 MHz operation is supported

Definition at line 81 of file vht-configuration.h.

Referenced by Get160MHzOperationSupported(), GetTypeId(), and Set160MHzOperationSupported().

m_secondaryCcaSensitivityThresholds

std::map<MHz_u, dBm_u> ns3::VhtConfiguration::m_secondaryCcaSensitivityThresholds

private

CCA sensitivity thresholds for signals that do not occupy the primary channel, indexed by signal bandwidth.

Definition at line 85 of file vht-configuration.h.

Referenced by GetSecondaryCcaSensitivityThresholds(), GetSecondaryCcaSensitivityThresholdsPerBw(), and SetSecondaryCcaSensitivityThresholds().

---

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

• src/wifi/model/vht/vht-configuration.h
• src/wifi/model/vht/vht-configuration.cc