satellite-stats-helper.cc

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 Magister Solutions
 *
 * 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
 *
 * Author: Budiarto Herman <budiarto.herman@magister.fi>
 *
 */
 
#include "satellite-stats-helper.h"
 
#include "ns3/address.h"
#include "ns3/collector-map.h"
#include "ns3/data-collection-object.h"
#include "ns3/enum.h"
#include "ns3/log.h"
#include "ns3/mac48-address.h"
#include "ns3/node-container.h"
#include "ns3/object-factory.h"
#include "ns3/satellite-beam-helper.h"
#include "ns3/satellite-const-variables.h"
#include "ns3/satellite-env-variables.h"
#include "ns3/satellite-helper.h"
#include "ns3/satellite-id-mapper.h"
#include "ns3/satellite-orbiter-net-device.h"
#include "ns3/satellite-topology.h"
#include "ns3/satellite-user-helper.h"
#include "ns3/singleton.h"
#include "ns3/string.h"
#include "ns3/type-id.h"
 
#include <list>
#include <sstream>
#include <string>
#include <utility>
#include <vector>
 
NS_LOG_COMPONENT_DEFINE("SatStatsHelper");
 
namespace ns3
{
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsHelper);
 
std::string // static
SatStatsHelper::GetIdentifierTypeName(SatStatsHelper::IdentifierType_t identifierType)
{
    switch (identifierType)
    {
    case SatStatsHelper::IDENTIFIER_GLOBAL:
        return "IDENTIFIER_GLOBAL";
    case SatStatsHelper::IDENTIFIER_GW:
        return "IDENTIFIER_GW";
    case SatStatsHelper::IDENTIFIER_BEAM:
        return "IDENTIFIER_BEAM";
    case SatStatsHelper::IDENTIFIER_UT:
        return "IDENTIFIER_UT";
    case SatStatsHelper::IDENTIFIER_UT_USER:
        return "IDENTIFIER_UT_USER";
    case SatStatsHelper::IDENTIFIER_SLICE:
        return "IDENTIFIER_SLICE";
    case SatStatsHelper::IDENTIFIER_GROUP:
        return "IDENTIFIER_GROUP";
    case SatStatsHelper::IDENTIFIER_SAT:
        return "IDENTIFIER_SAT";
    case SatStatsHelper::IDENTIFIER_ISL:
        return "IDENTIFIER_ISL";
    default:
        NS_FATAL_ERROR("SatStatsHelper - Invalid identifier type");
        break;
    }
 
    NS_FATAL_ERROR("SatStatsHelper - Invalid identifier type");
    return "";
}
 
std::string // static
SatStatsHelper::GetOutputTypeName(SatStatsHelper::OutputType_t outputType)
{
    switch (outputType)
    {
    case SatStatsHelper::OUTPUT_NONE:
        return "OUTPUT_NONE";
    case SatStatsHelper::OUTPUT_SCALAR_FILE:
        return "OUTPUT_SCALAR_FILE";
    case SatStatsHelper::OUTPUT_SCATTER_FILE:
        return "OUTPUT_SCATTER_FILE";
    case SatStatsHelper::OUTPUT_HISTOGRAM_FILE:
        return "OUTPUT_HISTOGRAM_FILE";
    case SatStatsHelper::OUTPUT_PDF_FILE:
        return "OUTPUT_PDF_FILE";
    case SatStatsHelper::OUTPUT_CDF_FILE:
        return "OUTPUT_CDF_FILE";
    case SatStatsHelper::OUTPUT_SCALAR_PLOT:
        return "OUTPUT_SCALAR_PLOT";
    case SatStatsHelper::OUTPUT_SCATTER_PLOT:
        return "OUTPUT_SCATTER_PLOT";
    case SatStatsHelper::OUTPUT_HISTOGRAM_PLOT:
        return "OUTPUT_HISTOGRAM_PLOT";
    case SatStatsHelper::OUTPUT_PDF_PLOT:
        return "OUTPUT_PDF_PLOT";
    case SatStatsHelper::OUTPUT_CDF_PLOT:
        return "OUTPUT_CDF_PLOT";
    default:
        NS_FATAL_ERROR("SatStatsHelper - Invalid output type");
        break;
    }
 
    NS_FATAL_ERROR("SatStatsHelper - Invalid output type");
    return "";
}
 
