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

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

#include "ht-configuration.h"

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

Public Member Functions

 HtConfiguration ()
 
virtual ~HtConfiguration ()
 
bool GetLdpcSupported (void) const
 
bool GetShortGuardIntervalSupported (void) const
 
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<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...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
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

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

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

◆ GetLdpcSupported()

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

Definition at line 86 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 73 of file ht-configuration.cc.

References m_sgiSupported.

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

+ Here is the caller graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

References GetLdpcSupported(), GetShortGuardIntervalSupported(), ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), SetLdpcSupported(), ns3::TypeId::SetParent(), and SetShortGuardIntervalSupported().

+ Here is the call 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 79 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 66 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_ldpcSupported

bool ns3::HtConfiguration::m_ldpcSupported
private

flag whether LDPC coding is supported

Definition at line 80 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 79 of file ht-configuration.h.

Referenced by GetShortGuardIntervalSupported(), and SetShortGuardIntervalSupported().


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