channel-condition-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 CHANNEL_CONDITION_MODEL_H
#define CHANNEL_CONDITION_MODEL_H

#include "ns3/object.h"
#include "ns3/random-variable-stream.h"
#include "ns3/vector.h"
#include "ns3/nstime.h"
#include <unordered_map>

namespace ns3 {

class MobilityModel;

class ChannelCondition : public Object
{

public:
  enum LosConditionValue
  {
    LOS, 
    NLOS, 
    NLOSv, 
    LC_ND 
  };
  
  enum O2iConditionValue
  {
    O2O, 
    O2I, 
    I2I, 
    O2I_ND 
  };

  static TypeId GetTypeId (void);

  ChannelCondition ();
  
  ChannelCondition (LosConditionValue losCondition, O2iConditionValue o2iCondition = O2O);

  virtual ~ChannelCondition ();

  LosConditionValue GetLosCondition () const;

  void SetLosCondition (LosConditionValue losCondition);
  
  O2iConditionValue GetO2iCondition () const;

  void SetO2iCondition (O2iConditionValue o2iCondition);
  
  bool IsLos () const;
  
  bool IsNlos () const;
  
  bool IsNlosv () const;
  
  bool IsO2i () const;
  
  bool IsO2o () const;
  
  bool IsI2i () const;
  
  bool IsEqual (Ptr<const ChannelCondition> otherCondition) const;

private:
  LosConditionValue m_losCondition; 
  O2iConditionValue m_o2iCondition; 
  
  friend std::ostream& operator<< (std::ostream& os, LosConditionValue cond);

};

class ChannelConditionModel : public Object
{
public:
  static TypeId GetTypeId (void);

  ChannelConditionModel ();

  virtual ~ChannelConditionModel ();

  virtual Ptr<ChannelCondition> GetChannelCondition (Ptr<const MobilityModel> a, Ptr<const MobilityModel> b) const = 0;

  virtual int64_t AssignStreams (int64_t stream) = 0;

  ChannelConditionModel (const ChannelConditionModel&) = delete;

  ChannelConditionModel &operator = (const ChannelConditionModel &) = delete;
};

class AlwaysLosChannelConditionModel : public ChannelConditionModel
{
public:
  static TypeId GetTypeId (void);

  AlwaysLosChannelConditionModel ();

  virtual ~AlwaysLosChannelConditionModel ();

  virtual Ptr<ChannelCondition> GetChannelCondition (Ptr<const MobilityModel> a, Ptr<const MobilityModel> b) const override;

  AlwaysLosChannelConditionModel (const AlwaysLosChannelConditionModel&) = delete;

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

  virtual int64_t AssignStreams (int64_t stream) override;
};

class NeverLosChannelConditionModel : public ChannelConditionModel
{
public:
  static TypeId GetTypeId (void);

  NeverLosChannelConditionModel ();

  virtual ~NeverLosChannelConditionModel ();

  virtual Ptr<ChannelCondition> GetChannelCondition (Ptr<const MobilityModel> a, Ptr<const MobilityModel> b) const override;

  NeverLosChannelConditionModel (const NeverLosChannelConditionModel&) = delete;

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

  virtual int64_t AssignStreams (int64_t stream) override;
};

class NeverLosVehicleChannelConditionModel : public ChannelConditionModel
{
public:
  static TypeId GetTypeId (void);

  NeverLosVehicleChannelConditionModel ();

  virtual ~NeverLosVehicleChannelConditionModel ();

  virtual Ptr<ChannelCondition> GetChannelCondition (Ptr<const MobilityModel> a, Ptr<const MobilityModel> b) const override;

  NeverLosVehicleChannelConditionModel (const NeverLosVehicleChannelConditionModel&) = delete;

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

  virtual int64_t AssignStreams (int64_t stream) override;
};

class ThreeGppChannelConditionModel : public ChannelConditionModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppChannelConditionModel ();

  virtual ~ThreeGppChannelConditionModel () override;

  virtual Ptr<ChannelCondition> GetChannelCondition (Ptr<const MobilityModel> a, Ptr<const MobilityModel> b) const override;

  virtual int64_t AssignStreams (int64_t stream) override;

protected:
  virtual void DoDispose () override;
  
  enum VehicleDensity
  {
    LOW,
    MEDIUM,
    HIGH,
    INVALID
  };

  static double Calculate2dDistance (const Vector &a, const Vector &b);
  
  Ptr<UniformRandomVariable> m_uniformVar; 

private:
  Ptr<ChannelCondition> ComputeChannelCondition (Ptr<const MobilityModel> a, Ptr<const MobilityModel> b) const;
  
  virtual double ComputePlos (Ptr<const MobilityModel> a, Ptr<const MobilityModel> b) const = 0;
  
  virtual double ComputePnlos (Ptr<const MobilityModel> a, Ptr<const MobilityModel> b) const;

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

  struct Item
  {
    Ptr<ChannelCondition> m_condition; 
    Time m_generatedTime; 
  };

  std::unordered_map<uint32_t, Item> m_channelConditionMap; 
  Time m_updatePeriod; 
};

class ThreeGppRmaChannelConditionModel : public ThreeGppChannelConditionModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppRmaChannelConditionModel ();

  virtual ~ThreeGppRmaChannelConditionModel () override;

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

class ThreeGppUmaChannelConditionModel : public ThreeGppChannelConditionModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppUmaChannelConditionModel ();

  virtual ~ThreeGppUmaChannelConditionModel () override;

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

class ThreeGppUmiStreetCanyonChannelConditionModel : public ThreeGppChannelConditionModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppUmiStreetCanyonChannelConditionModel ();

  virtual ~ThreeGppUmiStreetCanyonChannelConditionModel () override;

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

class ThreeGppIndoorMixedOfficeChannelConditionModel : public ThreeGppChannelConditionModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppIndoorMixedOfficeChannelConditionModel ();

  virtual ~ThreeGppIndoorMixedOfficeChannelConditionModel () override;

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

class ThreeGppIndoorOpenOfficeChannelConditionModel : public ThreeGppChannelConditionModel
{
public:
  static TypeId GetTypeId (void);

  ThreeGppIndoorOpenOfficeChannelConditionModel ();

  virtual ~ThreeGppIndoorOpenOfficeChannelConditionModel () override;

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

} // end ns3 namespace

#endif /* CHANNEL_CONDITION_MODEL_H */