lte-hex-grid-enb-topology-helper.cc

Go to the documentation of this file.

/*
 * Copyright 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Nicola Baldo <nbaldo@cttc.es>
 */
 
#include "lte-hex-grid-enb-topology-helper.h"
 
#include "epc-helper.h"
 
#include "ns3/abort.h"
#include "ns3/double.h"
#include "ns3/hexagonal-wraparound-model.h"
#include "ns3/log.h"
#include "ns3/pointer.h"
 
#include <iostream>
 
namespace ns3
{
 
NS_LOG_COMPONENT_DEFINE("LteHexGridEnbTopologyHelper");
 
NS_OBJECT_ENSURE_REGISTERED(LteHexGridEnbTopologyHelper);
 
LteHexGridEnbTopologyHelper::LteHexGridEnbTopologyHelper()
{
    NS_LOG_FUNCTION(this);
}
 
LteHexGridEnbTopologyHelper::~LteHexGridEnbTopologyHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId
LteHexGridEnbTopologyHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::LteHexGridEnbTopologyHelper")
            .SetParent<Object>()
            .AddConstructor<LteHexGridEnbTopologyHelper>()
            .AddAttribute("InterSiteDistance",
                          "The distance [m] between nearby sites",
                          DoubleValue(500),
                          MakeDoubleAccessor(&LteHexGridEnbTopologyHelper::m_d),
                          MakeDoubleChecker<double>())
            .AddAttribute("SectorOffset",
                          "The offset [m] in the position for the node of each sector with respect "
                          "to the center of the three-sector site",
                          DoubleValue(0.5),
                          MakeDoubleAccessor(&LteHexGridEnbTopologyHelper::m_offset),
                          MakeDoubleChecker<double>())
            .AddAttribute("SiteHeight",
                          "The height [m] of each site",
                          DoubleValue(30),
                          MakeDoubleAccessor(&LteHexGridEnbTopologyHelper::m_siteHeight),
                          MakeDoubleChecker<double>())
            .AddAttribute("MinX",
                          "The x coordinate where the hex grid starts.",
                          DoubleValue(0.0),
                          MakeDoubleAccessor(&LteHexGridEnbTopologyHelper::m_xMin),
                          MakeDoubleChecker<double>())
            .AddAttribute("MinY",
                          "The y coordinate where the hex grid starts.",
                          DoubleValue(0.0),
                          MakeDoubleAccessor(&LteHexGridEnbTopologyHelper::m_yMin),
                          MakeDoubleChecker<double>())
            .AddAttribute(
                "GridWidth",
                "The number of sites in even rows (odd rows will have one additional site).",
                UintegerValue(1),
                MakeUintegerAccessor(&LteHexGridEnbTopologyHelper::m_gridWidth),
                MakeUintegerChecker<uint32_t>())
            .AddAttribute("EnableWraparound",
                          "Enable hexagonal wraparound model.",
                          BooleanValue(false),
                          MakeBooleanAccessor(&LteHexGridEnbTopologyHelper::m_installWraparound),
                          MakeBooleanChecker());
    return tid;
}
 
void
LteHexGridEnbTopologyHelper::DoDispose()
{
    NS_LOG_FUNCTION(this);
    Object::DoDispose();
}
 
void
LteHexGridEnbTopologyHelper::SetLteHelper(Ptr<LteHelper> h)
{
    NS_LOG_FUNCTION(this << h);
    m_lteHelper = h;
}
 
NetDeviceContainer
LteHexGridEnbTopologyHelper::SetPositionAndInstallEnbDevice(NodeContainer c)
{
    NS_LOG_FUNCTION(this);
    NetDeviceContainer enbDevs;
    Ptr<HexagonalWraparoundModel> wraparoundModel;
    if (m_installWraparound)
    {
        wraparoundModel = CreateObject<HexagonalWraparoundModel>();
        wraparoundModel->SetSiteDistance(m_d);
        wraparoundModel->SetNumSites(c.GetN() / 3);
    }
    const double xydfactor = std::sqrt(0.75);
    double yd = xydfactor * m_d;
    for (uint32_t n = 0; n < c.GetN(); ++n)
    {
        uint32_t currentSite = n / 3;
        uint32_t biRowIndex = (currentSite / (m_gridWidth + m_gridWidth + 1));
        uint32_t biRowRemainder = currentSite % (m_gridWidth + m_gridWidth + 1);
        uint32_t rowIndex = biRowIndex * 2;
        uint32_t colIndex = biRowRemainder;
        if (biRowRemainder >= m_gridWidth)
        {
            ++rowIndex;
            colIndex -= m_gridWidth;
        }
        NS_LOG_LOGIC("node " << n << " site " << currentSite << " rowIndex " << rowIndex
                             << " colIndex " << colIndex << " biRowIndex " << biRowIndex
                             << " biRowRemainder " << biRowRemainder);
        double y = m_yMin + yd * rowIndex;
        double x;
        double antennaOrientation;
        if ((rowIndex % 2) == 0)
        {
            x = m_xMin + m_d * colIndex;
        }
        else // row is odd
        {
            x = m_xMin - (0.5 * m_d) + m_d * colIndex;
        }
 
        switch (n % 3)
        {
        case 0:
            antennaOrientation = 0;
            x += m_offset;
            m_lteHelper->SetFfrAlgorithmAttribute("FrCellTypeId", UintegerValue(1));
            break;
 
        case 1:
            antennaOrientation = 120;
            x -= m_offset / 2.0;
            y += m_offset * xydfactor;
            m_lteHelper->SetFfrAlgorithmAttribute("FrCellTypeId", UintegerValue(2));
            break;
 
        case 2:
            antennaOrientation = -120;
            x -= m_offset / 2.0;
            y -= m_offset * xydfactor;
            m_lteHelper->SetFfrAlgorithmAttribute("FrCellTypeId", UintegerValue(3));
            break;
 
            // no default, n%3 = 0, 1, 2
        }
        Ptr<Node> node = c.Get(n);
        Ptr<MobilityModel> mm = node->GetObject<MobilityModel>();
        Vector pos(x, y, m_siteHeight);
        NS_LOG_LOGIC("node " << n << " at " << pos << " antennaOrientation " << antennaOrientation);
        mm->SetPosition(Vector(x, y, m_siteHeight));
        m_lteHelper->SetEnbAntennaModelAttribute("Orientation", DoubleValue(antennaOrientation));
        enbDevs.Add(m_lteHelper->InstallEnbDevice(node));
        if (m_installWraparound && (n % 3 == 0))
        {
            wraparoundModel->AddSitePosition(mm->GetPosition());
        }
    }
    if (m_installWraparound)
    {
        m_wraparoundModel = wraparoundModel;
    }
    return enbDevs;
}
 
Ptr<WraparoundModel>
LteHexGridEnbTopologyHelper::GetWraparoundModel() const
{
    return m_wraparoundModel;
}
 
} // namespace ns3