HT configuration. More...

#include "ht-configuration.h"

Inheritance diagram for ns3::HtConfiguration:

Collaboration diagram for ns3::HtConfiguration:

Public Member Functions
	HtConfiguration ()

	~HtConfiguration () override

bool	Get40MHzOperationSupported () const

bool	GetLdpcSupported () const

bool	GetShortGuardIntervalSupported () const

void	Set40MHzOperationSupported (bool enable)
	Enable or disable 40 MHz operation support.

void	SetLdpcSupported (bool enable)
	Enable or disable LDPC support.

void	SetShortGuardIntervalSupported (bool enable)
	Enable or disable SGI support.

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 override
	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) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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.

Private Attributes
bool	m_40MHzSupported
	whether 40 MHz operation is supported

bool	m_ldpcSupported
	flag whether LDPC coding is supported

bool	m_sgiSupported
	flag whether short guard interval is supported

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

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

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

No TraceSources are defined for this type.
Size of this type is 56 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 33 of file ht-configuration.cc.

References NS_LOG_FUNCTION.

◆ ~HtConfiguration()

ns3::HtConfiguration::~HtConfiguration ( )

override

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Get40MHzOperationSupported()

bool ns3::HtConfiguration::Get40MHzOperationSupported ( ) const

Returns: true if both 20 MHz and 40 MHz operation is supported, false if only 20 MHz operation is supported

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

References m_40MHzSupported.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetLdpcSupported()

bool ns3::HtConfiguration::GetLdpcSupported ( ) const

Returns: whether the device supports LDPC.; true if LDPC is supported, false otherwise.

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

References m_ldpcSupported.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetShortGuardIntervalSupported()

bool ns3::HtConfiguration::GetShortGuardIntervalSupported ( ) const

Returns: whether the device supports SGI.; true if SGI is supported, false otherwise.

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

References m_sgiSupported.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::HtConfiguration::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

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

Here is the call graph for this function:

◆ Set40MHzOperationSupported()

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

Enable or disable 40 MHz operation support.

Parameters

enable true 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 99 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

enable true if LDPC is to be supported, false otherwise

Definition at line 86 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

enable true if SGI is to be supported, false otherwise

Definition at line 73 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 92 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 91 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 90 of file ht-configuration.h.

Referenced by GetShortGuardIntervalSupported(), and SetShortGuardIntervalSupported().

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

src/wifi/model/ht/ht-configuration.h
src/wifi/model/ht/ht-configuration.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ HtConfiguration()

◆ ~HtConfiguration()

Member Function Documentation

◆ Get40MHzOperationSupported()

◆ GetLdpcSupported()

◆ GetShortGuardIntervalSupported()

◆ GetTypeId()

◆ Set40MHzOperationSupported()

◆ SetLdpcSupported()

◆ SetShortGuardIntervalSupported()

Member Data Documentation

◆ m_40MHzSupported

◆ m_ldpcSupported

◆ m_sgiSupported