A Discrete-Event Network Simulator
API
ns3::ErpInformation Class Reference

The ErpInformation Information Element. More...

#include "erp-information.h"

+ Inheritance diagram for ns3::ErpInformation:
+ Collaboration diagram for ns3::ErpInformation:

Public Member Functions

 ErpInformation ()
 
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
 Get the wifi information element ID. More...
 
uint8_t GetBarkerPreambleMode (void) const
 Return the Barker_Preamble_Mode field in the ErpInformation information element. More...
 
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...
 
uint8_t GetNonErpPresent (void) const
 Return the Non_Erp_Present field in the ErpInformation information element. More...
 
uint16_t GetSerializedSize () const override
 Get the size of the serialized IE including Element ID and length fields. More...
 
uint8_t GetUseProtection (void) const
 Return the Use_Protection field in the ErpInformation information element. 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 SetBarkerPreambleMode (uint8_t barkerPreambleMode)
 Set the Barker_Preamble_Mode field in the ErpInformation information element. More...
 
void SetErpSupported (uint8_t erpSupported)
 Set the ERP supported field. More...
 
void SetNonErpPresent (uint8_t nonErpPresent)
 Set the Non_Erp_Present field in the ErpInformation information element. More...
 
void SetUseProtection (uint8_t useProtection)
 Set the Use_Protection field in the ErpInformation information element. 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 uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length)=0
 Deserialize information (i.e., the body of the IE, not including the Element ID and length octets) More...
 
virtual WifiInformationElementId ElementId () const =0
 Get the wifi information element ID. More...
 
virtual WifiInformationElementId ElementIdExt () const
 Get the wifi information element ID extension. More...
 
virtual uint8_t GetInformationFieldSize () const =0
 Length of serialized information (i.e., the length of the body of the IE, not including the Element ID and length octets. More...
 
virtual 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 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...
 
virtual Buffer::Iterator Serialize (Buffer::Iterator i) const
 Serialize entire IE including Element ID and length fields. More...
 
virtual void SerializeInformationField (Buffer::Iterator start) const =0
 Serialize information (i.e., the body of the IE, not including the Element ID and length octets) 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...
 
SimpleRefCountoperator= (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_erpInformation
 ERP information. More...
 
bool m_erpSupported
 This is used to decide whether this element should be added to the frame or not. More...
 

Detailed Description

The ErpInformation Information Element.

This class knows how to serialise and deserialise the ErpInformation Information Element.

Definition at line 34 of file erp-information.h.

Constructor & Destructor Documentation

◆ ErpInformation()

ns3::ErpInformation::ErpInformation ( )

Definition at line 25 of file erp-information.cc.

Member Function Documentation

◆ DeserializeInformationField()

uint8_t ns3::ErpInformation::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
startan iterator which points to where the information should be written.
length
Returns
the number of bytes read

Implements ns3::WifiInformationElement.

Definition at line 116 of file erp-information.cc.

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

+ Here is the call graph for this function:

◆ ElementId()

WifiInformationElementId ns3::ErpInformation::ElementId ( ) const
overridevirtual

Get the wifi information element ID.

Returns
the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 32 of file erp-information.cc.

References IE_ERP_INFORMATION.

◆ GetBarkerPreambleMode()

uint8_t ns3::ErpInformation::GetBarkerPreambleMode ( void  ) const

Return the Barker_Preamble_Mode field in the ErpInformation information element.

Returns
the Barker_Preamble_Mode field in the ErpInformation information element

Definition at line 62 of file erp-information.cc.

References m_erpInformation.

Referenced by ns3::operator<<(), ns3::StaWifiMac::UpdateApInfoFromAssocResp(), ns3::StaWifiMac::UpdateApInfoFromBeacon(), and ns3::StaWifiMac::UpdateApInfoFromProbeResp().

+ Here is the caller graph for this function:

◆ GetInformationFieldSize()

uint8_t ns3::ErpInformation::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 80 of file erp-information.cc.

References m_erpSupported, and NS_ASSERT.

◆ GetNonErpPresent()

uint8_t ns3::ErpInformation::GetNonErpPresent ( void  ) const

Return the Non_Erp_Present field in the ErpInformation information element.

Returns
the Non_Erp_Present field in the ErpInformation information element

Definition at line 74 of file erp-information.cc.

References m_erpInformation.

Referenced by ns3::operator<<().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint16_t ns3::ErpInformation::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 97 of file erp-information.cc.

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

Referenced by ns3::MgtAssocResponseHeader::GetSerializedSize(), and ns3::MgtProbeResponseHeader::GetSerializedSize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetUseProtection()

uint8_t ns3::ErpInformation::GetUseProtection ( void  ) const

Return the Use_Protection field in the ErpInformation information element.

Returns
the Use_Protection field in the ErpInformation information element

Definition at line 68 of file erp-information.cc.

References m_erpInformation.

Referenced by ns3::operator<<(), and ns3::StaWifiMac::UpdateApInfoFromBeacon().

+ Here is the caller graph for this function:

◆ Serialize()

Buffer::Iterator ns3::ErpInformation::Serialize ( Buffer::Iterator  i) const
overridevirtual

Serialize entire IE including Element ID and length fields.

Parameters
ian iterator which points to where the IE should be written.
Returns
an iterator

Reimplemented from ns3::WifiInformationElement.

Definition at line 87 of file erp-information.cc.

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

Referenced by ns3::MgtAssocResponseHeader::Serialize(), and ns3::MgtProbeResponseHeader::Serialize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SerializeInformationField()

void ns3::ErpInformation::SerializeInformationField ( Buffer::Iterator  start) const
overridevirtual

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 107 of file erp-information.cc.

References m_erpInformation, m_erpSupported, and visualizer.core::start().

+ Here is the call graph for this function:

◆ SetBarkerPreambleMode()

void ns3::ErpInformation::SetBarkerPreambleMode ( uint8_t  barkerPreambleMode)

Set the Barker_Preamble_Mode field in the ErpInformation information element.

Parameters
barkerPreambleModethe Barker_Preamble_Mode field in the ErpInformation information element

Definition at line 44 of file erp-information.cc.

References m_erpInformation.

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

+ Here is the caller graph for this function:

◆ SetErpSupported()

void ns3::ErpInformation::SetErpSupported ( uint8_t  erpSupported)

Set the ERP supported field.

Parameters
erpSupportedthe ERP supported field in the ErpInformation information element

Definition at line 38 of file erp-information.cc.

References m_erpSupported.

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

+ Here is the caller graph for this function:

◆ SetNonErpPresent()

void ns3::ErpInformation::SetNonErpPresent ( uint8_t  nonErpPresent)

Set the Non_Erp_Present field in the ErpInformation information element.

Parameters
nonErpPresentthe Non_Erp_Present field in the ErpInformation information element

Definition at line 56 of file erp-information.cc.

References m_erpInformation.

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

+ Here is the caller graph for this function:

◆ SetUseProtection()

void ns3::ErpInformation::SetUseProtection ( uint8_t  useProtection)

Set the Use_Protection field in the ErpInformation information element.

Parameters
useProtectionthe Use_Protection field in the ErpInformation information element

Definition at line 50 of file erp-information.cc.

References m_erpInformation.

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

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_erpInformation

uint8_t ns3::ErpInformation::m_erpInformation
private

◆ m_erpSupported

bool ns3::ErpInformation::m_erpSupported
private

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

Definition at line 103 of file erp-information.h.

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


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