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

HT configuration. More...

#include "ht-configuration.h"

+ Inheritance diagram for ns3::HtConfiguration:
+ Collaboration diagram for ns3::HtConfiguration:

Public Member Functions

 HtConfiguration ()
 
virtual ~HtConfiguration ()
 
bool Get40MHzOperationSupported (void) const
 
bool GetLdpcSupported (void) const
 
bool GetShortGuardIntervalSupported (void) const
 
void Set40MHzOperationSupported (bool enable)
 Enable or disable 40 MHz operation support. More...
 
void SetLdpcSupported (bool enable)
 Enable or disable LDPC support. More...
 
void SetShortGuardIntervalSupported (bool enable)
 Enable or disable SGI support. 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_40MHzSupported
 whether 40 MHz operation is supported More...
 
bool m_ldpcSupported
 flag whether LDPC coding is supported More...
 
bool m_sgiSupported
 flag whether short guard interval is supported 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

HT configuration.

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

Config Paths

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

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

Attributes

  • ShortGuardIntervalSupported: Whether or not short guard interval is supported.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • LdpcSupported: Whether or not LDPC coding is supported.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read
  • Support40MHzOperation: Whether or not 40 MHz operation is to be supported.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

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

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

Constructor & Destructor Documentation

◆ HtConfiguration()

ns3::HtConfiguration::HtConfiguration ( )

Definition at line 32 of file ht-configuration.cc.

References NS_LOG_FUNCTION.

◆ ~HtConfiguration()

ns3::HtConfiguration::~HtConfiguration ( )
virtual

Definition at line 37 of file ht-configuration.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Get40MHzOperationSupported()

bool ns3::HtConfiguration::Get40MHzOperationSupported ( void  ) const
Returns
true if both 20 MHz and 40 MHz operation is supported, false if only 20 MHz operation is supported

Definition at line 105 of file ht-configuration.cc.

References m_40MHzSupported.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetLdpcSupported()

bool ns3::HtConfiguration::GetLdpcSupported ( void  ) const
Returns
whether the device supports LDPC.
true if LDPC is supported, false otherwise.

Definition at line 92 of file ht-configuration.cc.

References m_ldpcSupported.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetShortGuardIntervalSupported()

bool ns3::HtConfiguration::GetShortGuardIntervalSupported ( void  ) const
Returns
whether the device supports SGI.
true if SGI is supported, false otherwise.

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

References m_sgiSupported.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

◆ Set40MHzOperationSupported()

void ns3::HtConfiguration::Set40MHzOperationSupported ( bool  enable)

Enable or disable 40 MHz operation support.

Parameters
enabletrue if both 20 MHz and 40 MHz operation is to be supported, false if only 20 MHz operation is to be supported

Definition at line 98 of file ht-configuration.cc.

References m_40MHzSupported, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetLdpcSupported()

void ns3::HtConfiguration::SetLdpcSupported ( bool  enable)

Enable or disable LDPC support.

Parameters
enabletrue if LDPC is to be supported, false otherwise

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

References m_ldpcSupported, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetShortGuardIntervalSupported()

void ns3::HtConfiguration::SetShortGuardIntervalSupported ( bool  enable)

Enable or disable SGI support.

Parameters
enabletrue if SGI is to be supported, false otherwise

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

References m_sgiSupported, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_40MHzSupported

bool ns3::HtConfiguration::m_40MHzSupported
private

whether 40 MHz operation is supported

Definition at line 93 of file ht-configuration.h.

Referenced by Get40MHzOperationSupported(), and Set40MHzOperationSupported().

◆ m_ldpcSupported

bool ns3::HtConfiguration::m_ldpcSupported
private

flag whether LDPC coding is supported

Definition at line 92 of file ht-configuration.h.

Referenced by GetLdpcSupported(), and SetLdpcSupported().

◆ m_sgiSupported

bool ns3::HtConfiguration::m_sgiSupported
private

flag whether short guard interval is supported

Definition at line 91 of file ht-configuration.h.

Referenced by GetShortGuardIntervalSupported(), and SetShortGuardIntervalSupported().


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