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

HE configurationThis object stores HE configuration information, for use in modifying AP or STA behavior and for constructing HE-related information elements. More...

#include "he-configuration.h"

+ Inheritance diagram for ns3::HeConfiguration:
+ Collaboration diagram for ns3::HeConfiguration:

Public Member Functions

 HeConfiguration ()
 
Time GetGuardInterval (void) const
 
uint16_t GetMpduBufferSize (void) const
 
void SetGuardInterval (Time guardInterval)
 
void SetMpduBufferSize (uint16_t size)
 
- 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...
 
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...
 

Private Attributes

uint8_t m_bssColor
 BSS color. More...
 
Time m_guardInterval
 Supported HE guard interval. More...
 
uint16_t m_mpduBufferSize
 MPDU buffer size. 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

HE configuration

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


Config Paths

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

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

Attributes

  • GuardInterval: Specify the shortest guard interval duration that can be used for HE transmissions.Possible values are 800ns, 1600ns or 3200ns.
    • Set with class: ns3::TimeValue
    • Underlying type: Time +800.0ns:+3200.0ns
    • Initial value: +3200.0ns
    • Flags: construct write read
  • BssColor: The BSS color
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: construct write read
  • MpduBufferSize: The MPDU buffer size for receiving A-MPDUs
    • Set with class: ns3::UintegerValue
    • Underlying type: uint16_t 64:256
    • Initial value: 64
    • Flags: construct write read

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

Definition at line 36 of file he-configuration.h.

Constructor & Destructor Documentation

◆ HeConfiguration()

ns3::HeConfiguration::HeConfiguration ( )

Definition at line 30 of file he-configuration.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetGuardInterval()

Time ns3::HeConfiguration::GetGuardInterval ( void  ) const
Returns
the supported HE guard interval

Definition at line 73 of file he-configuration.cc.

References m_guardInterval.

Referenced by ns3::ConvertGuardIntervalToNanoSeconds(), and GetTypeId().

+ Here is the caller graph for this function:

◆ GetMpduBufferSize()

uint16_t ns3::HeConfiguration::GetMpduBufferSize ( void  ) const
Returns
the MPDU buffer size to receive A-MPDUs

Definition at line 86 of file he-configuration.cc.

References m_mpduBufferSize.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

◆ SetGuardInterval()

void ns3::HeConfiguration::SetGuardInterval ( Time  guardInterval)
Parameters
guardIntervalthe supported HE guard interval

Definition at line 65 of file he-configuration.cc.

References m_guardInterval, ns3::NanoSeconds(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetMpduBufferSize()

void ns3::HeConfiguration::SetMpduBufferSize ( uint16_t  size)
Parameters
sizethe MPDU buffer size to receive A-MPDUs

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

References m_mpduBufferSize, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_bssColor

uint8_t ns3::HeConfiguration::m_bssColor
private

BSS color.

Definition at line 67 of file he-configuration.h.

Referenced by GetTypeId().

◆ m_guardInterval

Time ns3::HeConfiguration::m_guardInterval
private

Supported HE guard interval.

Definition at line 66 of file he-configuration.h.

Referenced by GetGuardInterval(), and SetGuardInterval().

◆ m_mpduBufferSize

uint16_t ns3::HeConfiguration::m_mpduBufferSize
private

MPDU buffer size.

Definition at line 68 of file he-configuration.h.

Referenced by GetMpduBufferSize(), and SetMpduBufferSize().


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