three-gpp-spectrum-propagation-loss-model.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2015, NYU WIRELESS, Tandon School of Engineering,
 * New York University
 * Copyright (c) 2019 SIGNET Lab, Department of Information Engineering,
 * University of Padova
 *
 * 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
 */

#ifndef THREE_GPP_SPECTRUM_PROPAGATION_LOSS_H
#define THREE_GPP_SPECTRUM_PROPAGATION_LOSS_H

#include "ns3/spectrum-propagation-loss-model.h"
#include <complex.h>
#include <map>
#include <unordered_map>
#include "ns3/matrix-based-channel-model.h"
#include "ns3/random-variable-stream.h"

namespace ns3 {

class NetDevice;
class ChannelConditionModel;
class ChannelCondition;

class ThreeGppSpectrumPropagationLossModel : public SpectrumPropagationLossModel
{
public:
  ThreeGppSpectrumPropagationLossModel ();

  ~ThreeGppSpectrumPropagationLossModel ();
  
  void DoDispose () override;

  static TypeId GetTypeId ();

  void SetChannelModel (Ptr<MatrixBasedChannelModel> channel);

  Ptr<MatrixBasedChannelModel> GetChannelModel() const;

  void AddDevice (Ptr<NetDevice> n, Ptr<const ThreeGppAntennaArrayModel> a);


  void SetChannelModelAttribute (const std::string &name, const AttributeValue &value);

  void GetChannelModelAttribute (const std::string &name, AttributeValue &value) const;

  Ptr<SpectrumValue> DoCalcRxPowerSpectralDensity (Ptr<const SpectrumValue> txPsd,
                                                           Ptr<const MobilityModel> a,
                                                           Ptr<const MobilityModel> b) const override;

private:
  struct LongTerm : public SimpleRefCount<LongTerm>
  {
    ThreeGppAntennaArrayModel::ComplexVector m_longTerm; 
    Ptr<const MatrixBasedChannelModel::ChannelMatrix> m_channel; 
    ThreeGppAntennaArrayModel::ComplexVector m_sW; 
    ThreeGppAntennaArrayModel::ComplexVector m_uW; 
  };

  double GetFrequency () const;

  ThreeGppAntennaArrayModel::ComplexVector GetLongTerm (uint32_t aId, uint32_t bId,
                                                        Ptr<const MatrixBasedChannelModel::ChannelMatrix> channelMatrix,
                                                        const ThreeGppAntennaArrayModel::ComplexVector &aW,
                                                        const ThreeGppAntennaArrayModel::ComplexVector &bW) const;
  ThreeGppAntennaArrayModel::ComplexVector CalcLongTerm (Ptr<const MatrixBasedChannelModel::ChannelMatrix> channelMatrix,
                                                         const ThreeGppAntennaArrayModel::ComplexVector &sW,
                                                         const ThreeGppAntennaArrayModel::ComplexVector &uW) const;

  Ptr<SpectrumValue> CalcBeamformingGain (Ptr<SpectrumValue> txPsd,
                                          ThreeGppAntennaArrayModel::ComplexVector longTerm,
                                          Ptr<const MatrixBasedChannelModel::ChannelMatrix> params,
                                          const Vector &sSpeed, const Vector &uSpeed) const;

  std::unordered_map <uint32_t, Ptr<const ThreeGppAntennaArrayModel> > m_deviceAntennaMap; 
  mutable std::unordered_map < uint32_t, Ptr<const LongTerm> > m_longTermMap; 
  Ptr<MatrixBasedChannelModel> m_channelModel; 
  
  // Variable used to compute the additional Doppler contribution for the delayed 
  // (reflected) paths, as described in 3GPP TR 37.885 v15.3.0, Sec. 6.2.3.
  double m_vScatt; 
  Ptr<UniformRandomVariable> m_uniformRv; 
};
} // namespace ns3

#endif /* THREE_GPP_SPECTRUM_PROPAGATION_LOSS_H */