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/three-gpp-antenna-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<ThreeGppAntennaArrayModel::ComplexVector> Complex2DVector; 
  typedef std::vector<Complex2DVector> Complex3DVector; 


  struct ChannelMatrix : public SimpleRefCount<ChannelMatrix>
  {
    Complex3DVector    m_channel; 
    DoubleVector       m_delay; 
    Double2DVector     m_angle; 
    Time               m_generatedTime; 
    std::pair<uint32_t, uint32_t> m_nodeIds; 

    virtual ~ChannelMatrix () = default;
    
    bool IsReverse (const uint32_t aId, const uint32_t bId) const
    {
      uint32_t sId, uId;
      std::tie (sId, uId) = m_nodeIds;
      NS_ASSERT_MSG ((sId == aId && uId == bId) || (sId == bId && uId == aId),
                      "This matrix represents the channel between " << sId << " and " << uId);
      return (sId == bId && uId == aId);
    }
  };

  virtual Ptr<const ChannelMatrix> GetChannel (Ptr<const MobilityModel> aMob,
                                               Ptr<const MobilityModel> bMob,
                                               Ptr<const ThreeGppAntennaArrayModel> aAntenna,
                                               Ptr<const ThreeGppAntennaArrayModel> bAntenna) = 0;
  
  static constexpr uint32_t GetKey (uint32_t x1, uint32_t x2)
  {
   return (((x1 + x2) * (x1 + x2 + 1)) / 2) + x2;
  }

  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