The DSSS Parameter Set. More...

#include "dsss-parameter-set.h"

Inheritance diagram for ns3::DsssParameterSet:

Collaboration diagram for ns3::DsssParameterSet:

Public Member Functions
	DsssParameterSet ()

uint8_t	DeserializeInformationField (Buffer::Iterator start, uint8_t length) override
	Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) More...

WifiInformationElementId	ElementId () const override

uint8_t	GetInformationFieldSize () const override
	Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets. More...

uint16_t	GetSerializedSize () const override
	Get the size of the serialized IE including Element ID and length fields. More...

Buffer::Iterator	Serialize (Buffer::Iterator start) const override
	Serialize entire IE including Element ID and length fields. More...

void	SerializeInformationField (Buffer::Iterator start) const override
	Serialize information (i.e., the body of the IE, not including the Element ID and length octets) More...

void	SetCurrentChannel (uint8_t currentChannel)
	Set the Current Channel field in the DsssParameterSet information element. More...

void	SetDsssSupported (uint8_t dsssSupported)
	Set DSSS supported. More...

Public Member Functions inherited from ns3::WifiInformationElement
virtual	~WifiInformationElement ()

Buffer::Iterator	Deserialize (Buffer::Iterator i)
	Deserialize entire IE, which must be present. More...

Buffer::Iterator	DeserializeIfPresent (Buffer::Iterator i)
	Deserialize entire IE if it is present. More...

virtual WifiInformationElementId	ElementIdExt () const

virtual bool	operator== (WifiInformationElement const &a) const
	Compare two IEs for equality by ID & Length, and then through memcmp of serialised version. More...

virtual void	Print (std::ostream &os) const
	Generate human-readable form of IE. More...

Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Private Attributes
uint8_t	m_currentChannel
	current channel number More...

bool	m_dsssSupported
	This is used to decide whether this element should be added to the frame or not. More...

Detailed Description

The DSSS Parameter Set.

This class knows how to serialise and deserialise the DSSS Parameter Set.

Definition at line 34 of file dsss-parameter-set.h.

Constructor & Destructor Documentation

◆ DsssParameterSet()

ns3::DsssParameterSet::DsssParameterSet ( )

Definition at line 25 of file dsss-parameter-set.cc.

Member Function Documentation

◆ DeserializeInformationField()

uint8_t ns3::DsssParameterSet::DeserializeInformationField	(	Buffer::Iterator	start,
		uint8_t	length
	)

overridevirtual

Deserialize information (i.e., the body of the IE, not including the Element ID and length octets)

Parameters

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

Returns: the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 86 of file dsss-parameter-set.cc.

References m_currentChannel, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Here is the call graph for this function:

◆ ElementId()

WifiInformationElementId ns3::DsssParameterSet::ElementId ( ) const

overridevirtual

Returns: Own unique Element ID

Implements ns3::WifiInformationElement.

Definition at line 32 of file dsss-parameter-set.cc.

References IE_DSSS_PARAMETER_SET.

◆ GetInformationFieldSize()

uint8_t ns3::DsssParameterSet::GetInformationFieldSize ( ) const

overridevirtual

Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets.

This is the value that will appear in the second octet of the entire IE - the length field)

Returns: the length of serialized information

Implements ns3::WifiInformationElement.

Definition at line 50 of file dsss-parameter-set.cc.

References m_dsssSupported, and NS_ASSERT.

◆ GetSerializedSize()

uint16_t ns3::DsssParameterSet::GetSerializedSize ( void ) const

overridevirtual

Get the size of the serialized IE including Element ID and length fields.

Returns: the size of the serialized IE in bytes

Reimplemented from ns3::WifiInformationElement.

Definition at line 67 of file dsss-parameter-set.cc.

References ns3::WifiInformationElement::GetSerializedSize(), and m_dsssSupported.

Referenced by ns3::MgtProbeResponseHeader::GetSerializedSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Serialize()

Buffer::Iterator ns3::DsssParameterSet::Serialize ( Buffer::Iterator i ) const

overridevirtual

Serialize entire IE including Element ID and length fields.

Parameters

i	an iterator which points to where the IE should be written.

Returns: an iterator

Reimplemented from ns3::WifiInformationElement.

Definition at line 57 of file dsss-parameter-set.cc.

References m_dsssSupported, and ns3::WifiInformationElement::Serialize().

Referenced by ns3::MgtProbeResponseHeader::Serialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SerializeInformationField()

void ns3::DsssParameterSet::SerializeInformationField ( Buffer::Iterator start ) const

overridevirtual

Serialize information (i.e., the body of the IE, not including the Element ID and length octets)

Parameters

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

Implements ns3::WifiInformationElement.

Definition at line 77 of file dsss-parameter-set.cc.

References m_currentChannel, m_dsssSupported, and visualizer.core::start().

Here is the call graph for this function:

◆ SetCurrentChannel()

void ns3::DsssParameterSet::SetCurrentChannel ( uint8_t currentChannel )

Set the Current Channel field in the DsssParameterSet information element.

Parameters

currentChannel the CurrentChannel field in the DsssParameterSet information element

Definition at line 44 of file dsss-parameter-set.cc.

References m_currentChannel.

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

Here is the caller graph for this function:

◆ SetDsssSupported()

void ns3::DsssParameterSet::SetDsssSupported ( uint8_t dsssSupported )

Set DSSS supported.

Parameters

dsssSupported the DSSS supported indicator

Definition at line 38 of file dsss-parameter-set.cc.

References m_dsssSupported.

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

Here is the caller graph for this function:

Member Data Documentation

◆ m_currentChannel

uint8_t ns3::DsssParameterSet::m_currentChannel

private

current channel number

Definition at line 66 of file dsss-parameter-set.h.

Referenced by DeserializeInformationField(), SerializeInformationField(), and SetCurrentChannel().

◆ m_dsssSupported

bool ns3::DsssParameterSet::m_dsssSupported

private

This is used to decide whether this element should be added to the frame or not.

Definition at line 69 of file dsss-parameter-set.h.

Referenced by GetInformationFieldSize(), GetSerializedSize(), Serialize(), SerializeInformationField(), and SetDsssSupported().

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

src/wifi/model/non-ht/dsss-parameter-set.h
src/wifi/model/non-ht/dsss-parameter-set.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DsssParameterSet()

Member Function Documentation

◆ DeserializeInformationField()

◆ ElementId()

◆ GetInformationFieldSize()

◆ GetSerializedSize()

◆ Serialize()

◆ SerializeInformationField()

◆ SetCurrentChannel()

◆ SetDsssSupported()

Member Data Documentation

◆ m_currentChannel

◆ m_dsssSupported