wifi-ppdu.h

Go to the documentation of this file.

/*
 * 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 <optional>
#include <unordered_map>
 
namespace ns3
{
 
class Packet;
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,
             uint16_t txCenterFreq,
             uint64_t uid = UINT64_MAX);
    WifiPpdu(const WifiConstPsduMap& psdus,
             const WifiTxVector& txVector,
             uint16_t txCenterFreq,
             uint64_t uid);
    virtual ~WifiPpdu();
 
    const WifiTxVector& GetTxVector() const;
 
    void ResetTxVector() const;
 
    void UpdateTxVector(const WifiTxVector& updatedTxVector) const;
 
    Ptr<const WifiPsdu> GetPsdu() const;
 
    bool IsTruncatedTx() const;
 
    void SetTruncatedTx();
 
    virtual Time GetTxDuration() const;
 
    virtual uint16_t GetTransmissionChannelWidth() const;
 
    uint16_t GetTxCenterFreq() const;
 
    bool DoesOverlapChannel(uint16_t minFreq, uint16_t maxFreq) const;
 
    WifiModulationClass GetModulation() const;
 
    uint64_t GetUid() const;
 
    WifiPreamble GetPreamble() const;
 
    void Print(std::ostream& os) const;
    virtual Ptr<WifiPpdu> Copy() const;
 
    virtual WifiPpduType GetType() const;
 
    virtual uint16_t GetStaId() const;
 
  protected:
    virtual std::string PrintPayload() const;
 
    WifiPreamble m_preamble;          
    WifiModulationClass m_modulation; 
    WifiConstPsduMap m_psdus;         
    uint16_t m_txCenterFreq; 
    uint64_t m_uid;          
    mutable std::optional<WifiTxVector>
        m_txVector; 
 
#ifdef NS3_BUILD_PROFILE_DEBUG
    Ptr<Packet> m_phyHeaders; 
#endif
 
  private:
    virtual WifiTxVector DoGetTxVector() 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 */