phased-array-model.h

Go to the documentation of this file.

/*
 *   Copyright (c) 2020 University of Padova, Dep. of Information Engineering, SIGNET lab.
 *
 *   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 PHASED_ARRAY_MODEL_H
#define PHASED_ARRAY_MODEL_H
 
#include "angles.h"
#include "antenna-model.h"
 
#include <ns3/matrix-array.h>
#include <ns3/object.h>
 
#include <complex>
 
namespace ns3
{
 
class PhasedArrayModel : public Object
{
  public:
    PhasedArrayModel();
 
    ~PhasedArrayModel() override;
 
    static TypeId GetTypeId();
 
    using ComplexVector = ComplexMatrixArray; 
 
    double norm(const ComplexVector& complexVector) const
    {
        double norm = 0;
        for (size_t i = 0; i < complexVector.GetSize(); i++)
        {
            norm += std::norm(complexVector[i]);
        }
        return std::sqrt(norm);
    }
 
    virtual Vector GetElementLocation(uint64_t index) const = 0;
 
    virtual size_t GetNumElems() const = 0;
 
    virtual std::pair<double, double> GetElementFieldPattern(Angles a,
                                                             uint8_t polIndex = 0) const = 0;
 
    virtual void SetNumVerticalPorts(uint16_t nPorts) = 0;
 
    virtual void SetNumHorizontalPorts(uint16_t nPorts) = 0;
 
    virtual uint16_t GetNumVerticalPorts() const = 0;
 
    virtual uint16_t GetNumHorizontalPorts() const = 0;
 
    virtual uint16_t GetNumPorts() const = 0;
 
    virtual uint8_t GetNumPols() const = 0;
 
    virtual size_t GetVElemsPerPort() const = 0;
    virtual size_t GetHElemsPerPort() const = 0;
 
    virtual size_t GetNumElemsPerPort() const = 0;
 
    virtual void SetNumColumns(uint32_t nColumns) = 0;
 
    virtual void SetNumRows(uint32_t nRows) = 0;
 
    virtual uint32_t GetNumColumns() const = 0;
 
    virtual uint32_t GetNumRows() const = 0;
 
    virtual double GetPolSlant() const = 0;
 
    virtual bool IsDualPol() const = 0;
 
    virtual uint16_t ArrayIndexFromPortIndex(uint16_t portIndex,
                                             uint16_t subElementIndex) const = 0;
 
    virtual uint8_t GetElemPol(size_t elementIndex) const = 0;
 
    void SetBeamformingVector(const ComplexVector& beamformingVector);
 
    ComplexVector GetBeamformingVector() const;
 
    const PhasedArrayModel::ComplexVector& GetBeamformingVectorRef() const;
 
    ComplexVector GetBeamformingVector(Angles a) const;
 
    ComplexVector GetSteeringVector(Angles a) const;
 
    void SetAntennaElement(Ptr<AntennaModel> antennaElement);
 
    Ptr<const AntennaModel> GetAntennaElement() const;
 
    uint32_t GetId() const;
 
  protected:
    ComplexVector m_beamformingVector;  
    Ptr<AntennaModel> m_antennaElement; 
    bool m_isBfVectorValid;             
    static uint32_t
        m_idCounter;  
    uint32_t m_id{0}; 
};
 
} /* namespace ns3 */
 
#endif /* PHASED_ARRAY_MODEL_H */