A Discrete-Event Network Simulator
API
he-operation.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Sébastien Deronne
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Sébastien Deronne <sebastien.deronne@gmail.com>
18  */
19 
20 #ifndef HE_OPERATION_H
21 #define HE_OPERATION_H
22 
23 #include "ns3/wifi-information-element.h"
24 
25 namespace ns3
26 {
27 
36 {
37  public:
38  HeOperation();
39 
40  // Implementations of pure virtual methods of WifiInformationElement
41  WifiInformationElementId ElementId() const override;
42  WifiInformationElementId ElementIdExt() const override;
43 
49  void SetHeOperationParameters(uint32_t ctrl);
57  void SetMaxHeMcsPerNss(uint8_t nss, uint8_t maxHeMcs);
58 
64  uint32_t GetHeOperationParameters() const;
70  uint16_t GetBasicHeMcsAndNssSet() const;
75  void SetBssColor(uint8_t bssColor);
80  uint8_t GetBssColor() const;
81 
82  private:
83  uint16_t GetInformationFieldSize() const override;
85  uint16_t DeserializeInformationField(Buffer::Iterator start, uint16_t length) override;
86 
87  // HE Operation Parameters fields
88  uint8_t m_bssColor;
90  uint8_t m_twtRequired;
96  uint8_t m_dualBeacon;
97 
98  // Basic HE-MCS and NSS Set
100 
101  // TODO: VHT Operation Information subfields not defined in the standard yet.
102 };
103 
112 std::ostream& operator<<(std::ostream& os, const HeOperation& HeOperation);
113 
114 } // namespace ns3
115 
116 #endif /* HE_OPERATION_H */
iterator in a Buffer instance
Definition: buffer.h:100
The HE Operation Information Element.
Definition: he-operation.h:36
void SetBssColor(uint8_t bssColor)
Set the BSS color.
uint8_t m_dualBeacon
Dual Beacon.
Definition: he-operation.h:96
void SetMaxHeMcsPerNss(uint8_t nss, uint8_t maxHeMcs)
Set the Basic HE-MCS and NSS field in the HE Operation information element by specifying the tuple (n...
Definition: he-operation.cc:88
uint8_t m_partialBssColor
partial BSS color
Definition: he-operation.h:92
WifiInformationElementId ElementIdExt() const override
Get the wifi information element ID extension.
Definition: he-operation.cc:46
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)
uint8_t m_maxBssidIndicator
max BSSID indicator
Definition: he-operation.h:93
uint8_t GetBssColor() const
Get the BSS color.
uint8_t m_twtRequired
TWT required.
Definition: he-operation.h:90
uint16_t GetInformationFieldSize() const override
Length of serialized information (i.e., the length of the body of the IE, not including the Element I...
Definition: he-operation.cc:52
uint8_t m_txBssidIndicator
TX BSSID indicator.
Definition: he-operation.h:94
uint8_t m_bssColor
BSS color.
Definition: he-operation.h:88
void SetHeOperationParameters(uint32_t ctrl)
Set the HE Operation Parameters field in the HE Operation information element.
Definition: he-operation.cc:58
uint8_t m_defaultPEDuration
default PE duration
Definition: he-operation.h:89
uint16_t m_basicHeMcsAndNssSet
basic HE MCS NSS set
Definition: he-operation.h:99
uint16_t m_heDurationBasedRtsThreshold
HE duration based RTS threshold.
Definition: he-operation.h:91
uint8_t m_bssColorDisabled
BSS color disabled.
Definition: he-operation.h:95
uint16_t GetBasicHeMcsAndNssSet() const
Return the Basic HE-MCS And Nss field in the HE Operation information element.
uint32_t GetHeOperationParameters() const
Return the HE Operation Parameters field in the HE Operation information element.
Definition: he-operation.cc:72
WifiInformationElementId ElementId() const override
Get the wifi information element ID.
Definition: he-operation.cc:40
void SerializeInformationField(Buffer::Iterator start) const override
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
Information element, as defined in 802.11-2007 standard.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::ostream & operator<<(std::ostream &os, const Angles &a)
Definition: angles.cc:129
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.