beam-manager.h

// Copyright (c) 2020 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef SRC_NR_MODEL_BEAM_MANAGER_H_
#define SRC_NR_MODEL_BEAM_MANAGER_H_
 
#include "beamforming-vector.h"
 
#include "ns3/event-id.h"
#include "ns3/net-device.h"
#include "ns3/nstime.h"
 
#include <map>
 
namespace ns3
{
 
class NrUeNetDevice;
class NrGnbNetDevice;
class BeamformingHelperBase;
 
class BeamManager : public Object
{
    friend BeamformingHelperBase;
 
  public:
    BeamManager();
 
    ~BeamManager() override;
 
    static TypeId GetTypeId();
 
    /*
     * @brief configures a predefined beam to use for directional transmissions
     */
    void SetPredefinedBeam(PhasedArrayModel::ComplexVector predefinedBeam);
 
    void SetPredefinedBeam(uint16_t sector, double elevation);
 
    void Configure(const Ptr<UniformPlanarArray>& antennaArray);
 
    PhasedArrayModel::ComplexVector GetVector(const BeamformingVector& v) const;
 
    BeamId GetBeamId(const BeamformingVector& v) const;
 
    Ptr<const UniformPlanarArray> GetAntenna() const;
 
    typedef std::map<const Ptr<const NetDevice>, BeamformingVector>
        BeamformingStorage; 
 
    virtual void SaveBeamformingVector(const BeamformingVector& bfv,
                                       const Ptr<const NetDevice>& device);
    virtual void ChangeBeamformingVector(const Ptr<const NetDevice>& device);
 
    virtual void ChangeToQuasiOmniBeamformingVector();
 
    virtual PhasedArrayModel::ComplexVector GetCurrentBeamformingVector();
 
    virtual PhasedArrayModel::ComplexVector GetBeamformingVector(
        const Ptr<NetDevice>& device) const;
 
    virtual BeamId GetBeamId(const Ptr<NetDevice>& device) const;
 
    void SetSector(uint16_t sector, double elevation) const;
 
    void SetSectorAz(double azimuth, double zenith) const;
 
  private:
    Ptr<UniformPlanarArray>
        m_antennaArray;    
    uint32_t m_numRows{0}; 
    uint32_t m_numColumns{0};      
    uint32_t m_numPortElems{0};    
    bool m_isPolDual{false};       
    BeamformingVector m_omniTxRxW; 
    BeamformingStorage m_beamformingVectorMap; 
    BeamformingVector m_predefinedDirTxRxW;    
};
 
} /* namespace ns3 */
 
#endif /* SRC_NR_MODEL_BEAM_MANAGER_H_ */