spectrum-wifi-phy.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005,2006 INRIA
 *
 * 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
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 *          Ghada Badawy <gbadawy@gmail.com>
 *          Sébastien Deronne <sebastien.deronne@gmail.com>
 *
 * Ported from yans-wifi-phy.h by several contributors starting
 * with Nicola Baldo and Dean Armstrong
 */
 
#ifndef SPECTRUM_WIFI_PHY_H
#define SPECTRUM_WIFI_PHY_H
 
#include "wifi-phy.h"
 
#include "ns3/antenna-model.h"
 
#include <map>
#include <optional>
 
class SpectrumWifiPhyFilterTest;
 
namespace ns3
{
 
class SpectrumChannel;
struct SpectrumSignalParameters;
class WifiSpectrumPhyInterface;
struct WifiSpectrumSignalParameters;
 
using HeRuBands = std::map<WifiSpectrumBandInfo, HeRu::RuSpec>;
 
class SpectrumWifiPhy : public WifiPhy
{
  public:
    friend class ::SpectrumWifiPhyFilterTest;
 
    static TypeId GetTypeId();
 
    SpectrumWifiPhy();
    ~SpectrumWifiPhy() override;
 
    // Implementation of pure virtual method.
    void SetDevice(const Ptr<WifiNetDevice> device) override;
    void StartTx(Ptr<const WifiPpdu> ppdu) override;
    Ptr<Channel> GetChannel() const override;
    uint16_t GetGuardBandwidth(uint16_t currentChannelWidth) const override;
    std::tuple<double, double, double> GetTxMaskRejectionParams() const override;
    WifiSpectrumBandInfo GetBand(uint16_t bandWidth, uint8_t bandIndex = 0) override;
    FrequencyRange GetCurrentFrequencyRange() const override;
    WifiSpectrumBandFrequencies ConvertIndicesToFrequencies(
        const WifiSpectrumBandIndices& indices) const override;
 
    void AddChannel(const Ptr<SpectrumChannel> channel,
                    const FrequencyRange& freqRange = WHOLE_WIFI_SPECTRUM);
 
    void StartRx(Ptr<SpectrumSignalParameters> rxParams,
                 Ptr<const WifiSpectrumPhyInterface> interface);
 
    void SetAntenna(const Ptr<AntennaModel> antenna);
    Ptr<AntennaModel> GetAntenna() const;
 
    typedef void (*SignalArrivalCallback)(bool signalType,
                                          uint32_t senderNodeId,
                                          double rxPower,
                                          Time duration);
 
    void ConfigureInterface(uint16_t frequency, uint16_t width);
 
    void Transmit(Ptr<WifiSpectrumSignalParameters> txParams);
 
    Ptr<const WifiPpdu> GetRxPpduFromTxPpdu(Ptr<const WifiPpdu> ppdu);
 
    Ptr<WifiSpectrumPhyInterface> GetCurrentInterface() const;
 
    const std::map<FrequencyRange, Ptr<WifiSpectrumPhyInterface>>& GetSpectrumPhyInterfaces() const;
 
    void SetChannelSwitchedCallback(Callback<void> callback);
 
  protected:
    void DoDispose() override;
    void DoInitialize() override;
 
    // The following method calls the base WifiPhy class method
    // but also generates a new SpectrumModel if called during runtime
    void DoChannelSwitch() override;
 
    std::map<FrequencyRange, Ptr<WifiSpectrumPhyInterface>>
        m_spectrumPhyInterfaces; 
 
    Ptr<WifiSpectrumPhyInterface>
        m_currentSpectrumPhyInterface; 
 
  private:
    void ResetSpectrumModel(Ptr<WifiSpectrumPhyInterface> spectrumPhyInterface,
                            uint16_t centerFrequency,
                            uint16_t channelWidth);
 
    void UpdateInterferenceHelperBands(Ptr<WifiSpectrumPhyInterface> spectrumPhyInterface);
 
    HeRuBands GetHeRuBands(Ptr<WifiSpectrumPhyInterface> spectrumPhyInterface,
                           uint16_t guardBandwidth);
 
    WifiSpectrumBands ComputeBands(Ptr<WifiSpectrumPhyInterface> spectrumPhyInterface);
 
    WifiSpectrumBandInfo GetBandForInterface(Ptr<WifiSpectrumPhyInterface> spectrumPhyInterface,
                                             uint16_t bandWidth,
                                             uint8_t bandIndex = 0);
 
    WifiSpectrumBandFrequencies ConvertIndicesToFrequenciesForInterface(
        Ptr<WifiSpectrumPhyInterface> spectrumPhyInterface,
        const WifiSpectrumBandIndices& indices) const;
 
    bool CanStartRx(Ptr<const WifiPpdu> ppdu) const;
 
    Ptr<WifiSpectrumPhyInterface> GetInterfaceCoveringChannelBand(uint16_t frequency,
                                                                  uint16_t width) const;
 
    void NotifyChannelSwitched();
 
    Ptr<AntennaModel> m_antenna; 
 
    bool m_disableWifiReception;           
    bool m_trackSignalsInactiveInterfaces; 
 
    TracedCallback<bool, uint32_t, double, Time> m_signalCb; 
 
    double m_txMaskInnerBandMinimumRejection; 
    double m_txMaskOuterBandMinimumRejection; 
    double m_txMaskOuterBandMaximumRejection; 
 
    Callback<void> m_channelSwitchedCallback; 
};
 
} // namespace ns3
 
#endif /* SPECTRUM_WIFI_PHY_H */