Implement the header for management frames of type probe request. More...

#include "mgt-headers.h"

Inheritance diagram for ns3::MgtProbeRequestHeader:

Collaboration diagram for ns3::MgtProbeRequestHeader:

Public Member Functions
	~MgtProbeRequestHeader () override

uint32_t	Deserialize (Buffer::Iterator start) override

const std::optional< EhtCapabilities > &	GetEhtCapabilities () const
	Return the EHT capabilities, if present. More...

const std::optional< ExtendedCapabilities > &	GetExtendedCapabilities () const
	Return the extended capabilities, if present. More...

const std::optional< HeCapabilities > &	GetHeCapabilities () const
	Return the HE capabilities, if present. More...

const std::optional< HtCapabilities > &	GetHtCapabilities () const
	Return the HT capabilities, if present. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

uint32_t	GetSerializedSize () const override

const Ssid &	GetSsid () const
	Return the Service Set Identifier (SSID). More...

const SupportedRates &	GetSupportedRates () const
	Return the supported rates. More...

const std::optional< VhtCapabilities > &	GetVhtCapabilities () const
	Return the VHT capabilities, if present. More...

void	Print (std::ostream &os) const override

void	Serialize (Buffer::Iterator start) const override

void	SetEhtCapabilities (const EhtCapabilities &ehtCapabilities)
	Set the EHT capabilities. More...

void	SetEhtCapabilities (EhtCapabilities &&ehtCapabilities)
	Set the EHT capabilities. More...

void	SetExtendedCapabilities (const ExtendedCapabilities &extendedCapabilities)
	Set the extended capabilities. More...

void	SetExtendedCapabilities (ExtendedCapabilities &&extendedCapabilities)
	Set the extended capabilities. More...

void	SetHeCapabilities (const HeCapabilities &heCapabilities)
	Set the HE capabilities. More...

void	SetHeCapabilities (HeCapabilities &&heCapabilities)
	Set the HE capabilities. More...

void	SetHtCapabilities (const HtCapabilities &htCapabilities)
	Set the HT capabilities. More...

void	SetHtCapabilities (HtCapabilities &&htCapabilities)
	Set the HT capabilities. More...

void	SetSsid (const Ssid &ssid)
	Set the Service Set Identifier (SSID). More...

void	SetSsid (Ssid &&ssid)
	Set the Service Set Identifier (SSID). More...

void	SetSupportedRates (const SupportedRates &rates)
	Set the supported rates. More...

void	SetSupportedRates (SupportedRates &&rates)
	Set the supported rates. More...

void	SetVhtCapabilities (const VhtCapabilities &vhtCapabilities)
	Set the VHT capabilities. More...

void	SetVhtCapabilities (VhtCapabilities &&vhtCapabilities)
	Set the VHT capabilities. More...

Public Member Functions inherited from ns3::Header
	~Header () override

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator. More...

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. More...

Public Member Functions inherited from ns3::Chunk
virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator. 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 errors. 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 ()
	Register this type. More...

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Private Attributes
std::optional< EhtCapabilities >	m_ehtCapability
	EHT capabilities. More...

std::optional< ExtendedCapabilities >	m_extendedCapability
	extended capabilities More...

std::optional< HeCapabilities >	m_heCapability
	HE capabilities. More...

std::optional< HtCapabilities >	m_htCapability
	HT capabilities. More...

SupportedRates	m_rates
	List of supported rates. More...

Ssid	m_ssid
	Service Set ID (SSID) More...

std::optional< VhtCapabilities >	m_vhtCapability
	VHT capabilities. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Implement the header for management frames of type probe request.

Introspection did not find any typical Config paths.

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

Definition at line 753 of file mgt-headers.h.

Constructor & Destructor Documentation

◆ ~MgtProbeRequestHeader()

ns3::MgtProbeRequestHeader::~MgtProbeRequestHeader ( )

override

Definition at line 36 of file mgt-headers.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::MgtProbeRequestHeader::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an iterator which points to where the header should read from.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 275 of file mgt-headers.cc.

