A Discrete-Event Network Simulator
API
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 information (i.e., the body of the IE, not including the Element ID and length octets) More...
 
WifiInformationElementId ElementId () const
 Own unique Element ID. More...
 
uint8_t GetCurrentChannel (void) const
 
uint8_t GetInformationFieldSize () const
 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
 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 (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)
 
- 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 ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. 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
 
bool m_dsssSupported
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< WifiInformationElement >
static void Cleanup (void)
 Noop. More...
 

Detailed Description

The DSSS Parameter Set

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

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

Constructor & Destructor Documentation

ns3::DsssParameterSet::DsssParameterSet ( )

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

Member Function Documentation

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

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

Parameters
startan iterator which points to where the information should be written.
length
Returns
the number of bytes read

Implements ns3::WifiInformationElement.

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

Own unique Element ID.

Implements ns3::WifiInformationElement.

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

References IE_DS_PARAMETER_SET.

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

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

References m_currentChannel.

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

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 61 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 78 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 68 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 (i.e., the body of the IE, not including the Element ID and length octets)

Parameters
startan iterator which points to where the information should be written.

Implements ns3::WifiInformationElement.

Definition at line 88 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
qosInfothe CurrentChannel field in the DsssParameterSet information element

Definition at line 49 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)

Definition at line 43 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
bool ns3::DsssParameterSet::m_dsssSupported
private

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