The DSSS Parameter Set. More...

#include "dsss-parameter-set.h"

Inheritance diagram for ns3::DsssParameterSet:

Collaboration diagram for ns3::DsssParameterSet:

Public Member Functions
	DsssParameterSet ()

WifiInformationElementId	ElementId () const override
	Get the wifi information element ID.

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

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

Buffer::Iterator	Deserialize (Buffer::Iterator i)
	Deserialize entire IE (which may possibly be fragmented into multiple elements), which must be present.

Buffer::Iterator	DeserializeIfPresent (Buffer::Iterator i)
	Deserialize entire IE (which may possibly be fragmented into multiple elements) if it is present.

virtual WifiInformationElementId	ElementIdExt () const
	Get the wifi information element ID extension.

uint16_t	GetSerializedSize () const
	Get the size of the serialized IE including Element ID and length fields (for every element this IE is possibly fragmented into).

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

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

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

Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
	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.

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

uint16_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.

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

Private Attributes
uint8_t	m_currentChannel
	current channel number

Detailed Description

The DSSS Parameter Set.

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

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

Constructor & Destructor Documentation

◆ DsssParameterSet()

ns3::DsssParameterSet::DsssParameterSet ( )

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

Member Function Documentation

◆ DeserializeInformationField()

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

overrideprivatevirtual

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	the expected number of bytes to read

Returns: the number of bytes read

Implements ns3::WifiInformationElement.

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

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

Here is the call graph for this function:

◆ ElementId()

WifiInformationElementId ns3::DsssParameterSet::ElementId ( ) const

overridevirtual

Get the wifi information element ID.

Returns: the wifi information element ID

Implements ns3::WifiInformationElement.

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

References IE_DSSS_PARAMETER_SET.

◆ GetInformationFieldSize()

uint16_t ns3::DsssParameterSet::GetInformationFieldSize ( ) const

overrideprivatevirtual

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 - if the IE is not fragmented)

Returns: the length of serialized information

Implements ns3::WifiInformationElement.

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

◆ SerializeInformationField()

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

overrideprivatevirtual

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 38 of file dsss-parameter-set.cc.

References m_currentChannel.

◆ 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 26 of file dsss-parameter-set.cc.

References m_currentChannel.

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 43 of file dsss-parameter-set.h.

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

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 Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DsssParameterSet()

Member Function Documentation

◆ DeserializeInformationField()

◆ ElementId()

◆ GetInformationFieldSize()

◆ SerializeInformationField()

◆ SetCurrentChannel()

Member Data Documentation

◆ m_currentChannel