hexagonal-grid-scenario-helper.h

// Copyright (c) 2019 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
 
#ifndef HEXAGONAL_GRID_SCENARIO_HELPER_H
#define HEXAGONAL_GRID_SCENARIO_HELPER_H
 
#include "node-distribution-scenario-interface.h"
 
#include <ns3/random-variable-stream.h>
#include <ns3/vector.h>
 
namespace ns3
{
 
class HexagonalGridScenarioHelper : public NodeDistributionScenarioInterface
{
  public:
    /*
     * \brief Set results directory for the gnuplot file
     */
    void SetResultsDir(std::string resultsDir);
 
    /*
     * \brief Set simTag for the gnuplot file
     */
    void SetSimTag(std::string simTag);
 
    HexagonalGridScenarioHelper();
 
    ~HexagonalGridScenarioHelper() override;
 
    void SetNumRings(uint8_t numRings);
 
    double GetHexagonalCellRadius() const;
 
    Vector GetHexagonalCellCenter(const Vector& sitePos, uint16_t cellId) const;
 
    // inherited
    void CreateScenario() override;
 
    void CreateScenarioWithMobility(const Vector& speed, double percentage);
 
    int64_t AssignStreams(int64_t stream);
 
    /*
     * \brief Sets the maximum distance between UE and the closest site.
     * Note: used only in the function CreateScenarioWithMobility
     */
    void SetMaxUeDistanceToClosestSite(double maxUeDistanceToClosestSite);
 
  private:
    uint8_t m_numRings{0}; 
    Vector m_centralPos{Vector(0, 0, 0)}; 
    double m_hexagonalRadius{0.0};        
    double m_maxUeDistanceToClosestSite{
        10000}; 
 
    static std::vector<double> siteDistances;
    static std::vector<double> siteAngles;
 
    Ptr<UniformRandomVariable>
        m_r; 
    Ptr<UniformRandomVariable> m_theta; 
 
    std::string m_resultsDir; 
    std::string m_simTag;     
};
 
} // namespace ns3
 
#endif // HEXAGONAL_GRID_SCENARIO_HELPER_H