A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
he-6ghz-band-capabilities.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2024
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Author: Rami Abdallah <abdallah.rami@gmail.com>
7 */
8
9#ifndef HE_6GHZ_BAND_CAPABILITIES_H
10#define HE_6GHZ_BAND_CAPABILITIES_H
11
12#include "ns3/wifi-information-element.h"
13
14namespace ns3
15{
16
17/**
18 * \ingroup wifi
19 *
20 * The HE 6 GHz Band Capabilities (IEEE 802.11ax-2021 9.4.2.263)
21 */
23{
24 public:
26
27 WifiInformationElementId ElementId() const override;
29 void Print(std::ostream& os) const override;
30
31 /// Capabilities Information field
33 {
34 uint8_t m_minMpduStartSpacing : 3; ///< Minimum MPDU Start Spacing
35 uint8_t m_maxAmpduLengthExponent : 3; ///< Maximum A-MPDU Length Exponent (can
36 ///< also be set via convenient methods)
37 uint8_t m_maxMpduLength : 2; ///< Maximum MPDU Length (can also
38 ///< be set via convenient methods)
39 uint8_t : 1; ///< Reserved Bits
40 uint8_t m_smPowerSave : 2; ///< SM Power Save
41 uint8_t m_rdResponder : 1; ///< RD Responder
42 uint8_t m_rxAntennaPatternConsistency : 1; ///< Receive Antenna Pattern Consistency
43 uint8_t m_txAntennaPatternConsistency : 1; ///< Transmit Antenna Pattern Consistency
44 uint8_t : 2; ///< Reserved Bits
45 };
46
47 CapabilitiesInfo m_capabilitiesInfo; ///< capabilities field
48
49 /**
50 * Set the maximum AMPDU length.
51 *
52 * \param maxAmpduLength 2^(13 + x) - 1, x in the range 0 to 7
53 */
54 void SetMaxAmpduLength(uint32_t maxAmpduLength);
55 /**
56 * Return the maximum A-MPDU length.
57 *
58 * \return the maximum A-MPDU length in bytes
59 */
61
62 /**
63 * Set the maximum MPDU length.
64 *
65 * \param length the maximum MPDU length (3895, 7991 or 11454)
66 */
67 void SetMaxMpduLength(uint16_t length);
68 /**
69 * Get the maximum MPDU length.
70 *
71 * \return the maximum MPDU length in bytes
72 */
73 uint16_t GetMaxMpduLength() const;
74
75 private:
76 uint16_t GetInformationFieldSize() const override;
77 void SerializeInformationField(Buffer::Iterator start) const override;
78 uint16_t DeserializeInformationField(Buffer::Iterator start, uint16_t length) override;
79};
80
81} // namespace ns3
82
83#endif /* HE_6GHZ_BAND_CAPABILITY_H */
iterator in a Buffer instance
Definition buffer.h:89
The HE 6 GHz Band Capabilities (IEEE 802.11ax-2021 9.4.2.263)
uint16_t GetInformationFieldSize() const override
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
uint32_t GetMaxAmpduLength() const
Return the maximum A-MPDU length.
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)
void SetMaxAmpduLength(uint32_t maxAmpduLength)
Set the maximum AMPDU length.
void Print(std::ostream &os) const override
Generate human-readable form of IE.
WifiInformationElementId ElementIdExt() const override
Get the wifi information element ID extension.
void SerializeInformationField(Buffer::Iterator start) const override
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
uint16_t GetMaxMpduLength() const
Get the maximum MPDU length.
CapabilitiesInfo m_capabilitiesInfo
capabilities field
WifiInformationElementId ElementId() const override
Get the wifi information element ID.
void SetMaxMpduLength(uint16_t length)
Set the maximum MPDU length.
Information element, as defined in 802.11-2007 standard.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
uint8_t m_maxAmpduLengthExponent
Maximum A-MPDU Length Exponent (can also be set via convenient methods)
uint8_t m_maxMpduLength
Maximum MPDU Length (can also be set via convenient methods)
uint8_t m_minMpduStartSpacing
Minimum MPDU Start Spacing.
uint8_t m_rxAntennaPatternConsistency
Receive Antenna Pattern Consistency.
uint8_t m_txAntennaPatternConsistency
Transmit Antenna Pattern Consistency.