References ns3::WifiInformationElement::Deserialize(), ns3::WifiInformationElement::DeserializeIfPresent(), ns3::SupportedRates::extended, ns3::Buffer::Iterator::GetDistanceFrom(), ns3::SupportedRates::IsSupportedRate(), m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, m_vhtCapability, and two-ray-to-three-gpp-ch-calibration::start.

Here is the call graph for this function:

◆ GetEhtCapabilities()

const std::optional< EhtCapabilities > & ns3::MgtProbeRequestHeader::GetEhtCapabilities ( ) const

Return the EHT capabilities, if present.

Returns: EHT capabilities, if present

Definition at line 155 of file mgt-headers.cc.

References m_ehtCapability.

◆ GetExtendedCapabilities()

const std::optional< ExtendedCapabilities > & ns3::MgtProbeRequestHeader::GetExtendedCapabilities ( ) const

Return the extended capabilities, if present.

Returns: the extended capabilities, if present

Definition at line 83 of file mgt-headers.cc.

References m_extendedCapability.

◆ GetHeCapabilities()

const std::optional< HeCapabilities > & ns3::MgtProbeRequestHeader::GetHeCapabilities ( ) const

Return the HE capabilities, if present.

Returns: HE capabilities, if present

Definition at line 137 of file mgt-headers.cc.

References m_heCapability.

◆ GetHtCapabilities()

const std::optional< HtCapabilities > & ns3::MgtProbeRequestHeader::GetHtCapabilities ( ) const

Return the HT capabilities, if present.

Returns: HT capabilities, if present

Definition at line 101 of file mgt-headers.cc.

References m_htCapability.

◆ GetInstanceTypeId()

TypeId ns3::MgtProbeRequestHeader::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 210 of file mgt-headers.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::MgtProbeRequestHeader::GetSerializedSize ( ) const

overridevirtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 167 of file mgt-headers.cc.

References ns3::SupportedRates::extended, ns3::SupportedRates::GetNRates(), ns3::WifiInformationElement::GetSerializedSize(), m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, and m_vhtCapability.

Here is the call graph for this function:

◆ GetSsid()

const Ssid & ns3::MgtProbeRequestHeader::GetSsid ( ) const

Return the Service Set Identifier (SSID).

Returns: SSID

Definition at line 53 of file mgt-headers.cc.

References m_ssid.

Referenced by ns3::ApWifiMac::Receive().

Here is the caller graph for this function:

◆ GetSupportedRates()

const SupportedRates & ns3::MgtProbeRequestHeader::GetSupportedRates ( ) const

Return the supported rates.

Returns: the supported rates

Definition at line 161 of file mgt-headers.cc.

References m_rates.

◆ GetTypeId()

TypeId ns3::MgtProbeRequestHeader::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 200 of file mgt-headers.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVhtCapabilities()

const std::optional< VhtCapabilities > & ns3::MgtProbeRequestHeader::GetVhtCapabilities ( ) const

Return the VHT capabilities, if present.

Returns: VHT capabilities, if present

Definition at line 119 of file mgt-headers.cc.

References m_vhtCapability.

◆ Print()

void ns3::MgtProbeRequestHeader::Print ( std::ostream & os ) const

overridevirtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 216 of file mgt-headers.cc.

References m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, and m_vhtCapability.

◆ Serialize()

void ns3::MgtProbeRequestHeader::Serialize ( Buffer::Iterator start ) const

overridevirtual

Parameters

start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 243 of file mgt-headers.cc.

References ns3::SupportedRates::extended, ns3::SupportedRates::GetNRates(), m_ehtCapability, m_extendedCapability, m_heCapability, m_htCapability, m_rates, m_ssid, m_vhtCapability, ns3::WifiInformationElement::Serialize(), and two-ray-to-three-gpp-ch-calibration::start.

Here is the call graph for this function:

◆ SetEhtCapabilities() [1/2]

void ns3::MgtProbeRequestHeader::SetEhtCapabilities ( const EhtCapabilities & ehtCapabilities )

Set the EHT capabilities.

Parameters

ehtCapabilities EHT capabilities

Definition at line 143 of file mgt-headers.cc.

References m_ehtCapability.

