A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ofdm-ppdu.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2020 Orange Labs
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: Rediet <getachew.redieteab@orange.com>
18 * Muhammad Iqbal Rochman <muhiqbalcr@uchicago.edu>
19 * Sébastien Deronne <sebastien.deronne@gmail.com> (LSigHeader)
20 */
21
22#ifndef OFDM_PPDU_H
23#define OFDM_PPDU_H
24
25#include "ns3/header.h"
26#include "ns3/wifi-phy-band.h"
27#include "ns3/wifi-ppdu.h"
28
35namespace ns3
36{
37
38class WifiPsdu;
39
47class OfdmPpdu : public WifiPpdu
48{
49 public:
54 class LSigHeader : public Header
55 {
56 public:
57 LSigHeader();
58
63 static TypeId GetTypeId();
64
65 TypeId GetInstanceTypeId() const override;
66 void Print(std::ostream& os) const override;
67 uint32_t GetSerializedSize() const override;
68 void Serialize(Buffer::Iterator start) const override;
70
77 void SetRate(uint64_t rate, uint16_t channelWidth = 20);
84 uint64_t GetRate(uint16_t channelWidth = 20) const;
90 void SetLength(uint16_t length);
96 uint16_t GetLength() const;
97
98 private:
99 uint8_t m_rate;
100 uint16_t m_length;
101 }; // class LSigHeader
102
115 const WifiTxVector& txVector,
116 uint16_t txCenterFreq,
117 WifiPhyBand band,
118 uint64_t uid,
119 bool instantiateLSig = true);
120
121 Time GetTxDuration() const override;
122 Ptr<WifiPpdu> Copy() const override;
123
124 protected:
126#ifndef NS3_BUILD_PROFILE_DEBUG
127 LSigHeader m_lSig;
128#endif
129
130 private:
131 WifiTxVector DoGetTxVector() const override;
132
139 void SetPhyHeaders(const WifiTxVector& txVector, std::size_t psduSize);
140
148 void SetLSigHeader(LSigHeader& lSig, const WifiTxVector& txVector, std::size_t psduSize) const;
149
156 virtual void SetTxVectorFromLSigHeader(WifiTxVector& txVector, const LSigHeader& lSig) const;
157
158 uint16_t m_channelWidth;
160}; // class OfdmPpdu
161
162} // namespace ns3
163
164#endif /* OFDM_PPDU_H */
iterator in a Buffer instance
Definition: buffer.h:100
Protocol header serialization and deserialization.
Definition: header.h:44
OFDM and ERP OFDM L-SIG PHY header.
Definition: ofdm-ppdu.h:55
void SetRate(uint64_t rate, uint16_t channelWidth=20)
Fill the RATE field of L-SIG (in bit/s).
Definition: ofdm-ppdu.cc:159
uint64_t GetRate(uint16_t channelWidth=20) const
Return the RATE field of L-SIG (in bit/s).
Definition: ofdm-ppdu.cc:212
uint16_t GetLength() const
Return the LENGTH field of L-SIG (in bytes).
Definition: ofdm-ppdu.cc:264
uint8_t m_rate
RATE field.
Definition: ofdm-ppdu.h:99
void Print(std::ostream &os) const override
Definition: ofdm-ppdu.cc:147
uint32_t Deserialize(Buffer::Iterator start) override
Definition: ofdm-ppdu.cc:284
TypeId GetInstanceTypeId() const override
Get the most derived TypeId for this Object.
Definition: ofdm-ppdu.cc:141
uint32_t GetSerializedSize() const override
Definition: ofdm-ppdu.cc:153
void SetLength(uint16_t length)
Fill the LENGTH field of L-SIG (in bytes).
Definition: ofdm-ppdu.cc:257
static TypeId GetTypeId()
Get the type ID.
Definition: ofdm-ppdu.cc:131
void Serialize(Buffer::Iterator start) const override
Definition: ofdm-ppdu.cc:270
uint16_t m_length
LENGTH field.
Definition: ofdm-ppdu.h:100
OFDM PPDU (11a)
Definition: ofdm-ppdu.h:48
WifiPhyBand m_band
the WifiPhyBand used to transmit that PPDU
Definition: ofdm-ppdu.h:125
void SetLSigHeader(LSigHeader &lSig, const WifiTxVector &txVector, std::size_t psduSize) const
Fill in the L-SIG header.
Definition: ofdm-ppdu.cc:67
void SetPhyHeaders(const WifiTxVector &txVector, std::size_t psduSize)
Fill in the PHY headers.
Definition: ofdm-ppdu.cc:53
Time GetTxDuration() const override
Get the total transmission duration of the PPDU.
Definition: ofdm-ppdu.cc:104
uint16_t m_channelWidth
the channel width used to transmit that PPDU in MHz (needed to distinguish 5 MHz, 10 MHz or 20 MHz PP...
Definition: ofdm-ppdu.h:158
Ptr< WifiPpdu > Copy() const override
Copy this instance.
Definition: ofdm-ppdu.cc:119
virtual void SetTxVectorFromLSigHeader(WifiTxVector &txVector, const LSigHeader &lSig) const
Fill in the TXVECTOR from L-SIG header.
Definition: ofdm-ppdu.cc:95
WifiTxVector DoGetTxVector() const override
Get the TXVECTOR used to send the PPDU.
Definition: ofdm-ppdu.cc:74
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:60
WifiPpdu stores a preamble, a modulation class, PHY headers and a PSDU.
Definition: wifi-ppdu.h:56
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
WifiPhyBand
Identifies the PHY band.
Definition: wifi-phy-band.h:33
Every class exported by the ns3 library is enclosed in the ns3 namespace.