A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::NonInheritance Class Reference

The IEEE 802.11 Non-Inheritance Information Element. More...

#include "non-inheritance.h"

+ Inheritance diagram for ns3::NonInheritance:
+ Collaboration diagram for ns3::NonInheritance:

Public Member Functions

void Add (uint8_t elemId, uint8_t elemIdExt=0)
 Add the Information Element specified by the given Element ID and Element ID Extension.
 
WifiInformationElementId ElementId () const override
 Get the wifi information element ID.
 
WifiInformationElementId ElementIdExt () const override
 Get the wifi information element ID extension.
 
bool IsPresent (uint8_t elemId, uint8_t elemIdExt=0) const
 
void Print (std::ostream &os) const override
 Generate human-readable form of IE.
 
- 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.
 
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.
 
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.
 

Public Attributes

std::set< uint8_t > m_elemIdExtList
 list of unique Element ID Extension values
 
std::set< uint8_t > m_elemIdList
 list of unique Element ID values (in increasing order)
 

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)
 

Detailed Description

The IEEE 802.11 Non-Inheritance Information Element.

Definition at line 24 of file non-inheritance.h.

Member Function Documentation

◆ Add()

void ns3::NonInheritance::Add ( uint8_t elemId,
uint8_t elemIdExt = 0 )

Add the Information Element specified by the given Element ID and Element ID Extension.

Parameters
elemIdthe given Element ID
elemIdExtthe given Element ID Extension

Definition at line 83 of file non-inheritance.cc.

References IE_EXTENSION, m_elemIdExtList, and m_elemIdList.

◆ DeserializeInformationField()

uint16_t ns3::NonInheritance::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
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 66 of file non-inheritance.cc.

References m_elemIdExtList, and m_elemIdList.

◆ ElementId()

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

Get the wifi information element ID.

Returns
the wifi information element ID

Implements ns3::WifiInformationElement.

Definition at line 18 of file non-inheritance.cc.

References IE_EXTENSION.

◆ ElementIdExt()

WifiInformationElementId ns3::NonInheritance::ElementIdExt ( ) const
overridevirtual

Get the wifi information element ID extension.

Returns
the wifi information element ID extension

Reimplemented from ns3::WifiInformationElement.

Definition at line 24 of file non-inheritance.cc.

References IE_EXT_NON_INHERITANCE.

◆ GetInformationFieldSize()

uint16_t ns3::NonInheritance::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 42 of file non-inheritance.cc.

References m_elemIdExtList, and m_elemIdList.

◆ IsPresent()

bool ns3::NonInheritance::IsPresent ( uint8_t elemId,
uint8_t elemIdExt = 0 ) const
Parameters
elemIdthe given Element ID
elemIdExtthe given Element ID Extension
Returns
whether the Information Element specified by the given Element ID and Element ID Extension is present

Definition at line 89 of file non-inheritance.cc.

References IE_EXTENSION, m_elemIdExtList, and m_elemIdList.

Referenced by BasicMultiLinkElementTest::DoRun(), ns3::internal::RemoveIfNotInherited(), and ns3::internal::RemoveIfNotInherited().

+ Here is the caller graph for this function:

◆ Print()

void ns3::NonInheritance::Print ( std::ostream & os) const
overridevirtual

Generate human-readable form of IE.

Parameters
osoutput stream

Reimplemented from ns3::WifiInformationElement.

Definition at line 30 of file non-inheritance.cc.

References m_elemIdExtList, and m_elemIdList.

◆ SerializeInformationField()

void ns3::NonInheritance::SerializeInformationField ( Buffer::Iterator start) const
overrideprivatevirtual

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 51 of file non-inheritance.cc.

References m_elemIdExtList, and m_elemIdList.

Member Data Documentation

◆ m_elemIdExtList

std::set<uint8_t> ns3::NonInheritance::m_elemIdExtList

list of unique Element ID Extension values

Definition at line 48 of file non-inheritance.h.

Referenced by Add(), DeserializeInformationField(), BasicMultiLinkElementTest::DoRun(), GetInformationFieldSize(), IsPresent(), Print(), and SerializeInformationField().

◆ m_elemIdList

std::set<uint8_t> ns3::NonInheritance::m_elemIdList

list of unique Element ID values (in increasing order)

Definition at line 47 of file non-inheritance.h.

Referenced by Add(), DeserializeInformationField(), BasicMultiLinkElementTest::DoRun(), GetInformationFieldSize(), IsPresent(), Print(), and SerializeInformationField().


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