A Discrete-Event Network Simulator
API
wifi-tx-vector.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2010 CTTC
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  * Authors: Nicola Baldo <nbaldo@cttc.es>
19  * Ghada Badawy <gbadawy@gmail.com>
20  */
21 
22 #ifndef WIFI_TX_VECTOR_H
23 #define WIFI_TX_VECTOR_H
24 
25 #include "wifi-mode.h"
26 #include "wifi-preamble.h"
27 
28 namespace ns3 {
29 
30 
62 {
63 public:
64  WifiTxVector ();
80  WifiTxVector (WifiMode mode,
81  uint8_t powerLevel,
82  uint8_t retries,
83  WifiPreamble preamble,
84  uint16_t guardInterval,
85  uint8_t nTx,
86  uint8_t nss,
87  uint8_t ness,
88  uint8_t channelWidth,
89  bool aggregation,
90  bool stbc);
94  WifiMode GetMode (void) const;
100  void SetMode (WifiMode mode);
104  uint8_t GetTxPowerLevel (void) const;
110  void SetTxPowerLevel (uint8_t powerlevel);
114  uint8_t GetRetries (void) const;
120  void SetRetries (uint8_t retries);
124  WifiPreamble GetPreambleType (void) const;
130  void SetPreambleType (WifiPreamble preamble);
134  uint8_t GetChannelWidth (void) const;
140  void SetChannelWidth (uint8_t channelWidth);
144  uint16_t GetGuardInterval (void) const;
150  void SetGuardInterval (uint16_t guardInterval);
154  uint8_t GetNTx (void) const;
160  void SetNTx (uint8_t nTx);
164  uint8_t GetNss (void) const;
170  void SetNss (uint8_t nss);
174  uint8_t GetNess (void) const;
180  void SetNess (uint8_t ness);
186  bool IsAggregation (void) const;
192  void SetAggregation (bool aggregation);
199  bool IsStbc (void) const;
205  void SetStbc (bool stbc);
206 
207 
208 private:
212  uint8_t m_txPowerLevel;
215  uint8_t m_retries;
218  uint8_t m_channelWidth;
219  uint16_t m_guardInterval;
220  uint8_t m_nTx;
221  uint8_t m_nss;
222  uint8_t m_ness;
224  bool m_stbc;
228 };
229 
238 std::ostream & operator << (std::ostream & os,const WifiTxVector &v);
239 
240 } //namespace ns3
241 
242 #endif /* WIFI_TX_VECTOR_H */
uint16_t GetGuardInterval(void) const
uint8_t m_nTx
number of TX antennas
uint8_t m_channelWidth
channel width in MHz
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
bool IsAggregation(void) const
Checks whether the PSDU contains A-MPDU.
void SetStbc(bool stbc)
Sets if STBC is being used.
represent a single transmission modeA WifiMode is implemented by a single integer which is used to lo...
Definition: wifi-mode.h:97
uint8_t GetTxPowerLevel(void) const
uint8_t m_nss
number of spatial streams
uint8_t GetChannelWidth(void) const
WifiPreamble
The type of preamble to be used by an IEEE 802.11 transmission.
Definition: wifi-preamble.h:30
void SetGuardInterval(uint16_t guardInterval)
Sets the guard interval duration (in nanoseconds)
uint8_t GetNess(void) const
uint16_t m_guardInterval
guard interval duration in nanoseconds
bool IsStbc(void) const
Check if STBC is used or not.
uint8_t m_retries
The DATA_RETRIES/RTS_RETRIES parameter for Click radiotap information.
void SetNss(uint8_t nss)
Sets the number of Nss refer to IEEE 802.11n Table 20-28 for explanation and range.
bool m_modeInitialized
Internal initialization flag.
std::ostream & operator<<(std::ostream &os, const Angles &a)
print a struct Angles to output
Definition: angles.cc:42
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetAggregation(bool aggregation)
Sets if PSDU contains A-MPDU.
void SetPreambleType(WifiPreamble preamble)
Sets the preamble type.
void SetTxPowerLevel(uint8_t powerlevel)
Sets the selected transmission power level.
void SetNTx(uint8_t nTx)
Sets the number of TX antennas.
bool m_aggregation
Flag whether the PSDU contains A-MPDU.
bool m_stbc
STBC used or not.
void SetMode(WifiMode mode)
Sets the selected payload transmission mode.
WifiPreamble GetPreambleType(void) const
uint8_t GetNss(void) const
uint8_t GetNTx(void) const
void SetNess(uint8_t ness)
Sets the Ness number refer to IEEE 802.11n Table 20-6 for explanation.
void SetRetries(uint8_t retries)
Sets the number of retries.
void SetChannelWidth(uint8_t channelWidth)
Sets the selected channelWidth (in MHz)
uint8_t GetRetries(void) const
uint8_t m_ness
number of spatial streams in beamforming
WifiMode GetMode(void) const
bool m_txPowerLevelInitialized
Internal initialization flag.
uint8_t m_txPowerLevel
The TXPWR_LEVEL parameter in Table 15-4.
WifiMode m_mode
The DATARATE parameter in Table 15-4.
WifiPreamble m_preamble
preamble