Referenced by ns3::StaWifiMac::SendProbeRequest().

Here is the caller graph for this function:

◆ SetEhtCapabilities() [2/2]

void ns3::MgtProbeRequestHeader::SetEhtCapabilities ( EhtCapabilities && ehtCapabilities )

Set the EHT capabilities.

Parameters

ehtCapabilities EHT capabilities

Definition at line 149 of file mgt-headers.cc.

References m_ehtCapability.

◆ SetExtendedCapabilities() [1/2]

void ns3::MgtProbeRequestHeader::SetExtendedCapabilities ( const ExtendedCapabilities & extendedCapabilities )

Set the extended capabilities.

Parameters

extendedCapabilities the extended capabilities

Definition at line 71 of file mgt-headers.cc.

References m_extendedCapability.

Referenced by ns3::StaWifiMac::SendProbeRequest().

Here is the caller graph for this function:

◆ SetExtendedCapabilities() [2/2]

void ns3::MgtProbeRequestHeader::SetExtendedCapabilities ( ExtendedCapabilities && extendedCapabilities )

Set the extended capabilities.

Parameters

extendedCapabilities the extended capabilities

Definition at line 77 of file mgt-headers.cc.

References m_extendedCapability.

◆ SetHeCapabilities() [1/2]

void ns3::MgtProbeRequestHeader::SetHeCapabilities ( const HeCapabilities & heCapabilities )

Set the HE capabilities.

Parameters

heCapabilities HE capabilities

Definition at line 125 of file mgt-headers.cc.

References m_heCapability.

Referenced by ns3::StaWifiMac::SendProbeRequest().

Here is the caller graph for this function:

◆ SetHeCapabilities() [2/2]

void ns3::MgtProbeRequestHeader::SetHeCapabilities ( HeCapabilities && heCapabilities )

Set the HE capabilities.

Parameters

heCapabilities HE capabilities

Definition at line 131 of file mgt-headers.cc.

References m_heCapability.

◆ SetHtCapabilities() [1/2]

void ns3::MgtProbeRequestHeader::SetHtCapabilities ( const HtCapabilities & htCapabilities )

Set the HT capabilities.

Parameters

htCapabilities HT capabilities

Definition at line 89 of file mgt-headers.cc.

References m_htCapability.

Referenced by ns3::StaWifiMac::SendProbeRequest().

Here is the caller graph for this function:

◆ SetHtCapabilities() [2/2]

void ns3::MgtProbeRequestHeader::SetHtCapabilities ( HtCapabilities && htCapabilities )

Set the HT capabilities.

Parameters

htCapabilities HT capabilities

Definition at line 95 of file mgt-headers.cc.

References m_htCapability.

◆ SetSsid() [1/2]

void ns3::MgtProbeRequestHeader::SetSsid ( const Ssid & ssid )

Set the Service Set Identifier (SSID).

Parameters

ssid SSID

Definition at line 41 of file mgt-headers.cc.

References m_ssid, and third::ssid.

Referenced by ns3::StaWifiMac::SendProbeRequest().

Here is the caller graph for this function:

◆ SetSsid() [2/2]

void ns3::MgtProbeRequestHeader::SetSsid ( Ssid && ssid )

Set the Service Set Identifier (SSID).

Parameters

ssid SSID

Definition at line 47 of file mgt-headers.cc.

References m_ssid, and third::ssid.

◆ SetSupportedRates() [1/2]

void ns3::MgtProbeRequestHeader::SetSupportedRates ( const SupportedRates & rates )

Set the supported rates.

Parameters

rates the supported rates

Definition at line 59 of file mgt-headers.cc.

References m_rates.

Referenced by ns3::StaWifiMac::SendProbeRequest().

Here is the caller graph for this function:

◆ SetSupportedRates() [2/2]

void ns3::MgtProbeRequestHeader::SetSupportedRates ( SupportedRates && rates )

Set the supported rates.

Parameters

rates the supported rates

Definition at line 65 of file mgt-headers.cc.

References m_rates.

◆ SetVhtCapabilities() [1/2]

void ns3::MgtProbeRequestHeader::SetVhtCapabilities ( const VhtCapabilities & vhtCapabilities )

