A Discrete-Event Network Simulator
API
ns3::dot11s::Dot11sMeshCapability Class Reference

A set of values indicating whether a mesh STA is a possible candidate for mesh peering establishment (Section 8.4.2.100.8 of IEEE 802.11-2012) More...

#include "ie-dot11s-configuration.h"

Public Member Functions

 Dot11sMeshCapability ()
 
Buffer::Iterator Deserialize (Buffer::Iterator i)
 Deserialize from a buffer. More...
 
uint8_t GetSerializedSize () const
 Size of the field in bytes when serialized. More...
 
uint8_t GetUint8 () const
 The Mesh Capability is expressed in terms of 8 single bit fields. More...
 
bool Is (uint8_t cap, uint8_t n) const
 This is a utility function to test if the bit at position n is true. More...
 
Buffer::Iterator Serialize (Buffer::Iterator i) const
 Serialize to a buffer. More...
 

Public Attributes

bool acceptPeerLinks
 accept peer links More...
 
bool beaconTimingReport
 beacon timing report More...
 
bool forwarding
 forwarding? More...
 
bool MCCAEnabled
 MCCA enabled. More...
 
bool MCCASupported
 MCCA supported. More...
 
bool powerSaveLevel
 power save level More...
 
bool TBTTAdjustment
 TBTT adjustment. More...
 

Friends

bool operator== (const Dot11sMeshCapability &a, const Dot11sMeshCapability &b)
 equality operator More...
 

Detailed Description

A set of values indicating whether a mesh STA is a possible candidate for mesh peering establishment (Section 8.4.2.100.8 of IEEE 802.11-2012)

Definition at line 71 of file ie-dot11s-configuration.h.

Constructor & Destructor Documentation

◆ Dot11sMeshCapability()

ns3::dot11s::Dot11sMeshCapability::Dot11sMeshCapability ( )

Definition at line 27 of file ie-dot11s-configuration.cc.

Member Function Documentation

◆ Deserialize()

Buffer::Iterator ns3::dot11s::Dot11sMeshCapability::Deserialize ( Buffer::Iterator  i)

Deserialize from a buffer.

Parameters
ithe iterator from which to deserialize
Returns
new value of the iterator

Definition at line 78 of file ie-dot11s-configuration.cc.

References acceptPeerLinks, beaconTimingReport, forwarding, Is(), MCCAEnabled, MCCASupported, powerSaveLevel, ns3::Buffer::Iterator::ReadU8(), and TBTTAdjustment.

Referenced by ns3::dot11s::IeConfiguration::DeserializeInformationField().

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

◆ GetSerializedSize()

uint8_t ns3::dot11s::Dot11sMeshCapability::GetSerializedSize ( void  ) const

Size of the field in bytes when serialized.

Returns
the serialized size in bytes

Definition at line 33 of file ie-dot11s-configuration.cc.

Referenced by ns3::dot11s::IeConfiguration::GetInformationFieldSize().

+ Here is the caller graph for this function:

◆ GetUint8()

uint8_t ns3::dot11s::Dot11sMeshCapability::GetUint8 ( ) const

The Mesh Capability is expressed in terms of 8 single bit fields.

This method returns the whole byte.

Returns
the Mesh Capability byte

Definition at line 38 of file ie-dot11s-configuration.cc.

References acceptPeerLinks, beaconTimingReport, forwarding, MCCAEnabled, MCCASupported, powerSaveLevel, and TBTTAdjustment.

Referenced by ns3::dot11s::IeConfiguration::Print(), and Serialize().

+ Here is the caller graph for this function:

◆ Is()

bool ns3::dot11s::Dot11sMeshCapability::Is ( uint8_t  cap,
uint8_t  n 
) const

This is a utility function to test if the bit at position n is true.

Parameters
capbyte to test
nbit number to mask
Returns
true if bit n is set in cap

Definition at line 91 of file ie-dot11s-configuration.cc.

References sample-rng-plot::n.

Referenced by Deserialize().

+ Here is the caller graph for this function:

◆ Serialize()

Buffer::Iterator ns3::dot11s::Dot11sMeshCapability::Serialize ( Buffer::Iterator  i) const

Serialize to a buffer.

Parameters
ithe iterator of the buffer to serialize to
Returns
new value of the iterator

Definition at line 72 of file ie-dot11s-configuration.cc.

References GetUint8(), and ns3::Buffer::Iterator::WriteU8().

Referenced by ns3::dot11s::IeConfiguration::SerializeInformationField().

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

Friends And Related Function Documentation

◆ operator==

bool operator== ( const Dot11sMeshCapability a,
const Dot11sMeshCapability b 
)
friend

equality operator

Parameters
alhs
brhs
Returns
true if equal

Definition at line 199 of file ie-dot11s-configuration.cc.

Member Data Documentation

◆ acceptPeerLinks

bool ns3::dot11s::Dot11sMeshCapability::acceptPeerLinks

accept peer links

Definition at line 98 of file ie-dot11s-configuration.h.

Referenced by Deserialize(), GetUint8(), and ns3::dot11s::operator==().

◆ beaconTimingReport

bool ns3::dot11s::Dot11sMeshCapability::beaconTimingReport

beacon timing report

Definition at line 102 of file ie-dot11s-configuration.h.

Referenced by Deserialize(), GetUint8(), and ns3::dot11s::operator==().

◆ forwarding

bool ns3::dot11s::Dot11sMeshCapability::forwarding

forwarding?

Definition at line 101 of file ie-dot11s-configuration.h.

Referenced by Deserialize(), GetUint8(), and ns3::dot11s::operator==().

◆ MCCAEnabled

bool ns3::dot11s::Dot11sMeshCapability::MCCAEnabled

MCCA enabled.

Definition at line 100 of file ie-dot11s-configuration.h.

Referenced by Deserialize(), GetUint8(), and ns3::dot11s::operator==().

◆ MCCASupported

bool ns3::dot11s::Dot11sMeshCapability::MCCASupported

MCCA supported.

Definition at line 99 of file ie-dot11s-configuration.h.

Referenced by Deserialize(), GetUint8(), and ns3::dot11s::operator==().

◆ powerSaveLevel

bool ns3::dot11s::Dot11sMeshCapability::powerSaveLevel

power save level

Definition at line 104 of file ie-dot11s-configuration.h.

Referenced by Deserialize(), GetUint8(), and ns3::dot11s::operator==().

◆ TBTTAdjustment

bool ns3::dot11s::Dot11sMeshCapability::TBTTAdjustment

TBTT adjustment.

Definition at line 103 of file ie-dot11s-configuration.h.

Referenced by Deserialize(), GetUint8(), and ns3::dot11s::operator==().


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