SatStatsHelper::SatStatsHelper(Ptr<const SatHelper> satHelper)
    : m_name("stat"),
      m_identifierType(SatStatsHelper::IDENTIFIER_GLOBAL),
      m_outputType(SatStatsHelper::OUTPUT_SCATTER_FILE),
      m_isInstalled(false),
      m_satHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
}
 
SatStatsHelper::~SatStatsHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatStatsHelper")
            .SetParent<Object>()
            .AddAttribute("Name",
                          "String to be prepended on every output file name.",
                          StringValue("stat"),
                          MakeStringAccessor(&SatStatsHelper::SetName, &SatStatsHelper::GetName),
                          MakeStringChecker())
            .AddAttribute("IdentifierType",
                          "Determines how the statistics are categorized.",
                          EnumValue(SatStatsHelper::IDENTIFIER_GLOBAL),
                          MakeEnumAccessor<SatStatsHelper::IdentifierType_t>(
                              &SatStatsHelper::SetIdentifierType,
                              &SatStatsHelper::GetIdentifierType),
                          MakeEnumChecker(SatStatsHelper::IDENTIFIER_GLOBAL,
                                          "GLOBAL",
                                          SatStatsHelper::IDENTIFIER_GW,
                                          "GW",
                                          SatStatsHelper::IDENTIFIER_BEAM,
                                          "BEAM",
                                          SatStatsHelper::IDENTIFIER_UT,
                                          "UT",
                                          SatStatsHelper::IDENTIFIER_UT_USER,
                                          "UT_USER",
                                          SatStatsHelper::IDENTIFIER_SLICE,
                                          "SLICE",
                                          SatStatsHelper::IDENTIFIER_GROUP,
                                          "GROUP",
                                          SatStatsHelper::IDENTIFIER_SAT,
                                          "SAT",
                                          SatStatsHelper::IDENTIFIER_ISL,
                                          "ISL"))
            .AddAttribute(
                "OutputType",
                "Determines the type and format of the output.",
                EnumValue(SatStatsHelper::OUTPUT_SCATTER_FILE),
                MakeEnumAccessor<SatStatsHelper::OutputType_t>(&SatStatsHelper::SetOutputType,
                                                               &SatStatsHelper::GetOutputType),
                MakeEnumChecker(SatStatsHelper::OUTPUT_NONE,
                                "NONE",
                                SatStatsHelper::OUTPUT_SCALAR_FILE,
                                "SCALAR_FILE",
                                SatStatsHelper::OUTPUT_SCATTER_FILE,
                                "SCATTER_FILE",
                                SatStatsHelper::OUTPUT_HISTOGRAM_FILE,
                                "HISTOGRAM_FILE",
                                SatStatsHelper::OUTPUT_PDF_FILE,
                                "PDF_FILE",
                                SatStatsHelper::OUTPUT_CDF_FILE,
                                "CDF_FILE",
                                SatStatsHelper::OUTPUT_SCATTER_PLOT,
                                "SCATTER_PLOT",
                                SatStatsHelper::OUTPUT_HISTOGRAM_PLOT,
                                "HISTOGRAM_PLOT",
                                SatStatsHelper::OUTPUT_PDF_PLOT,
                                "PDF_PLOT",
                                SatStatsHelper::OUTPUT_CDF_PLOT,
                                "CDF_PLOT"));
    return tid;
}
 
void
SatStatsHelper::Install()
{
    NS_LOG_FUNCTION(this);
 
    if (m_outputType == SatStatsHelper::OUTPUT_NONE)
    {
        NS_LOG_WARN(this << " Skipping statistics installation"
                         << " because OUTPUT_NONE output type is selected.");
    }
    else
    {
        DoInstall(); // this method is supposed to be implemented by the child class
        m_isInstalled = true;
    }
}
 
void
SatStatsHelper::SetName(std::string name)
{
    NS_LOG_FUNCTION(this << name);
 
    // convert all spaces and slashes in the name to underscores
    for (size_t pos = name.find_first_of(" /"); pos != std::string::npos;
         pos = name.find_first_of(" /", pos + 1, 1))
    {
        name[pos] = '_';
    }
 
    m_name = name;
}
 
std::string
SatStatsHelper::GetName() const
{
    return m_name;
}
 
void
SatStatsHelper::SetIdentifierType(SatStatsHelper::IdentifierType_t identifierType)
{
    NS_LOG_FUNCTION(this << GetIdentifierTypeName(identifierType));
 
    if (m_isInstalled && (m_identifierType != identifierType))
    {
        NS_LOG_WARN(this << " cannot modify the current identifier type" << " ("
                         << GetIdentifierTypeName(m_identifierType) << ")"
                         << " because this instance have already been installed");
    }
    else
    {
        m_identifierType = identifierType;
    }
}
 
