A Discrete-Event Network Simulator
API
ht-operation.h
Go to the documentation of this file.
1/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2016 S├ębastien Deronne
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: S├ębastien Deronne <sebastien.deronne@gmail.com>
19 */
20
21#ifndef HT_OPERATION_H
22#define HT_OPERATION_H
23
24#include "ns3/wifi-information-element.h"
25
30#define MAX_SUPPORTED_MCS (77)
31
32namespace ns3 {
33
36{
41};
42
51{
52public:
53 HtOperation ();
54
55 // Implementations of pure virtual methods of WifiInformationElement
56 WifiInformationElementId ElementId () const override;
57
63 void SetPrimaryChannel (uint8_t ctrl);
69 void SetInformationSubset1 (uint8_t ctrl);
75 void SetInformationSubset2 (uint16_t ctrl);
81 void SetInformationSubset3 (uint16_t ctrl);
88 void SetBasicMcsSet (uint64_t ctrl1, uint64_t ctrl2);
89
95 void SetSecondaryChannelOffset (uint8_t secondaryChannelOffset);
101 void SetStaChannelWidth (uint8_t staChannelWidth);
107 void SetRifsMode (uint8_t rifsMode);
108
114 void SetHtProtection (uint8_t htProtection);
120 void SetNonGfHtStasPresent (uint8_t nonGfHtStasPresent);
126 void SetObssNonHtStasPresent (uint8_t obssNonHtStasPresent);
127
133 void SetDualBeacon (uint8_t dualBeacon);
139 void SetDualCtsProtection (uint8_t dualCtsProtection);
145 void SetStbcBeacon (uint8_t stbcBeacon);
151 void SetLSigTxopProtectionFullSupport (uint8_t lSigTxopProtectionFullSupport);
157 void SetPcoActive (uint8_t pcoActive);
163 void SetPhase (uint8_t pcoPhase);
164
170 void SetRxMcsBitmask (uint8_t index);
176 void SetRxHighestSupportedDataRate (uint16_t maxSupportedRate);
182 void SetTxMcsSetDefined (uint8_t txMcsSetDefined);
188 void SetTxRxMcsSetUnequal (uint8_t txRxMcsSetUnequal);
194 void SetTxMaxNSpatialStreams (uint8_t maxTxSpatialStreams);
200 void SetTxUnequalModulation (uint8_t txUnequalModulation);
201
207 uint8_t GetPrimaryChannel (void) const;
213 uint8_t GetInformationSubset1 (void) const;
219 uint16_t GetInformationSubset2 (void) const;
225 uint16_t GetInformationSubset3 (void) const;
231 uint64_t GetBasicMcsSet1 (void) const;
237 uint64_t GetBasicMcsSet2 (void) const;
238
244 uint8_t GetSecondaryChannelOffset (void) const;
250 uint8_t GetStaChannelWidth (void) const;
256 uint8_t GetRifsMode (void) const;
257
263 uint8_t GetHtProtection (void) const;
269 uint8_t GetNonGfHtStasPresent (void) const;
275 uint8_t GetObssNonHtStasPresent (void) const;
276
282 uint8_t GetDualBeacon (void) const;
288 uint8_t GetDualCtsProtection (void) const;
294 uint8_t GetStbcBeacon (void) const;
300 uint8_t GetLSigTxopProtectionFullSupport (void) const;
306 uint8_t GetPcoActive (void) const;
312 uint8_t GetPhase (void) const;
313
321 bool IsSupportedMcs (uint8_t mcs) const;
327 uint16_t GetRxHighestSupportedDataRate (void) const;
333 uint8_t GetTxMcsSetDefined (void) const;
339 uint8_t GetTxRxMcsSetUnequal (void) const;
345 uint8_t GetTxMaxNSpatialStreams (void) const;
351 uint8_t GetTxUnequalModulation (void) const;
352
353
354private:
355 uint16_t GetInformationFieldSize () const override;
358 uint16_t length) override;
359
361
362 //HT Information Subset 1
365 uint8_t m_rifsMode;
367
368 //HT Information Subset 2
374
375 //HT Information Subset 3
377 uint8_t m_dualBeacon;
379 uint8_t m_stbcBeacon;
381 uint8_t m_pcoActive;
382 uint8_t m_pcoPhase;
384
385 //Basic MCS Set field
395};
396
405std::ostream &operator << (std::ostream &os, const HtOperation &htOperation);
406
407} //namespace ns3
408
409#endif /* HT_OPERATION_H */
iterator in a Buffer instance
Definition: buffer.h:99
The HT Operation Information Element.
Definition: ht-operation.h:51
void SetObssNonHtStasPresent(uint8_t obssNonHtStasPresent)
Set the OBSS non HT STAs present.
uint8_t m_reservedInformationSubset1
reserved information subset 1
Definition: ht-operation.h:366
void SetRifsMode(uint8_t rifsMode)
Set the RIFS mode.
Definition: ht-operation.cc:90
uint8_t m_obssNonHtStasPresent
OBSS NON HT STAs present.
Definition: ht-operation.h:372
void SetBasicMcsSet(uint64_t ctrl1, uint64_t ctrl2)
Set the Basic MCS Set field in the HT Operation information element.
void SetSecondaryChannelOffset(uint8_t secondaryChannelOffset)
Set the secondary channel offset.
Definition: ht-operation.cc:78
uint8_t m_reservedInformationSubset3_1
reserved information subset 3-1
Definition: ht-operation.h:376
uint8_t m_stbcBeacon
STBC beacon.
Definition: ht-operation.h:379
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)
uint64_t GetBasicMcsSet1(void) const
Return the first 64 bytes of the Basic MCS Set field in the HT Operation information element.
void SetInformationSubset2(uint16_t ctrl)
Set the Information Subset 2 field in the HT Operation information element.
uint8_t GetTxMaxNSpatialStreams(void) const
Return transmit maximum number spatial streams.
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: ht-operation.cc:66
uint8_t m_reservedInformationSubset3_2
reserved information subset 3-2
Definition: ht-operation.h:383
void SetPcoActive(uint8_t pcoActive)
Set the PCO active.
void SetTxUnequalModulation(uint8_t txUnequalModulation)
Set the transmit unequal modulation.
uint8_t m_rifsMode
RIFS mode.
Definition: ht-operation.h:365
uint8_t m_secondaryChannelOffset
secondary channel offset
Definition: ht-operation.h:363
uint8_t m_rxMcsBitmask[MAX_SUPPORTED_MCS]
receive MCS bitmask
Definition: ht-operation.h:394
uint16_t m_rxHighestSupportedDataRate
receive highest supported data rate
Definition: ht-operation.h:387
void SetInformationSubset3(uint16_t ctrl)
Set the Information Subset 3 field in the HT Operation information element.
uint64_t GetBasicMcsSet2(void) const
Return the last 64 bytes of the Basic MCS Set field in the HT Operation information element.
void SetHtProtection(uint8_t htProtection)
Set the HT protection.
Definition: ht-operation.cc:96
uint8_t GetLSigTxopProtectionFullSupport(void) const
Return LSIG TXOP protection full support.
uint8_t GetTxRxMcsSetUnequal(void) const
Return transmit / receive MCS set unequal.
uint8_t m_staChannelWidth
STA channel width.
Definition: ht-operation.h:364
uint8_t GetNonGfHtStasPresent(void) const
Return the non GF HT STAs present.
uint8_t GetStbcBeacon(void) const
Return STBC beacon.
void SetTxMaxNSpatialStreams(uint8_t maxTxSpatialStreams)
Set the transmit maximum number spatial streams.
void SerializeInformationField(Buffer::Iterator start) const override
Serialize information (i.e., the body of the IE, not including the Element ID and length octets)
uint8_t m_txUnequalModulation
transmit unequal modulation
Definition: ht-operation.h:392
uint8_t GetPhase(void) const
Return phase.
void SetTxRxMcsSetUnequal(uint8_t txRxMcsSetUnequal)
Set the transmit / receive MCS set unequal.
uint8_t m_reservedMcsSet1
reserved MCS set 1
Definition: ht-operation.h:386
uint8_t GetDualBeacon(void) const
Return dual beacon.
uint8_t m_txMaxNSpatialStreams
transmit maximum number spatial streams
Definition: ht-operation.h:391
WifiInformationElementId ElementId() const override
Get the wifi information element ID.
Definition: ht-operation.cc:60
uint16_t GetInformationSubset3(void) const
Return the Information Subset 3 field in the HT Operation information element.
uint8_t m_reservedInformationSubset2_1
reserved information subset 2-1
Definition: ht-operation.h:371
uint8_t GetTxUnequalModulation(void) const
Return transmit unequal modulation.
void SetDualBeacon(uint8_t dualBeacon)
Set the dual beacon.
uint8_t GetDualCtsProtection(void) const
Return dual CTS protection.
uint8_t m_dualBeacon
dual beacon
Definition: ht-operation.h:377
uint8_t m_txMcsSetDefined
transmit MCS set defined
Definition: ht-operation.h:389
void SetNonGfHtStasPresent(uint8_t nonGfHtStasPresent)
Set the non GF HT STAs present.
uint8_t GetSecondaryChannelOffset(void) const
Return the secondary channel offset.
uint8_t m_dualCtsProtection
dual CTS protection
Definition: ht-operation.h:378
uint8_t m_lSigTxopProtectionFullSupport
L-SIG TXOP protection full support.
Definition: ht-operation.h:380
uint8_t GetPcoActive(void) const
Return PCO active.
uint8_t GetTxMcsSetDefined(void) const
Return transmit MCS set defined.
void SetTxMcsSetDefined(uint8_t txMcsSetDefined)
Set the transmit MCS set defined.
uint8_t m_reservedInformationSubset2_2
reserved information subset 2-2
Definition: ht-operation.h:373
uint8_t GetStaChannelWidth(void) const
Return the STA channel width.
uint8_t m_reservedMcsSet2
reserved MCS set2
Definition: ht-operation.h:388
uint8_t GetObssNonHtStasPresent(void) const
Return the OBSS non HT STAs present.
void SetLSigTxopProtectionFullSupport(uint8_t lSigTxopProtectionFullSupport)
Set the LSIG TXOP protection full support.
void SetStaChannelWidth(uint8_t staChannelWidth)
Set the STA channel width.
Definition: ht-operation.cc:84
uint8_t GetRifsMode(void) const
Return the RIFS mode.
void SetInformationSubset1(uint8_t ctrl)
Set the Information Subset 1 field in the HT Operation information element.
void SetRxHighestSupportedDataRate(uint16_t maxSupportedRate)
Set the receive highest supported data rate.
uint8_t m_pcoActive
PCO active.
Definition: ht-operation.h:381
uint8_t GetPrimaryChannel(void) const
Return the Primary Channel field in the HT Operation information element.
uint8_t GetHtProtection(void) const
Return the HT protection.
void SetRxMcsBitmask(uint8_t index)
Set the receive MCS bitmask.
uint16_t GetRxHighestSupportedDataRate(void) const
Return receive highest supported data rate.
uint32_t m_reservedMcsSet3
reserved MCS set 3
Definition: ht-operation.h:393
uint8_t GetInformationSubset1(void) const
Return the Information Subset 1 field in the HT Operation information element.
void SetPrimaryChannel(uint8_t ctrl)
Set the Primary Channel field in the HT Operation information element.
Definition: ht-operation.cc:72
void SetDualCtsProtection(uint8_t dualCtsProtection)
Set the dual CTS protection.
uint16_t GetInformationSubset2(void) const
Return the Information Subset 2 field in the HT Operation information element.
uint8_t m_htProtection
HT protection.
Definition: ht-operation.h:369
void SetPhase(uint8_t pcoPhase)
Set the PCO phase.
bool IsSupportedMcs(uint8_t mcs) const
Return MCS is supported.
uint8_t m_txRxMcsSetUnequal
transmit / receive MCS set unequal
Definition: ht-operation.h:390
uint8_t m_pcoPhase
PCO phase.
Definition: ht-operation.h:382
uint8_t m_primaryChannel
primary channel
Definition: ht-operation.h:360
void SetStbcBeacon(uint8_t stbcBeacon)
Set the STBC beacon.
uint8_t m_nonGfHtStasPresent
non GF HT STAs present
Definition: ht-operation.h:370
Information element, as defined in 802.11-2007 standard.
#define MAX_SUPPORTED_MCS
This defines the maximum number of supported MCSs that a STA is allowed to have.
Definition: ht-operation.h:30
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:139
HtProtectionType
HtProtectionType enumeration.
Definition: ht-operation.h:36
@ NON_MEMBER_PROTECTION
Definition: ht-operation.h:38
@ NO_PROTECTION
Definition: ht-operation.h:37
@ TWENTY_MHZ_PROTECTION
Definition: ht-operation.h:39
@ MIXED_MODE_PROTECTION
Definition: ht-operation.h:40
uint8_t WifiInformationElementId
This type is used to represent an Information Element ID.
def start()
Definition: core.py:1852