A Discrete-Event Network Simulator
API
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 = std::tuple< double, double, double >
 Tuple identifying CCA sensitivity thresholds for secondary channels. More...
 

Public Member Functions

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

bool m_160MHzSupported
 whether 160 MHz operation is supported More...
 
std::map< uint16_t, doublem_secondaryCcaSensitivityThresholds
 CCA sensitivity thresholds for signals that do not occupy the primary channel, indexed by signal bandwidth (MHz) 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

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

  • Support160MHzOperation: Whether or not 160 MHz operation is to be supported.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
  • 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

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

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

Member Typedef Documentation

◆ SecondaryCcaSensitivityThresholds

Tuple identifying CCA sensitivity thresholds for secondary channels.

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

Constructor & Destructor Documentation

◆ VhtConfiguration()

ns3::VhtConfiguration::VhtConfiguration ( )

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

References NS_LOG_FUNCTION.

◆ ~VhtConfiguration()

ns3::VhtConfiguration::~VhtConfiguration ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Get160MHzOperationSupported()

bool ns3::VhtConfiguration::Get160MHzOperationSupported ( void  ) 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

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

References m_160MHzSupported.

Referenced by ns3::WifiPhy::DoChannelSwitch(), GetTypeId(), and ns3::WifiMac::GetVhtCapabilities().

+ Here is the caller graph for this function:

◆ GetSecondaryCcaSensitivityThresholds()

VhtConfiguration::SecondaryCcaSensitivityThresholds ns3::VhtConfiguration::GetSecondaryCcaSensitivityThresholds ( void  ) const
Returns
the CCA sensitivity thresholds for PPDUs that do not occupy the primary channel

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

References m_secondaryCcaSensitivityThresholds.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetSecondaryCcaSensitivityThresholdsPerBw()

const std::map< uint16_t, double > & ns3::VhtConfiguration::GetSecondaryCcaSensitivityThresholdsPerBw ( void  ) const
Returns
the CCA sensitivity thresholds for PPDUs that do not occupy the primary channel, indexed by signal bandwidth (MHz)

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

References m_secondaryCcaSensitivityThresholds.

◆ GetTypeId()

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

◆ Set160MHzOperationSupported()

void ns3::VhtConfiguration::Set160MHzOperationSupported ( bool  enable)

Enable or disable 160 MHz operation support.

Parameters
enabletrue 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

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

References m_160MHzSupported, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this 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
thresholdsthe CCA sensitivity thresholds

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

References m_secondaryCcaSensitivityThresholds, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and WifiPhyCcaThresholdsTest::RunOne().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_160MHzSupported

bool ns3::VhtConfiguration::m_160MHzSupported
private

whether 160 MHz operation is supported

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

Referenced by Get160MHzOperationSupported(), and Set160MHzOperationSupported().

◆ m_secondaryCcaSensitivityThresholds

std::map<uint16_t, double> ns3::VhtConfiguration::m_secondaryCcaSensitivityThresholds
private

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

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

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


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