SatStatsHelper::IdentifierType_t
SatStatsHelper::GetIdentifierType() const
{
    return m_identifierType;
}
 
void
SatStatsHelper::SetOutputType(SatStatsHelper::OutputType_t outputType)
{
    NS_LOG_FUNCTION(this << GetOutputTypeName(outputType));
 
    if (m_isInstalled && (m_outputType != outputType))
    {
        NS_LOG_WARN(this << " cannot modify the current output type" << " ("
                         << GetIdentifierTypeName(m_identifierType) << ")"
                         << " because this instance have already been installed");
    }
    else
    {
        m_outputType = outputType;
    }
}
 
SatStatsHelper::OutputType_t
SatStatsHelper::GetOutputType() const
{
    return m_outputType;
}
 
bool
SatStatsHelper::IsInstalled() const
{
    return m_isInstalled;
}
 
Ptr<const SatHelper>
SatStatsHelper::GetSatHelper() const
{
    return m_satHelper;
}
 
Ptr<DataCollectionObject>
SatStatsHelper::CreateAggregator(std::string aggregatorTypeId,
                                 std::string n1,
                                 const AttributeValue& v1,
                                 std::string n2,
                                 const AttributeValue& v2,
                                 std::string n3,
                                 const AttributeValue& v3,
                                 std::string n4,
                                 const AttributeValue& v4,
                                 std::string n5,
                                 const AttributeValue& v5)
{
    NS_LOG_FUNCTION(this << aggregatorTypeId);
 
    TypeId tid = TypeId::LookupByName(aggregatorTypeId);
    ObjectFactory factory;
    factory.SetTypeId(tid);
    factory.Set(n1, v1);
    factory.Set(n2, v2);
    factory.Set(n3, v3);
    factory.Set(n4, v4);
    factory.Set(n5, v5);
    return factory.Create()->GetObject<DataCollectionObject>();
}
 