Set the VHT capabilities.

Parameters

vhtCapabilities VHT capabilities

Definition at line 107 of file mgt-headers.cc.

References m_vhtCapability.

Referenced by ns3::StaWifiMac::SendProbeRequest().

Here is the caller graph for this function:

◆ SetVhtCapabilities() [2/2]

void ns3::MgtProbeRequestHeader::SetVhtCapabilities ( VhtCapabilities && vhtCapabilities )

Set the VHT capabilities.

Parameters

vhtCapabilities VHT capabilities

Definition at line 113 of file mgt-headers.cc.

References m_vhtCapability.

Member Data Documentation

◆ m_ehtCapability

std::optional<EhtCapabilities> ns3::MgtProbeRequestHeader::m_ehtCapability

private

EHT capabilities.

Definition at line 895 of file mgt-headers.h.

Referenced by Deserialize(), GetEhtCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetEhtCapabilities().

◆ m_extendedCapability

std::optional<ExtendedCapabilities> ns3::MgtProbeRequestHeader::m_extendedCapability

private

extended capabilities

Definition at line 891 of file mgt-headers.h.

Referenced by Deserialize(), GetExtendedCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetExtendedCapabilities().

◆ m_heCapability

std::optional<HeCapabilities> ns3::MgtProbeRequestHeader::m_heCapability

private

HE capabilities.

Definition at line 894 of file mgt-headers.h.

Referenced by Deserialize(), GetHeCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetHeCapabilities().

◆ m_htCapability

std::optional<HtCapabilities> ns3::MgtProbeRequestHeader::m_htCapability

private

HT capabilities.

Definition at line 892 of file mgt-headers.h.

Referenced by Deserialize(), GetHtCapabilities(), GetSerializedSize(), Print(), Serialize(), and SetHtCapabilities().

◆ m_rates

SupportedRates ns3::MgtProbeRequestHeader::m_rates

private

List of supported rates.

Definition at line 890 of file mgt-headers.h.

Referenced by Deserialize(), GetSerializedSize(), GetSupportedRates(), Print(), Serialize(), and SetSupportedRates().

◆ m_ssid

Ssid ns3::MgtProbeRequestHeader::m_ssid

private

Service Set ID (SSID)

Definition at line 889 of file mgt-headers.h.

Referenced by Deserialize(), GetSerializedSize(), GetSsid(), Print(), Serialize(), and SetSsid().

◆ m_vhtCapability

std::optional<VhtCapabilities> ns3::MgtProbeRequestHeader::m_vhtCapability

private

VHT capabilities.

Definition at line 893 of file mgt-headers.h.

Referenced by Deserialize(), GetSerializedSize(), GetVhtCapabilities(), Print(), Serialize(), and SetVhtCapabilities().

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

src/wifi/model/mgt-headers.h
src/wifi/model/mgt-headers.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~MgtProbeRequestHeader()

Member Function Documentation

◆ Deserialize()

◆ GetEhtCapabilities()

◆ GetExtendedCapabilities()

◆ GetHeCapabilities()

◆ GetHtCapabilities()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetSsid()

◆ GetSupportedRates()

◆ GetTypeId()

◆ GetVhtCapabilities()

◆ Print()

◆ Serialize()

◆ SetEhtCapabilities() [1/2]

◆ SetEhtCapabilities() [2/2]

◆ SetExtendedCapabilities() [1/2]

◆ SetExtendedCapabilities() [2/2]

◆ SetHeCapabilities() [1/2]

◆ SetHeCapabilities() [2/2]

◆ SetHtCapabilities() [1/2]

◆ SetHtCapabilities() [2/2]

◆ SetSsid() [1/2]

◆ SetSsid() [2/2]

◆ SetSupportedRates() [1/2]

◆ SetSupportedRates() [2/2]

◆ SetVhtCapabilities() [1/2]

◆ SetVhtCapabilities() [2/2]

Member Data Documentation

◆ m_ehtCapability

◆ m_extendedCapability

◆ m_heCapability

◆ m_htCapability

◆ m_rates

◆ m_ssid

◆ m_vhtCapability