ns3::DsssParameterSet Class Reference

The DSSS Parameter SetThis class knows how to serialise and deserialise 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)
	Deserialize infornamtion field function. More...
WifiInformationElementId	ElementId () const
	Element ID function. More...
uint8_t	GetCurrentChannel (void) const
	Return the Current Channel field in the DsssParameterSet information element. More...
uint8_t	GetInformationFieldSize () const
	Get information field size function. More...
uint16_t	GetSerializedSize () const
	Return the serialized size of this DSSS Parameter Set. More...
Buffer::Iterator	Serialize (Buffer::Iterator start) const
	This information element is a bit special in that it is only included if the STA does support DSSS. More...
void	SerializeInformationField (Buffer::Iterator start) const
	Serialize information field function. 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...
uint16_t	GetSerializedSize () const
	Get the size of the serialized IE including Element ID and length fields. More...
virtual bool	operator< (WifiInformationElement const &a) const
	Compare information elements using Element ID. More...
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...
Buffer::Iterator	Serialize (Buffer::Iterator i) const
	Serialize entire IE including Element ID and length fields. More...
Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
	SimpleRefCount ()
	Default constructor. More...
	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...
uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...
SimpleRefCount &	operator= (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

ns3::DsssParameterSet::DsssParameterSet

(

)

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

Member Function Documentation

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

virtual

Deserialize infornamtion field function.

Parameters

start	the iterator
length	the length

Returns

the updated iterator

Implements ns3::WifiInformationElement.

Definition at line 92 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:

WifiInformationElementId ns3::DsssParameterSet::ElementId ( ) const

virtual

Element ID function.

Returns

the wifi information element ID

Implements ns3::WifiInformationElement.

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

References IE_DSSS_PARAMETER_SET.

uint8_t ns3::DsssParameterSet::GetCurrentChannel

(

void

)

const

Return the Current Channel field in the DsssParameterSet information element.

Returns

the Current Channel field in the DsssParameterSet information element

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

References m_currentChannel.

uint8_t ns3::DsssParameterSet::GetInformationFieldSize ( void  ) const

virtual

Get information field size function.

Returns

the information field size

Implements ns3::WifiInformationElement.

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

References m_dsssSupported, and NS_ASSERT.

uint16_t ns3::DsssParameterSet::GetSerializedSize

(

void

)

const

Return the serialized size of this DSSS Parameter Set.

Returns

the serialized size of this DSSS Parameter Set

Definition at line 73 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:

Buffer::Iterator ns3::DsssParameterSet::Serialize

(

Buffer::Iterator

start

)

const

This information element is a bit special in that it is only included if the STA does support DSSS.

To support this we override the Serialize and GetSerializedSize methods of WifiInformationElement.

Parameters

start

Returns

an iterator

Definition at line 63 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:

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

virtual

Serialize information field function.

Parameters

start

the iterator

Returns

the updated iterator

Implements ns3::WifiInformationElement.

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

References m_currentChannel, m_dsssSupported, and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

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:

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

uint8_t ns3::DsssParameterSet::m_currentChannel

private

current channel number

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

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

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 105 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/dsss-parameter-set.h
• src/wifi/model/dsss-parameter-set.cc