uint32_t
SatStatsHelper::CreateCollectorPerIdentifier(CollectorMap& collectorMap) const
{
    NS_LOG_FUNCTION(this);
    uint32_t n = 0;
 
    switch (GetIdentifierType())
    {
    case SatStatsHelper::IDENTIFIER_GLOBAL: {
        collectorMap.SetAttribute("Name", StringValue("0"));
        collectorMap.Create(0);
        n++;
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_GW: {
        NodeContainer gws = Singleton<SatTopology>::Get()->GetGwNodes();
        for (NodeContainer::Iterator it = gws.Begin(); it != gws.End(); ++it)
        {
            const uint32_t gwId = GetGwId(*it);
            std::ostringstream name;
            name << gwId;
            collectorMap.SetAttribute("Name", StringValue(name.str()));
            collectorMap.Create(gwId);
            n++;
        }
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_BEAM: {
        std::list<std::pair<uint32_t, uint32_t>> beams = m_satHelper->GetBeamHelper()->GetBeams();
        for (std::list<std::pair<uint32_t, uint32_t>>::const_iterator it = beams.begin();
             it != beams.end();
             ++it)
        {
            const uint32_t satId = (it->first);
            const uint32_t beamId = (it->second);
            std::ostringstream name;
            name << (satId + 1) << "-" << beamId;
            collectorMap.SetAttribute("Name", StringValue(name.str()));
            collectorMap.Create(SatConstVariables::MAX_BEAMS_PER_SATELLITE * (satId + 1) + beamId);
            n++;
        }
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_GROUP: {
        std::list<uint32_t> groups = m_satHelper->GetGroupHelper()->GetGroups();
        groups.push_back(0);
        for (std::list<uint32_t>::const_iterator it = groups.begin(); it != groups.end(); ++it)
        {
            const uint32_t groupId = (*it);
            std::ostringstream name;
            name << groupId;
            collectorMap.SetAttribute("Name", StringValue(name.str()));
            collectorMap.Create(groupId);
            n++;
        }
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_UT: {
        NodeContainer uts = Singleton<SatTopology>::Get()->GetUtNodes();
        for (NodeContainer::Iterator it = uts.Begin(); it != uts.End(); ++it)
        {
            const uint32_t utId = GetUtId(*it);
            std::ostringstream name;
            name << utId;
            collectorMap.SetAttribute("Name", StringValue(name.str()));
            collectorMap.Create(utId);
            n++;
        }
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_UT_USER: {
        NodeContainer utUsers = Singleton<SatTopology>::Get()->GetUtUserNodes();
        for (NodeContainer::Iterator it = utUsers.Begin(); it != utUsers.End(); ++it)
        {
            const uint32_t utUserId = GetUtUserId(*it);
            std::ostringstream name;
            name << utUserId;
            collectorMap.SetAttribute("Name", StringValue(name.str()));
            collectorMap.Create(utUserId);
            n++;
        }
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_SLICE: {
        for (uint32_t sliceId = 0; sliceId < 256; sliceId++)
        {
            std::ostringstream name;
            name << sliceId;
            collectorMap.SetAttribute("Name", StringValue(name.str()));
            collectorMap.Create(sliceId);
            n++;
        }
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_SAT: {
        NodeContainer sats = Singleton<SatTopology>::Get()->GetOrbiterNodes();
 
        for (NodeContainer::Iterator it = sats.Begin(); it != sats.End(); ++it)
        {
            const uint32_t satId = GetSatId(*it);
            std::ostringstream name;
            name << satId;
            collectorMap.SetAttribute("Name", StringValue(name.str()));
            collectorMap.Create(satId);
            n++;
        }
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_ISL: {
        NodeContainer sats = Singleton<SatTopology>::Get()->GetOrbiterNodes();
 
        for (NodeContainer::Iterator it = sats.Begin(); it != sats.End(); ++it)
        {
            Ptr<SatOrbiterNetDevice> satOrbiterNetDevice =
                DynamicCast<SatOrbiterNetDevice>(GetSatSatOrbiterNetDevice(*it));
            const uint32_t satSrcId = GetSatId(*it);
            std::vector<Ptr<PointToPointIslNetDevice>> islNetDevices =
                satOrbiterNetDevice->GetIslsNetDevices();
            for (std::vector<Ptr<PointToPointIslNetDevice>>::iterator itIsl = islNetDevices.begin();
                 itIsl != islNetDevices.end();
                 itIsl++)
            {
                Ptr<PointToPointIslNetDevice> islNetDevice = *itIsl;
                const uint32_t satDstId = GetSatId(islNetDevice->GetDestinationNode());
                std::ostringstream name;
                name << satSrcId << "-" << satDstId;
                collectorMap.SetAttribute("Name", StringValue(name.str()));
                collectorMap.Create(SatConstVariables::MAX_SATELLITES * satSrcId + satDstId);
                n++;
            }
        }
        break;
    }
 
    default:
        NS_FATAL_ERROR("SatStatsHelper - Invalid identifier type");
        break;
    }
 
    NS_LOG_INFO(this << " created " << n << " instance(s)" << " of "
                     << collectorMap.GetType().GetName() << " for "
                     << GetIdentifierTypeName(GetIdentifierType()));
 
    return n;
 
} // end of `uint32_t CreateCollectorPerIdentifier (CollectorMap &);`
 
std::string
SatStatsHelper::GetOutputPath() const
{
    return SatEnvVariables::GetInstance()->GetOutputPath();
}
 
std::string
SatStatsHelper::GetOutputFileName() const
{
    return GetOutputPath() + "/" + GetName();
}
 
std::string
SatStatsHelper::GetIdentifierHeading(std::string dataLabel) const
{
    switch (GetIdentifierType())
    {
    case SatStatsHelper::IDENTIFIER_GLOBAL:
        return "% global " + dataLabel;
 
    case SatStatsHelper::IDENTIFIER_GW:
        return "% gw_id " + dataLabel;
 
    case SatStatsHelper::IDENTIFIER_BEAM:
        return "% beam_id " + dataLabel;
 
    case SatStatsHelper::IDENTIFIER_GROUP:
        return "% group_id " + dataLabel;
 
    case SatStatsHelper::IDENTIFIER_UT:
        return "% ut_id " + dataLabel;
 
    case SatStatsHelper::IDENTIFIER_UT_USER:
        return "% ut_user_id " + dataLabel;
 
    case SatStatsHelper::IDENTIFIER_SLICE:
        return "% slice_id " + dataLabel;
 
    case SatStatsHelper::IDENTIFIER_SAT:
        return "% sat_id " + dataLabel;
 
    case SatStatsHelper::IDENTIFIER_ISL:
        return "% isl_id " + dataLabel;
 
    default:
        NS_FATAL_ERROR("SatStatsHelper - Invalid identifier type");
        break;
    }
    return "";
}
 
std::string
SatStatsHelper::GetTimeHeading(std::string dataLabel) const
{
    return "% time_sec " + dataLabel;
}
 
std::string
SatStatsHelper::GetDistributionHeading(std::string dataLabel) const
{
    return "% " + dataLabel + " freq";
}
 
// IDENTIFIER RELATED METHODS /////////////////////////////////////////////////
 
uint32_t
SatStatsHelper::GetUtUserId(Ptr<Node> utUserNode) const
{
    uint32_t ret = 0;
    const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
    const Address addr = satIdMapper->GetUtUserMacWithNode(utUserNode);
 
    if (addr.IsInvalid())
    {
        NS_LOG_WARN(this << " Node " << utUserNode->GetId()
                         << " does not have any valid Mac48Address");
    }
    else
    {
        const int32_t utUserId = satIdMapper->GetUtUserIdWithMac(addr);
 
        if (utUserId < 0)
        {
            NS_LOG_WARN(this << " Node " << utUserNode->GetId()
                             << " is not found in the global list of UT users");
        }
        else
        {
            ret = utUserId;
        }
    }
 
    return ret;
}
 
uint32_t
SatStatsHelper::GetUtId(Ptr<Node> utNode) const
{
    uint32_t ret = 0;
    const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
    const Address addr = satIdMapper->GetUtMacWithNode(utNode);
 
    if (addr.IsInvalid())
    {
        NS_LOG_WARN(this << " Node " << utNode->GetId() << " does not have any valid Mac48Address");
    }
    else
    {
        const int32_t utId = satIdMapper->GetUtIdWithMac(addr);
 
        if (utId < 0)
        {
            NS_LOG_WARN(this << " Node " << utNode->GetId()
                             << " is not found in the global list of UTs");
        }
        else
        {
            ret = utId;
        }
    }
 
    return ret;
}
 
uint32_t
SatStatsHelper::GetGwId(Ptr<Node> gwNode) const
{
    uint32_t ret = 0;
    const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
    const Address addr = satIdMapper->GetGwMacWithNode(gwNode);
 
    if (addr.IsInvalid())
    {
        NS_LOG_WARN(this << " Node " << gwNode->GetId() << " does not have any valid Mac48Address");
    }
    else
    {
        const int32_t gwId = satIdMapper->GetGwIdWithMac(addr);
 
        if (gwId < 0)
        {
            NS_LOG_WARN(this << " Node " << gwNode->GetId()
                             << " is not found in the global list of GWs");
        }
        else
        {
            ret = gwId;
        }
    }
 
    return ret;
}
 
uint32_t
SatStatsHelper::GetSatId(Ptr<Node> satNode) const
{
    uint32_t ret = 0;
    const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
    const Address addr = satIdMapper->GetSatMacWithNode(satNode);
 
    if (addr.IsInvalid())
    {
        NS_LOG_WARN(this << " Node " << satNode->GetId()
                         << " does not have any valid Mac48Address");
    }
    else
    {
        const int32_t satId = satIdMapper->GetSatIdWithMac(addr);
 
        if (satId < 0)
        {
            NS_LOG_WARN(this << " Node " << satNode->GetId()
                             << " is not found in the global list of SATs");
        }
        else
        {
            ret = satId;
        }
    }
 
    return ret;
}
 
uint32_t
SatStatsHelper::GetIdentifierForUtUser(Ptr<Node> utUserNode) const
{
    uint32_t ret = 0;
 
    switch (m_identifierType)
    {
    case SatStatsHelper::IDENTIFIER_GLOBAL:
        ret = 0;
        break;
 
    case SatStatsHelper::IDENTIFIER_GW: {
        Ptr<Node> utNode = Singleton<SatTopology>::Get()->GetUtNode(utUserNode);
 
        if (utNode == nullptr)
        {
            NS_LOG_WARN(this << " UT user node " << utUserNode->GetId()
                             << " is not attached to any UT node");
        }
        else
        {
            const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
            const Address utMac = satIdMapper->GetUtMacWithNode(utNode);
 
            if (!utMac.IsInvalid())
            {
                const int32_t satId = satIdMapper->GetSatIdWithMac(utMac);
                const int32_t beamId = satIdMapper->GetBeamIdWithMac(utMac);
                NS_ASSERT_MSG(satId != -1,
                              "UT user node " << utUserNode->GetId()
                                              << " is not attached to any sat");
                NS_ASSERT_MSG(beamId != -1,
                              "UT user node " << utUserNode->GetId()
                                              << " is not attached to any beam");
                const uint32_t gwId = m_satHelper->GetBeamHelper()->GetGwId(satId - 1, beamId);
                NS_ASSERT_MSG(gwId != 0,
                              "UT user node " << utUserNode->GetId()
                                              << " is not attached to any GW");
                ret = gwId;
            }
        }
 
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_SAT: {
        Ptr<Node> utNode = Singleton<SatTopology>::Get()->GetUtNode(utUserNode);
 
        const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
        const Address utMac = satIdMapper->GetUtMacWithNode(utNode);
 
        if (!utMac.IsInvalid())
        {
            const int32_t satId = satIdMapper->GetSatIdWithMac(utMac);
            NS_ASSERT_MSG(satId != -1,
                          "UT node " << utNode->GetId() << " is not attached to any sat");
            ret = satId;
        }
 
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_BEAM: {
        Ptr<Node> utNode = Singleton<SatTopology>::Get()->GetUtNode(utUserNode);
 
        if (utNode == nullptr)
        {
            NS_LOG_WARN(this << " UT user node " << utUserNode->GetId()
                             << " is not attached to any UT node");
        }
        else
        {
            const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
            const Address utMac = satIdMapper->GetUtMacWithNode(utNode);
 
            if (!utMac.IsInvalid())
            {
                const int32_t satId = satIdMapper->GetSatIdWithMac(utMac);
                const int32_t beamId = satIdMapper->GetBeamIdWithMac(utMac);
                NS_ASSERT_MSG(satId != -1,
                              "UT user node " << utUserNode->GetId()
                                              << " is not attached to any sat");
                NS_ASSERT_MSG(beamId != -1,
                              "UT user node " << utUserNode->GetId()
                                              << " is not attached to any beam");
                ret = SatConstVariables::MAX_BEAMS_PER_SATELLITE * satId + beamId;
            }
        }
 
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_GROUP: {
        Ptr<Node> utNode = Singleton<SatTopology>::Get()->GetUtNode(utUserNode);
 
        if (utNode == nullptr)
        {
            NS_LOG_WARN(this << " UT user node " << utUserNode->GetId()
                             << " is not attached to any UT node");
        }
        else
        {
            const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
            const Address utMac = satIdMapper->GetUtMacWithNode(utNode);
 
            if (!utMac.IsInvalid())
            {
                const int32_t groupId = satIdMapper->GetGroupIdWithMac(utMac);
                ret = groupId;
            }
        }
 
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_UT: {
        Ptr<Node> utNode = Singleton<SatTopology>::Get()->GetUtNode(utUserNode);
 
        if (utNode == nullptr)
        {
            NS_LOG_WARN(this << " UT user node " << utUserNode->GetId()
                             << " is not attached to any UT node");
        }
        else
        {
            ret = GetUtId(utNode);
        }
 
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_UT_USER:
        ret = GetUtUserId(utUserNode);
        break;
 
    default:
        NS_LOG_WARN(this << " Identifier type " << GetIdentifierTypeName(m_identifierType)
                         << " is not valid for a UT user."
                         << " Assigning identifier 0 to this UT user.");
        break;
    }
 
    return ret;
}
 
uint32_t
SatStatsHelper::GetIdentifierForUt(Ptr<Node> utNode) const
{
    uint32_t ret = 0;
 
    switch (m_identifierType)
    {
    case SatStatsHelper::IDENTIFIER_GLOBAL:
        ret = 0;
        break;
 
    case SatStatsHelper::IDENTIFIER_GW: {
        const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
        const Address utMac = satIdMapper->GetUtMacWithNode(utNode);
 
        if (!utMac.IsInvalid())
        {
            const int32_t satId = satIdMapper->GetSatIdWithMac(utMac);
            const int32_t beamId = satIdMapper->GetBeamIdWithMac(utMac);
            NS_ASSERT_MSG(satId != -1,
                          "UT user node " << utNode->GetId() << " is not attached to any sat");
            NS_ASSERT_MSG(beamId != -1,
                          "UT node " << utNode->GetId() << " is not attached to any beam");
            const uint32_t gwId = m_satHelper->GetBeamHelper()->GetGwId(satId - 1, beamId);
            NS_ASSERT_MSG(gwId != 0, "UT node " << utNode->GetId() << " is not attached to any GW");
            ret = gwId;
        }
 
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_SAT: {
        const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
        const Address utMac = satIdMapper->GetUtMacWithNode(utNode);
 
        if (!utMac.IsInvalid())
        {
            const int32_t satId = satIdMapper->GetSatIdWithMac(utMac);
            NS_ASSERT_MSG(satId != -1,
                          "UT node " << utNode->GetId() << " is not attached to any sat");
            ret = satId;
        }
 
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_BEAM: {
        const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
        const Address utMac = satIdMapper->GetUtMacWithNode(utNode);
 
        if (!utMac.IsInvalid())
        {
            const int32_t satId = satIdMapper->GetSatIdWithMac(utMac);
            const int32_t beamId = satIdMapper->GetBeamIdWithMac(utMac);
            NS_ASSERT_MSG(satId != -1,
                          "UT node " << utNode->GetId() << " is not attached to any sat");
            NS_ASSERT_MSG(beamId != -1,
                          "UT node " << utNode->GetId() << " is not attached to any beam");
            ret = SatConstVariables::MAX_BEAMS_PER_SATELLITE * satId + beamId;
        }
 
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_GROUP: {
        const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
        const Address utMac = satIdMapper->GetUtMacWithNode(utNode);
 
        if (!utMac.IsInvalid())
        {
            const int32_t groupId = satIdMapper->GetGroupIdWithMac(utMac);
            ret = groupId;
        }
 
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_UT:
        ret = GetUtId(utNode);
        break;
 
    default:
        NS_LOG_WARN(this << " Identifier type " << GetIdentifierTypeName(m_identifierType)
                         << " is not valid for a UT." << " Assigning identifier 0 to this UT.");
        break;
    }
 
    return ret;
}
 
uint32_t
SatStatsHelper::GetIdentifierForBeam(uint32_t satId, uint32_t beamId) const
{
    uint32_t ret = 0;
 
    switch (m_identifierType)
    {
    case SatStatsHelper::IDENTIFIER_GLOBAL:
        ret = 0;
        break;
 
    case SatStatsHelper::IDENTIFIER_GW: {
        const uint32_t gwId = m_satHelper->GetBeamHelper()->GetGwId(satId, beamId);
        NS_ASSERT_MSG(gwId != 0, "Beam " << beamId << " is not attached to any GW");
        ret = gwId;
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_SAT: {
        ret = satId;
 
        break;
    }
 
    case SatStatsHelper::IDENTIFIER_BEAM:
        ret = SatConstVariables::MAX_BEAMS_PER_SATELLITE * (satId + 1) + beamId;
        break;
 
    default:
        NS_LOG_WARN(this << " Identifier type " << GetIdentifierTypeName(m_identifierType)
                         << " is not valid for a beam." << " Assigning identifier 0 to this beam.");
        break;
    }
 
    return ret;
}
 
uint32_t
SatStatsHelper::GetIdentifierForGroup(uint32_t groupId) const
{
    uint32_t ret = 0;
 
    switch (m_identifierType)
    {
    case SatStatsHelper::IDENTIFIER_GLOBAL:
        ret = 0;
        break;
 
    case SatStatsHelper::IDENTIFIER_GROUP:
        ret = groupId;
        break;
 
    default:
        NS_LOG_WARN(this << " Identifier type " << GetIdentifierTypeName(m_identifierType)
                         << " is not valid for a group."
                         << " Assigning identifier 0 to this group.");
        break;
    }
 
    return ret;
}
 
uint32_t
SatStatsHelper::GetIdentifierForGw(Ptr<Node> gwNode) const
{
    if (m_identifierType == IDENTIFIER_GW)
    {
        return GetGwId(gwNode);
    }
    else if (m_identifierType == IDENTIFIER_GLOBAL)
    {
        return 0;
    }
    else
    {
        NS_LOG_WARN(this << " Identifier type " << GetIdentifierTypeName(m_identifierType)
                         << " is not valid for a GW." << " Assigning identifier 0 to this GW.");
        return 0;
    }
}
 
uint32_t
SatStatsHelper::GetIdentifierForSat(Ptr<Node> satNode) const
{
    if (m_identifierType == IDENTIFIER_SAT)
    {
        return GetSatId(satNode);
    }
    else if (m_identifierType == IDENTIFIER_GLOBAL)
    {
        return 0;
    }
    else
    {
        NS_LOG_WARN(this << " Identifier type " << GetIdentifierTypeName(m_identifierType)
                         << " is not valid for a SAT." << " Assigning identifier 0 to this SAT.");
        return 0;
    }
}
 
uint32_t
SatStatsHelper::GetIdentifierForIsl(Ptr<Node> satNodeSrc, Ptr<Node> satNodeDst) const
{
    if (m_identifierType == IDENTIFIER_ISL)
    {
        return SatConstVariables::MAX_SATELLITES * GetSatId(satNodeSrc) + GetSatId(satNodeDst);
    }
    else if (m_identifierType == IDENTIFIER_GLOBAL)
    {
        return 0;
    }
    else
    {
        NS_LOG_WARN(this << " Identifier type " << GetIdentifierTypeName(m_identifierType)
                         << " is not valid for a ISL." << " Assigning identifier 0 to this ISL.");
        return 0;
    }
}
 
NetDeviceContainer // static
SatStatsHelper::GetGwSatNetDevice(Ptr<Node> gwNode)
{
    NetDeviceContainer ret;
 
    NS_LOG_DEBUG("Node ID " << gwNode->GetId() << " has " << gwNode->GetNDevices() << " devices");
    /*
     * Assuming that device #0 is for loopback device, device #(N-1) is for
     * backbone network device, and devices #1 until #(N-2) are for satellite
     * beam device. ==> This is true for DVB, but not for Lora: now we keep all
     * devices that can be casted to SatNetDevice.
     */
    for (uint32_t i = 0; i < gwNode->GetNDevices(); i++)
    {
        Ptr<SatNetDevice> dev = DynamicCast<SatNetDevice>(gwNode->GetDevice(i));
 
        if (dev != nullptr)
        {
            ret.Add(dev);
        }
    }
 
    return ret;
}
 
Ptr<NetDevice> // static
SatStatsHelper::GetUtSatNetDevice(Ptr<Node> utNode)
{
    /*
     * Assuming that device #0 is for loopback device, device #1 is for
     * subscriber network device, and device #2 is for satellite beam device.
     */
    NS_ASSERT(utNode->GetNDevices() >= 3);
    Ptr<NetDevice> dev = utNode->GetDevice(2);
 
    if (dev->GetObject<SatNetDevice>() == nullptr)
    {
        NS_FATAL_ERROR("Node " << utNode->GetId() << " is not a valid UT");
    }
 
    return dev;
}
 
Ptr<NetDevice> // static
SatStatsHelper::GetSatSatOrbiterNetDevice(Ptr<Node> satNode)
{
    NS_ASSERT(satNode->GetNDevices() > 0);
    Ptr<NetDevice> dev = satNode->GetDevice(0);
 
    if (dev->GetObject<SatOrbiterNetDevice>() == nullptr)
    {
        NS_FATAL_ERROR("Node " << satNode->GetId() << " is not a valid SAT");
    }
 
    return dev;
}
 
void
SatStatsHelper::SaveAddressAndIdentifier(Ptr<Node> utNode)
{
    NS_LOG_FUNCTION(this << utNode->GetId());
 
    const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
    const Address addr = satIdMapper->GetUtMacWithNode(utNode);
 
    if (addr.IsInvalid())
    {
        NS_LOG_WARN(this << " Node " << utNode->GetId() << " is not a valid UT");
    }
    else
    {
        const uint32_t identifier = GetIdentifierForUt(utNode);
        m_identifierMap[addr] = identifier;
        NS_LOG_INFO(this << " associated address " << addr << " with identifier " << identifier);
    }
}
 
void
SatStatsHelper::UpdateAddressAndIdentifier(Ptr<Node> utNode)
{
    NS_LOG_FUNCTION(this << utNode->GetId());
 
    const SatIdMapper* satIdMapper = Singleton<SatIdMapper>::Get();
    const Address addr = satIdMapper->GetUtMacWithNode(utNode);
 
    if (addr.IsInvalid())
    {
        NS_LOG_WARN(this << " Node " << utNode->GetId() << " is not a valid UT");
    }
    else
    {
        const uint32_t identifier = GetIdentifierForUt(utNode);
        m_identifierMap[addr] = identifier;
        NS_LOG_INFO(this << " update address " << addr << " to identifier " << identifier);
    }
}
 
void
SatStatsHelper::UpdateIdentifierOnProbes()
{
    NS_LOG_FUNCTION(this);
}
 
} // end of namespace ns3