wifi-ppdu.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2019 Orange Labs
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Rediet <getachew.redieteab@orange.com>
 */

#ifndef WIFI_PPDU_H
#define WIFI_PPDU_H

#include "wifi-tx-vector.h"
#include "ns3/nstime.h"
#include <list>
#include <unordered_map>

namespace ns3 {

class WifiPsdu;

typedef std::unordered_map <uint16_t /* STA-ID */, Ptr<const WifiPsdu> /* PSDU */> WifiConstPsduMap;

class WifiPpdu : public SimpleRefCount<WifiPpdu>
{
public:
  WifiPpdu (Ptr<const WifiPsdu> psdu, const WifiTxVector& txVector, uint64_t uid = UINT64_MAX);
  WifiPpdu (const WifiConstPsduMap & psdus, const WifiTxVector& txVector, uint64_t uid);
  virtual ~WifiPpdu ();

  WifiTxVector GetTxVector (void) const;

  Ptr<const WifiPsdu> GetPsdu (void) const;

  bool IsTruncatedTx (void) const;

  void SetTruncatedTx (void);

  virtual Time GetTxDuration (void) const;

  virtual uint16_t GetTransmissionChannelWidth (void) const;

  virtual bool CanBeReceived (uint16_t txCenterFreq, uint16_t p20MinFreq,
                              uint16_t p20MaxFreq) const;

  WifiModulationClass GetModulation (void) const;

  uint64_t GetUid (void) const;

  WifiPreamble GetPreamble (void) const;

  void Print (std::ostream &os) const;
  virtual Ptr<WifiPpdu> Copy (void) const;

  virtual WifiPpduType GetType (void) const;

  virtual uint16_t GetStaId (void) const;

protected:
  virtual std::string PrintPayload (void) const;

  WifiPreamble m_preamble;          
  WifiModulationClass m_modulation; 
  WifiConstPsduMap m_psdus;         
  uint64_t m_uid;                   

private:
  virtual WifiTxVector DoGetTxVector (void) const;

  bool m_truncatedTx;     
  uint8_t m_txPowerLevel; 
  uint8_t m_txAntennas;   
}; //class WifiPpdu

std::ostream& operator<< (std::ostream& os, const Ptr<const WifiPpdu> &ppdu);

std::ostream & operator << (std::ostream &os, const WifiConstPsduMap &psdus);

} //namespace ns3

#endif /* WIFI_PPDU_H */