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

Capability information. More...

#include "capability-information.h"

+ Collaboration diagram for ns3::CapabilityInformation:

Public Member Functions

 CapabilityInformation ()
 
Buffer::Iterator Deserialize (Buffer::Iterator start)
 Deserialize capability information from the given buffer. More...
 
uint32_t GetSerializedSize (void) const
 Return the serialized size of capability information. More...
 
bool IsCfPollable (void) const
 Check if the CF-Pollable bit in the capability information field is set to 1. More...
 
bool IsEss (void) const
 Check if the Extended Service Set (ESS) bit in the capability information field is set to 1. More...
 
bool IsIbss (void) const
 Check if the Independent BSS (IBSS) bit in the capability information field is set to 1. More...
 
bool IsShortPreamble (void) const
 Check if the short preamble bit in the capability information field is set to 1. More...
 
bool IsShortSlotTime (void) const
 Check if the short slot time in the capability information field is set to 1. More...
 
Buffer::Iterator Serialize (Buffer::Iterator start) const
 Serialize capability information to the given buffer. More...
 
void SetCfPollable (void)
 Set the CF-Pollable bit in the capability information field. More...
 
void SetEss (void)
 Set the Extended Service Set (ESS) bit in the capability information field. More...
 
void SetIbss (void)
 Set the Independent BSS (IBSS) bit in the capability information field. More...
 
void SetShortPreamble (bool shortPreamble)
 Set the short preamble bit in the capability information field. More...
 
void SetShortSlotTime (bool shortSlotTime)
 Set the short slot time bit in the capability information field. More...
 

Private Member Functions

void Clear (uint8_t n)
 Set bit n to 0. More...
 
bool Is (uint8_t n) const
 Check if bit n is set to 1. More...
 
void Set (uint8_t n)
 Set bit n to 1. More...
 

Private Attributes

uint16_t m_capability
 capability More...
 

Detailed Description

Capability information.

Definition at line 33 of file capability-information.h.

Constructor & Destructor Documentation

◆ CapabilityInformation()

ns3::CapabilityInformation::CapabilityInformation ( )

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

Member Function Documentation

◆ Clear()

void ns3::CapabilityInformation::Clear ( uint8_t  n)
private

Set bit n to 0.

Parameters
nthe bit position

Definition at line 106 of file capability-information.cc.

References m_capability.

Referenced by SetEss(), and SetIbss().

+ Here is the caller graph for this function:

◆ Deserialize()

Buffer::Iterator ns3::CapabilityInformation::Deserialize ( Buffer::Iterator  start)

Deserialize capability information from the given buffer.

Parameters
startan iterator to a buffer
Returns
an iterator to a buffer after capability information was deserialized

Definition at line 133 of file capability-information.cc.

References m_capability, and visualizer.core::start().

Referenced by ns3::MgtReassocRequestHeader::Deserialize(), ns3::MgtAssocResponseHeader::Deserialize(), ns3::MgtProbeResponseHeader::Deserialize(), and ns3::MgtAssocRequestHeader::Deserialize().

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

◆ GetSerializedSize()

uint32_t ns3::CapabilityInformation::GetSerializedSize ( void  ) const

Return the serialized size of capability information.

Returns
the serialized size

Definition at line 120 of file capability-information.cc.

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

+ Here is the caller graph for this function:

◆ Is()

bool ns3::CapabilityInformation::Is ( uint8_t  n) const
private

Check if bit n is set to 1.

Parameters
nthe bit position
Returns
true if bit n is set to 1, false otherwise

Definition at line 113 of file capability-information.cc.

References m_capability.

Referenced by IsCfPollable(), IsEss(), IsIbss(), IsShortPreamble(), and IsShortSlotTime().

+ Here is the caller graph for this function:

◆ IsCfPollable()

bool ns3::CapabilityInformation::IsCfPollable ( void  ) const

Check if the CF-Pollable bit in the capability information field is set to 1.

Returns
CF-Pollable bit in the capability information field is set to 1

Definition at line 93 of file capability-information.cc.

References Is().

+ Here is the call graph for this function:

◆ IsEss()

