three-gpp-propagation-loss-model.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * 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_PROPAGATION_LOSS_MODEL_H
#define THREE_GPP_PROPAGATION_LOSS_MODEL_H

#include "ns3/propagation-loss-model.h"
#include "ns3/channel-condition-model.h"

namespace ns3 {

class ThreeGppPropagationLossModel : public PropagationLossModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppPropagationLossModel ();

  virtual ~ThreeGppPropagationLossModel () override;

  void SetChannelConditionModel (Ptr<ChannelConditionModel> model);

  Ptr<ChannelConditionModel> GetChannelConditionModel (void) const;

  void SetFrequency (double f);

  double GetFrequency (void) const;

  ThreeGppPropagationLossModel (const ThreeGppPropagationLossModel &) = delete;

  ThreeGppPropagationLossModel & operator = (const ThreeGppPropagationLossModel &) = delete;

private:
  virtual double DoCalcRxPower (double txPowerDbm,
                                Ptr<MobilityModel> a,
                                Ptr<MobilityModel> b) const override;

  virtual int64_t DoAssignStreams (int64_t stream) override;
  
  double GetLoss (Ptr<ChannelCondition> cond, double distance2D, double distance3D, double hUt, double hBs) const;

  virtual double GetLossLos (double distance2D, double distance3D, double hUt, double hBs) const = 0;

  virtual double GetLossNlos (double distance2D, double distance3D, double hUt, double hBs) const = 0;
  
  virtual double GetLossNlosv (double distance2D, double distance3D, double hUt, double hBs) const;

  virtual std::pair<double, double> GetUtAndBsHeights (double za, double zb) const;

  double GetShadowing (Ptr<MobilityModel> a, Ptr<MobilityModel> b, ChannelCondition::LosConditionValue cond) const;

  virtual double GetShadowingStd (Ptr<MobilityModel> a, Ptr<MobilityModel> b, ChannelCondition::LosConditionValue cond) const = 0;

  virtual double GetShadowingCorrelationDistance (ChannelCondition::LosConditionValue cond) const = 0;

  static uint32_t GetKey (Ptr<MobilityModel> a, Ptr<MobilityModel> b);

  static Vector GetVectorDifference (Ptr<MobilityModel> a, Ptr<MobilityModel> b);

protected:
  virtual void DoDispose () override; 
  
  static double Calculate2dDistance (Vector a, Vector b);

  Ptr<ChannelConditionModel> m_channelConditionModel; 
  double m_frequency; 
  bool m_shadowingEnabled; 
  Ptr<NormalRandomVariable> m_normRandomVariable; 

  struct ShadowingMapItem
  {
    double m_shadowing; 
    ChannelCondition::LosConditionValue m_condition; 
    Vector m_distance; 
  };

  mutable std::unordered_map<uint32_t, ShadowingMapItem> m_shadowingMap; 
};

class ThreeGppRmaPropagationLossModel : public ThreeGppPropagationLossModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppRmaPropagationLossModel ();

  virtual ~ThreeGppRmaPropagationLossModel () override;

  ThreeGppRmaPropagationLossModel (const ThreeGppRmaPropagationLossModel &) = delete;

  ThreeGppRmaPropagationLossModel & operator = (const ThreeGppRmaPropagationLossModel &) = delete;

private:
  virtual double GetLossLos (double distance2D, double distance3D, double hUt, double hBs) const override;

  virtual double GetLossNlos (double distance2D, double distance3D, double hUt, double hBs) const override;

  virtual double GetShadowingStd (Ptr<MobilityModel> a, Ptr<MobilityModel> b, ChannelCondition::LosConditionValue cond) const override;

  virtual double GetShadowingCorrelationDistance (ChannelCondition::LosConditionValue cond) const override;

  static double Pl1 (double frequency, double distance3D, double h, double w);

  static double GetBpDistance (double frequency, double hA, double hB);

  double m_h; 
  double m_w; 
};

class ThreeGppUmaPropagationLossModel : public ThreeGppPropagationLossModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppUmaPropagationLossModel ();

  virtual ~ThreeGppUmaPropagationLossModel () override;

  ThreeGppUmaPropagationLossModel (const ThreeGppUmaPropagationLossModel &) = delete;

  ThreeGppUmaPropagationLossModel & operator = (const ThreeGppUmaPropagationLossModel &) = delete;

private:
  virtual int64_t DoAssignStreams (int64_t stream) override;

  double GetLossLos (double distance2D, double distance3D, double hUt, double hBs) const override;

  double GetLossNlos (double distance2D, double distance3D, double hUt, double hBs) const override;

  virtual double GetShadowingStd (Ptr<MobilityModel> a, Ptr<MobilityModel> b, ChannelCondition::LosConditionValue cond) const override;

  virtual double GetShadowingCorrelationDistance (ChannelCondition::LosConditionValue cond) const override;

  double GetBpDistance (double hUt, double hBs, double distance2D) const;

  Ptr<UniformRandomVariable> m_uniformVar; 
};

class ThreeGppUmiStreetCanyonPropagationLossModel : public ThreeGppPropagationLossModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppUmiStreetCanyonPropagationLossModel ();

  virtual ~ThreeGppUmiStreetCanyonPropagationLossModel () override;

  ThreeGppUmiStreetCanyonPropagationLossModel (const ThreeGppUmiStreetCanyonPropagationLossModel &) = delete;

  ThreeGppUmiStreetCanyonPropagationLossModel & operator = (const ThreeGppUmiStreetCanyonPropagationLossModel &) = delete;

private:
  double GetLossLos (double distance2D, double distance3D, double hUt, double hBs) const override;

  double GetLossNlos (double distance2D, double distance3D, double hUt, double hBs) const override;

  virtual double GetShadowingStd (Ptr<MobilityModel> a, Ptr<MobilityModel> b, ChannelCondition::LosConditionValue cond) const override;

  virtual double GetShadowingCorrelationDistance (ChannelCondition::LosConditionValue cond) const override;

  double GetBpDistance (double hUt, double hBs, double distance2D) const;

  std::pair<double, double> GetUtAndBsHeights (double za, double zb) const override;
};

class ThreeGppIndoorOfficePropagationLossModel : public ThreeGppPropagationLossModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppIndoorOfficePropagationLossModel ();

  virtual ~ThreeGppIndoorOfficePropagationLossModel () override;

  ThreeGppIndoorOfficePropagationLossModel (const ThreeGppIndoorOfficePropagationLossModel &) = delete;

  ThreeGppIndoorOfficePropagationLossModel & operator = (const ThreeGppIndoorOfficePropagationLossModel &) = delete;

private:
  double GetLossLos (double distance2D, double distance3D, double hUt, double hBs) const override;

  double GetLossNlos (double distance2D, double distance3D, double hUt, double hBs) const override;

  virtual double GetShadowingStd (Ptr<MobilityModel> a, Ptr<MobilityModel> b, ChannelCondition::LosConditionValue cond) const override;

  virtual double GetShadowingCorrelationDistance (ChannelCondition::LosConditionValue cond) const override;
};

} // namespace ns3

#endif /* THREE_GPP_PROPAGATION_LOSS_MODEL_H */