A Discrete-Event Network Simulator
API
ofdm-ppdu.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2020 Orange Labs
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: Rediet <getachew.redieteab@orange.com>
19 * Muhammad Iqbal Rochman <muhiqbalcr@uchicago.edu>
20 * S├ębastien Deronne <sebastien.deronne@gmail.com> (LSigHeader)
21 */
22
23#ifndef OFDM_PPDU_H
24#define OFDM_PPDU_H
25
26#include "ns3/wifi-phy-band.h"
27#include "ns3/wifi-ppdu.h"
28#include "ns3/header.h"
29
36namespace ns3 {
37
38class WifiPsdu;
39
47class OfdmPpdu : public WifiPpdu
48{
49public:
50
55 class LSigHeader : public Header
56 {
57 public:
58 LSigHeader ();
59 virtual ~LSigHeader ();
60
65 static TypeId GetTypeId (void);
66
67 TypeId GetInstanceTypeId (void) const override;
68 void Print (std::ostream &os) const override;
69 uint32_t GetSerializedSize (void) const override;
70 void Serialize (Buffer::Iterator start) const override;
72
79 void SetRate (uint64_t rate, uint16_t channelWidth = 20);
86 uint64_t GetRate (uint16_t channelWidth = 20) const;
92 void SetLength (uint16_t length);
98 uint16_t GetLength (void) const;
99
100 private:
101 uint8_t m_rate;
102 uint16_t m_length;
103 }; //class LSigHeader
104
115 OfdmPpdu (Ptr<const WifiPsdu> psdu, const WifiTxVector& txVector, WifiPhyBand band, uint64_t uid,
116 bool instantiateLSig = true);
120 virtual ~OfdmPpdu ();
121
122 Time GetTxDuration (void) const override;
123 Ptr<WifiPpdu> Copy (void) const override;
124
125protected:
127 uint16_t m_channelWidth;
129
130private:
131 WifiTxVector DoGetTxVector (void) const override;
132}; //class OfdmPpdu
133
134} //namespace ns3
135
136#endif /* OFDM_PPDU_H */
iterator in a Buffer instance
Definition: buffer.h:99
Protocol header serialization and deserialization.
Definition: header.h:43
OFDM and ERP OFDM L-SIG PHY header.
Definition: ofdm-ppdu.h:56
void SetRate(uint64_t rate, uint16_t channelWidth=20)
Fill the RATE field of L-SIG (in bit/s).
Definition: ofdm-ppdu.cc:120
uint64_t GetRate(uint16_t channelWidth=20) const
Return the RATE field of L-SIG (in bit/s).
Definition: ofdm-ppdu.cc:173
uint8_t m_rate
RATE field.
Definition: ofdm-ppdu.h:101
void Print(std::ostream &os) const override
Definition: ofdm-ppdu.cc:107
static TypeId GetTypeId(void)
Get the type ID.
Definition: ofdm-ppdu.cc:90
uint32_t Deserialize(Buffer::Iterator start) override
Definition: ofdm-ppdu.cc:245
TypeId GetInstanceTypeId(void) const override
Get the most derived TypeId for this Object.
Definition: ofdm-ppdu.cc:101
uint32_t GetSerializedSize(void) const override
Definition: ofdm-ppdu.cc:114
void SetLength(uint16_t length)
Fill the LENGTH field of L-SIG (in bytes).
Definition: ofdm-ppdu.cc:218
void Serialize(Buffer::Iterator start) const override
Definition: ofdm-ppdu.cc:231
uint16_t m_length
LENGTH field.
Definition: ofdm-ppdu.h:102
uint16_t GetLength(void) const
Return the LENGTH field of L-SIG (in bytes).
Definition: ofdm-ppdu.cc:225
OFDM PPDU (11a)
Definition: ofdm-ppdu.h:48
WifiPhyBand m_band
the WifiPhyBand used to transmit that PPDU
Definition: ofdm-ppdu.h:126
OfdmPpdu(Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, WifiPhyBand band, uint64_t uid, bool instantiateLSig=true)
Create an OFDM PPDU.
Definition: ofdm-ppdu.cc:33
WifiTxVector DoGetTxVector(void) const override
Get the TXVECTOR used to send the PPDU.
Definition: ofdm-ppdu.cc:53
LSigHeader m_lSig
the L-SIG PHY header
Definition: ofdm-ppdu.h:128
Time GetTxDuration(void) const override
Get the total transmission duration of the PPDU.
Definition: ofdm-ppdu.cc:65
uint16_t m_channelWidth
the channel width used to transmit that PPDU in MHz
Definition: ofdm-ppdu.h:127
Ptr< WifiPpdu > Copy(void) const override
Copy this instance.
Definition: ofdm-ppdu.cc:74
virtual ~OfdmPpdu()
Destructor for OfdmPpdu.
Definition: ofdm-ppdu.cc:48
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
a unique identifier for an interface.
Definition: type-id.h:59
WifiPpdu stores a preamble, a modulation class, PHY headers and a PSDU.
Definition: wifi-ppdu.h:52
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.
def start()
Definition: core.py:1853