bool ns3::CapabilityInformation::IsEss ( void  ) const

Check if the Extended Service Set (ESS) bit in the capability information field is set to 1.

Returns
ESS bit in the capability information field is set to 1

Definition at line 69 of file capability-information.cc.

References Is().

Referenced by ns3::StaWifiMac::ReceiveBeacon().

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

◆ IsIbss()

bool ns3::CapabilityInformation::IsIbss ( void  ) const

Check if the Independent BSS (IBSS) bit in the capability information field is set to 1.

Returns
IBSS bit in the capability information field is set to 1

Definition at line 75 of file capability-information.cc.

References Is().

+ Here is the call graph for this function:

◆ IsShortPreamble()

bool ns3::CapabilityInformation::IsShortPreamble ( void  ) const

Check if the short preamble bit in the capability information field is set to 1.

Returns
short preamble bit in the capability information field is set to 1

Definition at line 81 of file capability-information.cc.

References Is().

Referenced by ns3::ApWifiMac::ReceiveAssocRequest(), and ns3::StaWifiMac::UpdateApInfo().

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

◆ IsShortSlotTime()

bool ns3::CapabilityInformation::IsShortSlotTime ( void  ) const

Check if the short slot time in the capability information field is set to 1.

Returns
short slot time bit in the capability information field is set to 1

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

References Is().

Referenced by ns3::ApWifiMac::ReceiveAssocRequest(), and ns3::StaWifiMac::UpdateApInfo().

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

◆ Serialize()

Buffer::Iterator ns3::CapabilityInformation::Serialize ( Buffer::Iterator  start) const

Serialize capability information to the given buffer.

Parameters
startan iterator to a buffer
Returns
an iterator to a buffer after capability information was serialized

Definition at line 126 of file capability-information.cc.

References m_capability, and visualizer.core::start().

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

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

◆ Set()

void ns3::CapabilityInformation::Set ( uint8_t  n)
private

Set bit n to 1.

Parameters
nthe bit position

Definition at line 99 of file capability-information.cc.

References m_capability.

Referenced by SetCfPollable(), SetEss(), SetIbss(), SetShortPreamble(), and SetShortSlotTime().

+ Here is the caller graph for this function:

◆ SetCfPollable()

void ns3::CapabilityInformation::SetCfPollable ( void  )

Set the CF-Pollable bit in the capability information field.

Definition at line 63 of file capability-information.cc.

References Set().

+ Here is the call graph for this function:

◆ SetEss()

void ns3::CapabilityInformation::SetEss ( void  )

Set the Extended Service Set (ESS) bit in the capability information field.

Definition at line 31 of file capability-information.cc.

References Clear(), and Set().

Referenced by BasicMultiLinkElementTest::DoRun(), and ns3::ApWifiMac::GetCapabilities().

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

◆ SetIbss()

void ns3::CapabilityInformation::SetIbss ( void  )

Set the Independent BSS (IBSS) bit in the capability information field.

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

References Clear(), and Set().

+ Here is the call graph for this function:

◆ SetShortPreamble()

void ns3::CapabilityInformation::SetShortPreamble ( bool  shortPreamble)

Set the short preamble bit in the capability information field.

Parameters
shortPreamblethe short preamble bit

Definition at line 45 of file capability-information.cc.

References Set().

Referenced by BasicMultiLinkElementTest::DoRun(), ns3::ApWifiMac::GetCapabilities(), and ns3::StaWifiMac::GetCapabilities().

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

◆ SetShortSlotTime()

void ns3::CapabilityInformation::SetShortSlotTime ( bool  shortSlotTime)

Set the short slot time bit in the capability information field.

Parameters
shortSlotTimethe short preamble bit

Definition at line 54 of file capability-information.cc.

References Set().

Referenced by BasicMultiLinkElementTest::DoRun(), ns3::ApWifiMac::GetCapabilities(), and ns3::StaWifiMac::GetCapabilities().

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

Member Data Documentation

◆ m_capability

uint16_t ns3::CapabilityInformation::m_capability
private

capability

Definition at line 159 of file capability-information.h.

Referenced by Clear(), Deserialize(), Is(), Serialize(), and Set().


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