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 
36 namespace ns3 {
37 
38 class WifiPsdu;
39 
47 class OfdmPpdu : public WifiPpdu
48 {
49 public:
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;
71  uint32_t Deserialize (Buffer::Iterator start) 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 
125 protected:
127  uint16_t m_channelWidth;
129 
130 private:
131  WifiTxVector DoGetTxVector (void) const override;
132 }; //class OfdmPpdu
133 
134 } //namespace ns3
135 
136 #endif /* OFDM_PPDU_H */
ns3::OfdmPpdu
OFDM PPDU (11a)
Definition: ofdm-ppdu.h:48
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::OfdmPpdu::LSigHeader::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: ofdm-ppdu.cc:90
ns3::OfdmPpdu::DoGetTxVector
WifiTxVector DoGetTxVector(void) const override
Get the TXVECTOR used to send the PPDU.
Definition: ofdm-ppdu.cc:53
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::OfdmPpdu::LSigHeader::Print
void Print(std::ostream &os) const override
Definition: ofdm-ppdu.cc:107
ns3::OfdmPpdu::OfdmPpdu
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
ns3::OfdmPpdu::LSigHeader::LSigHeader
LSigHeader()
Definition: ofdm-ppdu.cc:79
ns3::OfdmPpdu::LSigHeader::SetRate
void SetRate(uint64_t rate, uint16_t channelWidth=20)
Fill the RATE field of L-SIG (in bit/s).
Definition: ofdm-ppdu.cc:120
ns3::OfdmPpdu::m_channelWidth
uint16_t m_channelWidth
the channel width used to transmit that PPDU in MHz
Definition: ofdm-ppdu.h:127
ns3::WifiPpdu
WifiPpdu stores a preamble, a modulation class, PHY headers and a PSDU.
Definition: wifi-ppdu.h:52
ns3::WifiTxVector
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
Definition: wifi-tx-vector.h:71
ns3::OfdmPpdu::LSigHeader::GetSerializedSize
uint32_t GetSerializedSize(void) const override
Definition: ofdm-ppdu.cc:114
ns3::Ptr< const WifiPsdu >
ns3::OfdmPpdu::~OfdmPpdu
virtual ~OfdmPpdu()
Destructor for OfdmPpdu.
Definition: ofdm-ppdu.cc:48
visualizer.core.start
def start()
Definition: core.py:1855
ns3::OfdmPpdu::LSigHeader::GetLength
uint16_t GetLength(void) const
Return the LENGTH field of L-SIG (in bytes).
Definition: ofdm-ppdu.cc:225
ns3::OfdmPpdu::LSigHeader::GetInstanceTypeId
TypeId GetInstanceTypeId(void) const override
Get the most derived TypeId for this Object.
Definition: ofdm-ppdu.cc:101
ns3::OfdmPpdu::m_lSig
LSigHeader m_lSig
the L-SIG PHY header
Definition: ofdm-ppdu.h:128
ns3::OfdmPpdu::GetTxDuration
Time GetTxDuration(void) const override
Get the total transmission duration of the PPDU.
Definition: ofdm-ppdu.cc:65
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
ns3::Header
Protocol header serialization and deserialization.
Definition: header.h:43
ns3::OfdmPpdu::LSigHeader
OFDM and ERP OFDM L-SIG PHY header.
Definition: ofdm-ppdu.h:56
ns3::OfdmPpdu::LSigHeader::SetLength
void SetLength(uint16_t length)
Fill the LENGTH field of L-SIG (in bytes).
Definition: ofdm-ppdu.cc:218
ns3::Header::Deserialize
virtual uint32_t Deserialize(Buffer::Iterator start)=0
Deserialize the object from a buffer iterator.
ns3::Buffer::Iterator
iterator in a Buffer instance
Definition: buffer.h:99
ns3::OfdmPpdu::m_band
WifiPhyBand m_band
the WifiPhyBand used to transmit that PPDU
Definition: ofdm-ppdu.h:126
ns3::OfdmPpdu::LSigHeader::Serialize
void Serialize(Buffer::Iterator start) const override
Definition: ofdm-ppdu.cc:231
ns3::OfdmPpdu::LSigHeader::m_length
uint16_t m_length
LENGTH field.
Definition: ofdm-ppdu.h:102
ns3::WifiPhyBand
WifiPhyBand
Identifies the PHY band.
Definition: wifi-phy-band.h:33
ns3::OfdmPpdu::LSigHeader::~LSigHeader
virtual ~LSigHeader()
Definition: ofdm-ppdu.cc:85
ns3::OfdmPpdu::Copy
Ptr< WifiPpdu > Copy(void) const override
Copy this instance.
Definition: ofdm-ppdu.cc:74
ns3::OfdmPpdu::LSigHeader::GetRate
uint64_t GetRate(uint16_t channelWidth=20) const
Return the RATE field of L-SIG (in bit/s).
Definition: ofdm-ppdu.cc:173
ns3::OfdmPpdu::LSigHeader::m_rate
uint8_t m_rate
RATE field.
Definition: ofdm-ppdu.h:101