matrix-based-channel-model.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2020 SIGNET Lab, Department of Information Engineering,
 * University of Padova
 * Copyright (c) 2020 Institute for the Wireless Internet of Things,
 * Northeastern University
 *
 * 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 MATRIX_BASED_CHANNEL_H
#define MATRIX_BASED_CHANNEL_H
 
#include <complex.h>
#include <ns3/object.h>
#include <ns3/nstime.h>
#include <ns3/vector.h>
#include <ns3/phased-array-model.h>
#include <tuple>
 
namespace ns3 {
 
class MobilityModel;
 
class MatrixBasedChannelModel : public Object
{
public:
  virtual ~MatrixBasedChannelModel ();
 
  typedef std::vector<double> DoubleVector; 
  typedef std::vector<DoubleVector> Double2DVector; 
  typedef std::vector<Double2DVector> Double3DVector; 
  typedef std::vector<PhasedArrayModel::ComplexVector> Complex2DVector; 
  typedef std::vector<Complex2DVector> Complex3DVector; 
 
  struct ChannelMatrix : public SimpleRefCount<ChannelMatrix>
  {
    Complex3DVector    m_channel; 
    Time               m_generatedTime; 
    std::pair<uint32_t, uint32_t> m_antennaPair; 
    std::pair<uint32_t, uint32_t> m_nodeIds; 
 
    virtual ~ChannelMatrix () = default;
    
    bool IsReverse (uint32_t aAntennaId, uint32_t bAntennaId) const
    {
      uint32_t sAntennaId, uAntennaId;
      std::tie (sAntennaId, uAntennaId) = m_antennaPair;
      NS_ASSERT_MSG ((sAntennaId == aAntennaId && uAntennaId == bAntennaId) || (sAntennaId == bAntennaId && uAntennaId == aAntennaId),
                      "This channel matrix does not represent the channel among the antenna arrays for which are provided IDs.");
      return (sAntennaId == bAntennaId && uAntennaId == aAntennaId);
    }
  };
 
 
  struct ChannelParams : public SimpleRefCount<ChannelParams>
  {
    Time               m_generatedTime; 
    DoubleVector       m_delay; 
    Double2DVector     m_angle; 
    DoubleVector m_alpha; 
    DoubleVector m_D; 
    std::pair<uint32_t, uint32_t> m_nodeIds; 
    virtual ~ChannelParams () = default;
  };
 
  virtual Ptr<const ChannelMatrix> GetChannel (Ptr<const MobilityModel> aMob,
                                               Ptr<const MobilityModel> bMob,
                                               Ptr<const PhasedArrayModel> aAntenna,
                                               Ptr<const PhasedArrayModel> bAntenna) = 0;
  
  virtual Ptr<const ChannelParams> GetParams (Ptr<const MobilityModel> aMob,
                                              Ptr<const MobilityModel> bMob) const = 0;
 
  static uint64_t GetKey (uint32_t a, uint32_t b)
  {
   return (uint64_t) std::min (a, b) << 32 | std::max (a, b);
  }
 
  static const uint8_t AOA_INDEX = 0; 
  static const uint8_t ZOA_INDEX = 1; 
  static const uint8_t AOD_INDEX = 2; 
  static const uint8_t ZOD_INDEX = 3; 
 
};
 
}; // namespace ns3
 
#endif // MATRIX_BASED_CHANNEL_H