ideal-beamforming-algorithm.h

// Copyright (c) 2020 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef SRC_NR_MODEL_IDEAL_BEAMFORMING_ALGORITHM_H_
#define SRC_NR_MODEL_IDEAL_BEAMFORMING_ALGORITHM_H_
 
#include "beam-id.h"
#include "beamforming-vector.h"
 
#include "ns3/object.h"
 
namespace ns3
{
 
class SpectrumModel;
class SpectrumValue;
class NrGnbNetDevice;
class NrUeNetDevice;
class NrSpectrumPhy;
 
class IdealBeamformingAlgorithm : public Object
{
  public:
    static TypeId GetTypeId();
 
    virtual BeamformingVectorPair GetBeamformingVectors(
        const Ptr<NrSpectrumPhy>& gnbSpectrumPhy,
        const Ptr<NrSpectrumPhy>& ueSpectrumPhy) const = 0;
};
 
class CellScanBeamforming : public IdealBeamformingAlgorithm
{
  public:
    static TypeId GetTypeId();
 
    CellScanBeamforming() = default;
 
    ~CellScanBeamforming() override = default;
 
    BeamformingVectorPair GetBeamformingVectors(
        const Ptr<NrSpectrumPhy>& gnbSpectrumPhy,
        const Ptr<NrSpectrumPhy>& ueSpectrumPhy) const override;
 
  private:
    uint8_t m_oversamplingFactor; 
};
 
class CellScanQuasiOmniBeamforming : public IdealBeamformingAlgorithm
{
  public:
    static TypeId GetTypeId();
 
    double GetBeamSearchAngleStep() const;
 
    void SetBeamSearchAngleStep(double beamSearchAngleStep);
 
    CellScanQuasiOmniBeamforming() = default;
 
    ~CellScanQuasiOmniBeamforming() override = default;
 
    BeamformingVectorPair GetBeamformingVectors(
        const Ptr<NrSpectrumPhy>& gnbSpectrumPhy,
        const Ptr<NrSpectrumPhy>& ueSpectrumPhy) const override;
 
  private:
    double m_beamSearchAngleStep{30};
};
 
class DirectPathBeamforming : public IdealBeamformingAlgorithm
{
  public:
    static TypeId GetTypeId();
 
    BeamformingVectorPair GetBeamformingVectors(
        const Ptr<NrSpectrumPhy>& gnbSpectrumPhy,
        const Ptr<NrSpectrumPhy>& ueSpectrumPhy) const override;
};
 
class QuasiOmniDirectPathBeamforming : public DirectPathBeamforming
{
  public:
    static TypeId GetTypeId();
 
    BeamformingVectorPair GetBeamformingVectors(
        const Ptr<NrSpectrumPhy>& gnbSpectrumPhy,
        const Ptr<NrSpectrumPhy>& ueSpectrumPhy) const override;
};
 
class DirectPathQuasiOmniBeamforming : public DirectPathBeamforming
{
  public:
    static TypeId GetTypeId();
 
    BeamformingVectorPair GetBeamformingVectors(
        const Ptr<NrSpectrumPhy>& gnbSpectrumPhy,
        const Ptr<NrSpectrumPhy>& ueSpectrumPhy) const override;
};
 
class OptimalCovMatrixBeamforming : public IdealBeamformingAlgorithm
{
  public:
    static TypeId GetTypeId();
 
    BeamformingVectorPair GetBeamformingVectors(
        const Ptr<NrSpectrumPhy>& gnbSpectrumPhy,
        const Ptr<NrSpectrumPhy>& ueSpectrumPhy) const override;
};
 
class KroneckerBeamforming : public IdealBeamformingAlgorithm
{
  public:
    static TypeId GetTypeId();
 
    std::vector<double> GetColRxBeamAngles() const;
 
    std::vector<double> GetColTxBeamAngles() const;
 
    std::vector<double> GetRowRxBeamAngles() const;
 
    std::vector<double> GetRowTxBeamAngles() const;
 
    void SetColRxBeamAngles(std::vector<double> colAngles);
 
    void SetColTxBeamAngles(std::vector<double> colAngles);
 
    void SetRowRxBeamAngles(std::vector<double> rowAngles);
 
    void SetRowTxBeamAngles(std::vector<double> rowAngles);
 
    KroneckerBeamforming() = default;
 
    ~KroneckerBeamforming() override = default;
 
    BeamformingVectorPair GetBeamformingVectors(
        const Ptr<NrSpectrumPhy>& gnbSpectrumPhy,
        const Ptr<NrSpectrumPhy>& ueSpectrumPhy) const override;
 
  private:
    std::vector<double> m_colRxBeamAngles{0, 90};
    std::vector<double> m_colTxBeamAngles{0, 90};
    std::vector<double> m_rowRxBeamAngles{0, 90};
    std::vector<double> m_rowTxBeamAngles{0, 90};
};
 
class KroneckerQuasiOmniBeamforming : public IdealBeamformingAlgorithm
{
  public:
    static TypeId GetTypeId();
 
    std::vector<double> GetColBeamAngles() const;
 
    std::vector<double> GetRowBeamAngles() const;
 
    void SetColBeamAngles(std::vector<double> colAngles);
 
    void SetRowBeamAngles(std::vector<double> rowAngles);
 
    KroneckerQuasiOmniBeamforming() = default;
 
    ~KroneckerQuasiOmniBeamforming() override = default;
 
    BeamformingVectorPair GetBeamformingVectors(
        const Ptr<NrSpectrumPhy>& gnbSpectrumPhy,
        const Ptr<NrSpectrumPhy>& ueSpectrumPhy) const override;
 
  private:
    std::vector<double> m_colBeamAngles{0, 90};
    std::vector<double> m_rowBeamAngles{0, 90};
};
} // namespace ns3
#endif