beam-id.h

// Copyright (c) 2020 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef SRC_NR_MODEL_BEAM_ID_H_
#define SRC_NR_MODEL_BEAM_ID_H_
 
#include <complex>
#include <stdint.h>
 
namespace ns3
{
 
class BeamId
{
  public:
    BeamId();
 
    BeamId(uint16_t sector, double elevation);
 
    bool operator==(const BeamId& p) const;
 
    bool operator!=(const BeamId& p) const;
 
    uint16_t GetSector() const;
 
    double GetElevation() const;
 
    /*
     * \brief Create BeamId with 0 sector and 0 elevation
     * \return BeamId (0,0)
     */
    static BeamId GetEmptyBeamId();
 
    uint32_t GetCantor() const;
 
  private:
    uint16_t m_sector{0};  
    double m_elevation{0}; 
};
 
// we reserve pair 65535, 65535 to identify the OMNI beam
extern const BeamId OMNI_BEAM_ID;
 
// we reserve pair 65534, 65534 to identify the directional predefined beam
extern const BeamId PREDEFINED_BEAM_ID;
 
struct BeamIdHash
{
    size_t operator()(const BeamId& x) const;
};
 
std::ostream& operator<<(std::ostream& os, const BeamId& item);
 
} /* namespace ns3 */
 
#endif /* SRC_NR_MODEL_ID_MANAGER_H_ */