A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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 ()
 
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)
 
WifiInformationElementId ElementId () const override
 Get the wifi information element ID.
 
uint8_t GetBarkerPreambleMode () const
 Return the Barker_Preamble_Mode field in the ErpInformation information element.
 
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.
 
uint8_t GetNonErpPresent () const
 Return the Non_Erp_Present field in the ErpInformation information element.
 
uint8_t GetUseProtection () const
 Return the Use_Protection field in the ErpInformation information element.
 
void SerializeInformationField (Buffer::Iterator start) const override
 Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
 
void SetBarkerPreambleMode (uint8_t barkerPreambleMode)
 Set the Barker_Preamble_Mode field in the ErpInformation information element.
 
void SetNonErpPresent (uint8_t nonErpPresent)
 Set the Non_Erp_Present field in the ErpInformation information element.
 
void SetUseProtection (uint8_t useProtection)
 Set the Use_Protection field in the ErpInformation 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.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 

Private Attributes

uint8_t m_erpInformation
 ERP information.
 

Detailed Description

The ErpInformation Information Element.

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

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

Constructor & Destructor Documentation

◆ ErpInformation()

ns3::ErpInformation::ErpInformation ( )

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

Member Function Documentation

◆ DeserializeInformationField()

uint16_t ns3::ErpInformation::DeserializeInformationField ( Buffer::Iterator start,
uint16_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.
lengththe expected number of bytes to read
Returns
the number of bytes read

Implements ns3::WifiInformationElement.

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

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

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

References IE_ERP_INFORMATION.

◆ GetBarkerPreambleMode()

uint8_t ns3::ErpInformation::GetBarkerPreambleMode ( ) 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 44 of file erp-information.cc.

References m_erpInformation.

Referenced by ns3::operator<<().

+ Here is the caller graph for this function:

◆ GetInformationFieldSize()

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

Returns
the length of serialized information

Implements ns3::WifiInformationElement.

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

◆ GetNonErpPresent()

uint8_t ns3::ErpInformation::GetNonErpPresent ( ) 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 56 of file erp-information.cc.

References m_erpInformation.

Referenced by ns3::operator<<().

+ Here is the caller graph for this function:

◆ GetUseProtection()

uint8_t ns3::ErpInformation::GetUseProtection ( ) const

Return the Use_Protection field in the ErpInformation information element.

Returns
the Use_Protection field in the ErpInformation information element

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

References m_erpInformation.

Referenced by ns3::operator<<().

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

References m_erpInformation.

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

References m_erpInformation.

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 38 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 32 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

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