satellite-stats-packet-error-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-packet-error-helper.h"
 
#include "satellite-phy-rx-carrier-packet-probe.h"
 
#include "ns3/boolean.h"
#include "ns3/callback.h"
#include "ns3/data-collection-object.h"
#include "ns3/enum.h"
#include "ns3/interval-rate-collector.h"
#include "ns3/log.h"
#include "ns3/mac48-address.h"
#include "ns3/magister-gnuplot-aggregator.h"
#include "ns3/multi-file-aggregator.h"
#include "ns3/node-container.h"
#include "ns3/object-vector.h"
#include "ns3/satellite-helper.h"
#include "ns3/satellite-id-mapper.h"
#include "ns3/satellite-net-device.h"
#include "ns3/satellite-orbiter-net-device.h"
#include "ns3/satellite-phy-rx-carrier.h"
#include "ns3/satellite-phy-rx.h"
#include "ns3/satellite-phy.h"
#include "ns3/satellite-topology.h"
#include "ns3/scalar-collector.h"
#include "ns3/singleton.h"
#include "ns3/string.h"
 
#include <map>
#include <sstream>
#include <string>
#include <utility>
 
NS_LOG_COMPONENT_DEFINE("SatStatsPacketErrorHelper");
 
namespace ns3
{
 
// BASE CLASS /////////////////////////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsPacketErrorHelper);
 
SatStatsPacketErrorHelper::SatStatsPacketErrorHelper(Ptr<const SatHelper> satHelper)
    : SatStatsHelper(satHelper),
      m_traceSourceName(""),
      m_channelType(SatEnums::UNKNOWN_CH)
{
    NS_LOG_FUNCTION(this << satHelper);
}
 
SatStatsPacketErrorHelper::~SatStatsPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsPacketErrorHelper::GetTypeId()
{
    static TypeId tid = TypeId("ns3::SatStatsPacketErrorHelper").SetParent<SatStatsHelper>();
    return tid;
}
 
void
SatStatsPacketErrorHelper::SetTraceSourceName(std::string traceSourceName)
{
    NS_LOG_FUNCTION(this << traceSourceName);
    m_traceSourceName = traceSourceName;
}
 
std::string
SatStatsPacketErrorHelper::GetTraceSourceName() const
{
    return m_traceSourceName;
}
 
void
SatStatsPacketErrorHelper::SetChannelType(SatEnums::ChannelType_t channelType)
{
    NS_LOG_FUNCTION(this << SatEnums::GetChannelTypeName(channelType));
    m_channelType = channelType;
}
 
SatEnums::ChannelType_t
SatStatsPacketErrorHelper::GetChannelType() const
{
    return m_channelType;
}
 
void
SatStatsPacketErrorHelper::DoInstall()
{
    NS_LOG_FUNCTION(this);
 
    switch (GetOutputType())
    {
    case SatStatsHelper::OUTPUT_NONE:
        NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
                       << " is not a valid output type for this statistics.");
        break;
 
    case SatStatsHelper::OUTPUT_SCALAR_FILE: {
        // Setup aggregator.
        m_aggregator = CreateAggregator("ns3::MultiFileAggregator",
                                        "OutputFileName",
                                        StringValue(GetOutputFileName()),
                                        "MultiFileMode",
                                        BooleanValue(false),
                                        "EnableContextPrinting",
                                        BooleanValue(true),
                                        "GeneralHeading",
                                        StringValue(GetIdentifierHeading("error_rate")));
 
        // Setup collectors.
        m_terminalCollectors.SetType("ns3::ScalarCollector");
        m_terminalCollectors.SetAttribute("InputDataType",
                                          EnumValue(ScalarCollector::INPUT_DATA_TYPE_BOOLEAN));
        m_terminalCollectors.SetAttribute(
            "OutputType",
            EnumValue(ScalarCollector::OUTPUT_TYPE_AVERAGE_PER_SAMPLE));
        CreateCollectorPerIdentifier(m_terminalCollectors);
        m_terminalCollectors.ConnectToAggregator("Output",
                                                 m_aggregator,
                                                 &MultiFileAggregator::Write1d);
        break;
    }
 
    case SatStatsHelper::OUTPUT_SCATTER_FILE: {
        // Setup aggregator.
        m_aggregator = CreateAggregator("ns3::MultiFileAggregator",
                                        "OutputFileName",
                                        StringValue(GetOutputFileName()),
                                        "GeneralHeading",
                                        StringValue(GetTimeHeading("error_rate")));
 
        // Setup collectors.
        m_terminalCollectors.SetType("ns3::IntervalRateCollector");
        m_terminalCollectors.SetAttribute(
            "InputDataType",
            EnumValue(IntervalRateCollector::INPUT_DATA_TYPE_BOOLEAN));
        m_terminalCollectors.SetAttribute(
            "OutputType",
            EnumValue(IntervalRateCollector::OUTPUT_TYPE_AVERAGE_PER_SAMPLE));
        CreateCollectorPerIdentifier(m_terminalCollectors);
        m_terminalCollectors.ConnectToAggregator("OutputWithTime",
                                                 m_aggregator,
                                                 &MultiFileAggregator::Write2d);
        m_terminalCollectors.ConnectToAggregator("OutputString",
                                                 m_aggregator,
                                                 &MultiFileAggregator::AddContextHeading);
        break;
    }
 
    case SatStatsHelper::OUTPUT_HISTOGRAM_FILE:
    case SatStatsHelper::OUTPUT_PDF_FILE:
    case SatStatsHelper::OUTPUT_CDF_FILE:
        NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
                       << " is not a valid output type for this statistics.");
        break;
 
    case SatStatsHelper::OUTPUT_SCALAR_PLOT:
        NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
                       << " is not a valid output type for this statistics.");
        break;
 
    case SatStatsHelper::OUTPUT_SCATTER_PLOT: {
        // Setup aggregator.
        m_aggregator = CreateAggregator("ns3::MagisterGnuplotAggregator",
                                        "OutputPath",
                                        StringValue(GetOutputPath()),
                                        "OutputFileName",
                                        StringValue(GetName()));
        Ptr<MagisterGnuplotAggregator> plotAggregator =
            m_aggregator->GetObject<MagisterGnuplotAggregator>();
        NS_ASSERT(plotAggregator != nullptr);
        // plot->SetTitle ("");
        plotAggregator->SetLegend("Time (in seconds)", "Packet error rate");
        plotAggregator->Set2dDatasetDefaultStyle(Gnuplot2dDataset::LINES);
 
        // Setup collectors.
        m_terminalCollectors.SetType("ns3::IntervalRateCollector");
        m_terminalCollectors.SetAttribute(
            "InputDataType",
            EnumValue(IntervalRateCollector::INPUT_DATA_TYPE_BOOLEAN));
        m_terminalCollectors.SetAttribute(
            "OutputType",
            EnumValue(IntervalRateCollector::OUTPUT_TYPE_AVERAGE_PER_SAMPLE));
        CreateCollectorPerIdentifier(m_terminalCollectors);
        for (CollectorMap::Iterator it = m_terminalCollectors.Begin();
             it != m_terminalCollectors.End();
             ++it)
        {
            const std::string context = it->second->GetName();
            plotAggregator->Add2dDataset(context, context);
        }
        m_terminalCollectors.ConnectToAggregator("OutputWithTime",
                                                 m_aggregator,
                                                 &MagisterGnuplotAggregator::Write2d);
        break;
    }
 
    case SatStatsHelper::OUTPUT_HISTOGRAM_PLOT:
    case SatStatsHelper::OUTPUT_PDF_PLOT:
    case SatStatsHelper::OUTPUT_CDF_PLOT:
        NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
                       << " is not a valid output type for this statistics.");
        break;
 
    default:
        NS_FATAL_ERROR("SatStatsPacketErrorHelper - Invalid output type");
        break;
    }
 
    switch (m_channelType)
    {
    case SatEnums::FORWARD_USER_CH: {
        // Connect to trace sources at UT nodes.
        NodeContainer uts = Singleton<SatTopology>::Get()->GetUtNodes();
        for (NodeContainer::Iterator it = uts.Begin(); it != uts.End(); ++it)
        {
            InstallProbeOnUt(*it);
        }
 
        break;
    }
 
    case SatEnums::FORWARD_FEEDER_CH: {
        // Create a map of UT addresses and identifiers.
        NodeContainer uts = Singleton<SatTopology>::Get()->GetUtNodes();
        for (NodeContainer::Iterator it = uts.Begin(); it != uts.End(); ++it)
        {
            SaveAddressAndIdentifier(*it);
        }
 
        // Connect to trace sources at SAT nodes.
        NodeContainer sats = Singleton<SatTopology>::Get()->GetOrbiterNodes();
        for (NodeContainer::Iterator it = sats.Begin(); it != sats.End(); ++it)
        {
            InstallProbeOnSatFeeder(*it);
        }
 
        break;
    }
 
    case SatEnums::RETURN_FEEDER_CH: {
        // Create a map of UT addresses and identifiers.
        NodeContainer uts = Singleton<SatTopology>::Get()->GetUtNodes();
        for (NodeContainer::Iterator it = uts.Begin(); it != uts.End(); ++it)
        {
            SaveAddressAndIdentifier(*it);
        }
 
        // Connect to trace sources at GW nodes.
        NodeContainer gws = Singleton<SatTopology>::Get()->GetGwNodes();
        for (NodeContainer::Iterator it = gws.Begin(); it != gws.End(); ++it)
        {
            InstallProbeOnGw(*it);
        }
 
        break;
    }
 
    case SatEnums::RETURN_USER_CH: {
        // Create a map of UT addresses and identifiers.
        NodeContainer uts = Singleton<SatTopology>::Get()->GetUtNodes();
        for (NodeContainer::Iterator it = uts.Begin(); it != uts.End(); ++it)
        {
            SaveAddressAndIdentifier(*it);
        }
 
        // Connect to trace sources at SAT nodes.
        NodeContainer sats = Singleton<SatTopology>::Get()->GetOrbiterNodes();
        for (NodeContainer::Iterator it = sats.Begin(); it != sats.End(); ++it)
        {
            InstallProbeOnSatUser(*it);
        }
 
        break;
    }
 
    default:
        NS_FATAL_ERROR("SatStatsPacketErrorHelper - Invalid link");
        break;
    }
 
} // end of `void DoInstall ();`
 
void
SatStatsPacketErrorHelper::ErrorRxCallback(uint32_t nPackets, const Address& fromOrTo, bool isError)
{
    NS_LOG_FUNCTION(this << nPackets << fromOrTo << isError);
 
    if (fromOrTo.IsInvalid())
    {
        NS_LOG_WARN(this << " discarding " << nPackets << " packets"
                         << " from statistics collection because of"
                         << " invalid sender/destination address");
    }
    else if (Mac48Address::ConvertFrom(fromOrTo).IsBroadcast())
    {
        for (std::pair<const Address, uint32_t> item : m_identifierMap)
        {
            // Find the first-level collector with the right identifier.
            Ptr<DataCollectionObject> collector = m_terminalCollectors.Get(item.second);
            NS_ASSERT_MSG(collector != nullptr,
                          "Unable to find collector with identifier " << item.second);
 
            switch (GetOutputType())
            {
            case SatStatsHelper::OUTPUT_SCALAR_FILE:
            case SatStatsHelper::OUTPUT_SCALAR_PLOT: {
                Ptr<ScalarCollector> c = collector->GetObject<ScalarCollector>();
                NS_ASSERT(c != nullptr);
                c->TraceSinkBoolean(false, isError);
                break;
            }
 
            case SatStatsHelper::OUTPUT_SCATTER_FILE:
            case SatStatsHelper::OUTPUT_SCATTER_PLOT: {
                Ptr<IntervalRateCollector> c = collector->GetObject<IntervalRateCollector>();
                NS_ASSERT(c != nullptr);
                c->TraceSinkBoolean(false, isError);
                break;
            }
 
            default:
                NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
                               << " is not a valid output type for this statistics.");
                break;
 
            } // end of `switch (GetOutputType ())`
        } // end of for (it == m_identifierMap.begin ())
    }
    else
    {
        // Determine the identifier associated with the sender address.
        std::map<const Address, uint32_t>::const_iterator it = m_identifierMap.find(fromOrTo);
 
        if (it == m_identifierMap.end())
        {
            NS_LOG_WARN(this << " discarding " << nPackets << " packets"
                             << " from statistics collection because of"
                             << " unknown sender/destination address " << fromOrTo);
        }
        else
        {
            // Find the first-level collector with the right identifier.
            Ptr<DataCollectionObject> collector = m_terminalCollectors.Get(it->second);
            NS_ASSERT_MSG(collector != nullptr,
                          "Unable to find collector with identifier " << it->second);
 
            switch (GetOutputType())
            {
            case SatStatsHelper::OUTPUT_SCALAR_FILE:
            case SatStatsHelper::OUTPUT_SCALAR_PLOT: {
                Ptr<ScalarCollector> c = collector->GetObject<ScalarCollector>();
                NS_ASSERT(c != nullptr);
                c->TraceSinkBoolean(false, isError);
                break;
            }
 
            case SatStatsHelper::OUTPUT_SCATTER_FILE:
            case SatStatsHelper::OUTPUT_SCATTER_PLOT: {
                Ptr<IntervalRateCollector> c = collector->GetObject<IntervalRateCollector>();
                NS_ASSERT(c != nullptr);
                c->TraceSinkBoolean(false, isError);
                break;
            }
 
            default:
                NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
                               << " is not a valid output type for this statistics.");
                break;
 
            } // end of `switch (GetOutputType ())`
 
        } // end of else of `if (it == m_identifierMap.end ())`
 
    } // end of else of `if (from.IsInvalid ())`
 
} // end of `void ErrorRxCallback (uint32_t, const Address &, bool);`
 
bool
SatStatsPacketErrorHelper::ConnectProbeToCollector(Ptr<Probe> probe, uint32_t identifier)
{
    NS_LOG_FUNCTION(this << probe << probe->GetName() << identifier);
 
    // Connect the probe to the right collector.
    bool ret = false;
    switch (GetOutputType())
    {
    case SatStatsHelper::OUTPUT_SCALAR_FILE:
    case SatStatsHelper::OUTPUT_SCALAR_PLOT:
        ret = m_terminalCollectors.ConnectWithProbe(probe->GetObject<Probe>(),
                                                    "OutputBool",
                                                    identifier,
                                                    &ScalarCollector::TraceSinkBoolean);
        break;
 
    case SatStatsHelper::OUTPUT_SCATTER_FILE:
    case SatStatsHelper::OUTPUT_SCATTER_PLOT:
        ret = m_terminalCollectors.ConnectWithProbe(probe->GetObject<Probe>(),
                                                    "OutputBool",
                                                    identifier,
                                                    &IntervalRateCollector::TraceSinkBoolean);
        break;
 
    default:
        NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
                       << " is not a valid output type for this statistics.");
        break;
 
    } // end of `switch (GetOutputType ())`
 
    if (ret)
    {
        NS_LOG_INFO(this << " created probe " << probe->GetName() << ", connected to collector "
                         << identifier);
    }
    else
    {
        NS_LOG_WARN(this << " unable to connect probe " << probe->GetName() << " to collector "
                         << identifier);
    }
 
    return ret;
}
 
bool
SatStatsPacketErrorHelper::DisconnectProbeFromCollector(Ptr<Probe> probe, uint32_t identifier)
{
    NS_LOG_FUNCTION(this << probe << probe->GetName() << identifier);
 
    // Connect the probe to the right collector.
    bool ret = false;
    switch (GetOutputType())
    {
    case SatStatsHelper::OUTPUT_SCALAR_FILE:
    case SatStatsHelper::OUTPUT_SCALAR_PLOT:
        ret = m_terminalCollectors.DisconnectWithProbe(probe->GetObject<Probe>(),
                                                       "OutputBool",
                                                       identifier,
                                                       &ScalarCollector::TraceSinkBoolean);
        break;
 
    case SatStatsHelper::OUTPUT_SCATTER_FILE:
    case SatStatsHelper::OUTPUT_SCATTER_PLOT:
        ret = m_terminalCollectors.DisconnectWithProbe(probe->GetObject<Probe>(),
                                                       "OutputBool",
                                                       identifier,
                                                       &IntervalRateCollector::TraceSinkBoolean);
        break;
 
    default:
        NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
                       << " is not a valid output type for this statistics.");
        break;
 
    } // end of `switch (GetOutputType ())`
 
    if (ret)
    {
        NS_LOG_INFO(this << " probe " << probe->GetName() << ", disconnected from collector "
                         << identifier);
    }
    else
    {
        NS_LOG_WARN(this << " unable to disconnect probe " << probe->GetName() << " from collector "
                         << identifier);
    }
 
    return ret;
}
 
void
SatStatsPacketErrorHelper::UpdateIdentifierOnProbes()
{
    NS_LOG_FUNCTION(this);
 
    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>>::iterator it;
 
    for (it = m_probes.begin(); it != m_probes.end(); it++)
    {
        Ptr<Probe> probe = it->first;
        Ptr<Node> node = it->second.first;
        uint32_t identifier = it->second.second;
 
        if (!DisconnectProbeFromCollector(probe, identifier))
        {
            NS_FATAL_ERROR("Error disconnecting trace file on handover");
        }
 
        identifier = GetIdentifierForUtUser(node);
 
        if (!ConnectProbeToCollector(probe, identifier))
        {
            NS_FATAL_ERROR("Error connecting trace file on handover");
        }
 
        it->second.second = identifier;
    }
} // end of `void UpdateIdentifierOnProbes ();`
 
void
SatStatsPacketErrorHelper::InstallProbeOnGw(Ptr<Node> gwNode)
{
    NS_LOG_FUNCTION(this << gwNode->GetId());
 
    NetDeviceContainer devs = GetGwSatNetDevice(gwNode);
    Callback<void, uint32_t, const Address&, bool> callback =
        MakeCallback(&SatStatsPacketErrorHelper::ErrorRxCallback, this);
 
    for (NetDeviceContainer::Iterator itDev = devs.Begin(); itDev != devs.End(); ++itDev)
    {
        Ptr<SatNetDevice> satDev = (*itDev)->GetObject<SatNetDevice>();
        NS_ASSERT(satDev != nullptr);
        Ptr<SatPhy> satPhy = satDev->GetPhy();
        NS_ASSERT(satPhy != nullptr);
        Ptr<SatPhyRx> satPhyRx = satPhy->GetPhyRx();
        NS_ASSERT(satPhyRx != nullptr);
        ObjectVectorValue carriers;
        satPhyRx->GetAttribute("RxCarrierList", carriers);
        NS_LOG_DEBUG(this << " Node ID " << gwNode->GetId() << " device #" << (*itDev)->GetIfIndex()
                          << " has " << carriers.GetN() << " RX carriers");
 
        for (ObjectVectorValue::Iterator itCarrier = carriers.Begin(); itCarrier != carriers.End();
             ++itCarrier)
        {
            if (DynamicCast<SatPhyRxCarrier>(itCarrier->second)->GetCarrierType() !=
                GetValidCarrierType())
            {
                continue;
            }
            const bool ret =
                itCarrier->second->TraceConnectWithoutContext(GetTraceSourceName(), callback);
            if (ret)
            {
                NS_LOG_INFO(this << " successfully connected with node ID " << gwNode->GetId()
                                 << " device #" << (*itDev)->GetIfIndex() << " RX carrier #"
                                 << itCarrier->first);
            }
            else
            {
                NS_FATAL_ERROR("Error connecting to "
                               << GetTraceSourceName() << " trace source" << " of SatPhyRxCarrier"
                               << " at node ID " << gwNode->GetId() << " device #"
                               << (*itDev)->GetIfIndex() << " RX carrier #" << itCarrier->first);
            }
 
        } // end of `for (ObjectVectorValue::Iterator itCarrier = carriers)`
 
    } // end of `for (NetDeviceContainer::Iterator itDev = devs)`
 
} // end of `void InstallProbeOnGw (Ptr<Node>)`
 
void
SatStatsPacketErrorHelper::InstallProbeOnSatFeeder(Ptr<Node> satNode)
{
    NS_LOG_FUNCTION(this << satNode->GetId());
 
    Ptr<NetDevice> dev = GetSatSatOrbiterNetDevice(satNode);
    Callback<void, uint32_t, const Address&, bool> callback =
        MakeCallback(&SatStatsPacketErrorHelper::ErrorRxCallback, this);
 
    Ptr<SatPhy> satPhy;
    Ptr<SatOrbiterNetDevice> satOrbiterDev = dev->GetObject<SatOrbiterNetDevice>();
    NS_ASSERT(satOrbiterDev != nullptr);
    std::map<uint32_t, Ptr<SatPhy>> satOrbiterFeederPhys = satOrbiterDev->GetFeederPhy();
    for (std::map<uint32_t, Ptr<SatPhy>>::iterator itPhy = satOrbiterFeederPhys.begin();
         itPhy != satOrbiterFeederPhys.end();
         ++itPhy)
    {
        satPhy = itPhy->second;
        NS_ASSERT(satPhy != nullptr);
        Ptr<SatPhyRx> satPhyRx = satPhy->GetPhyRx();
        NS_ASSERT(satPhyRx != nullptr);
 
        ObjectVectorValue carriers;
        satPhyRx->GetAttribute("RxCarrierList", carriers);
        NS_LOG_DEBUG(this << " Node ID " << satNode->GetId() << " device #" << dev->GetIfIndex()
                          << " has " << carriers.GetN() << " RX carriers");
 
        for (ObjectVectorValue::Iterator itCarrier = carriers.Begin(); itCarrier != carriers.End();
             ++itCarrier)
        {
            if (DynamicCast<SatPhyRxCarrier>(itCarrier->second)->GetCarrierType() !=
                GetValidCarrierType())
            {
                continue;
            }
            const bool ret =
                itCarrier->second->TraceConnectWithoutContext(GetTraceSourceName(), callback);
            if (ret)
            {
                NS_LOG_INFO(this << " successfully connected with node ID " << satNode->GetId()
                                 << " device #" << dev->GetIfIndex() << " RX carrier #"
                                 << itCarrier->first);
            }
            else
            {
                NS_FATAL_ERROR("Error connecting to "
                               << GetTraceSourceName() << " trace source" << " of SatPhyRxCarrier"
                               << " at node ID " << satNode->GetId() << " device #"
                               << dev->GetIfIndex() << " RX carrier #" << itCarrier->first);
            }
 
        } // end of `for (ObjectVectorValue::Iterator itCarrier = carriers)`
 
    } // end of `for (std::map<uint32_t, Ptr<SatPhy>>::iterator itPhy = satOrbiterFeederPhys)`
 
} // end of `void InstallProbeOnSatFeeder (Ptr<Node>)`
 
void
SatStatsPacketErrorHelper::InstallProbeOnSatUser(Ptr<Node> satNode)
{
    NS_LOG_FUNCTION(this << satNode->GetId());
 
    Ptr<NetDevice> dev = GetSatSatOrbiterNetDevice(satNode);
    Callback<void, uint32_t, const Address&, bool> callback =
        MakeCallback(&SatStatsPacketErrorHelper::ErrorRxCallback, this);
 
    Ptr<SatPhy> satPhy;
    Ptr<SatOrbiterNetDevice> satOrbiterDev = dev->GetObject<SatOrbiterNetDevice>();
    NS_ASSERT(satOrbiterDev != nullptr);
    std::map<uint32_t, Ptr<SatPhy>> satOrbiterUserPhys = satOrbiterDev->GetUserPhy();
    for (std::map<uint32_t, Ptr<SatPhy>>::iterator itPhy = satOrbiterUserPhys.begin();
         itPhy != satOrbiterUserPhys.end();
         ++itPhy)
    {
        satPhy = itPhy->second;
        NS_ASSERT(satPhy != nullptr);
        Ptr<SatPhyRx> satPhyRx = satPhy->GetPhyRx();
        NS_ASSERT(satPhyRx != nullptr);
 
        ObjectVectorValue carriers;
        satPhyRx->GetAttribute("RxCarrierList", carriers);
        NS_LOG_DEBUG(this << " Node ID " << satNode->GetId() << " device #" << dev->GetIfIndex()
                          << " has " << carriers.GetN() << " RX carriers");
 
        for (ObjectVectorValue::Iterator itCarrier = carriers.Begin(); itCarrier != carriers.End();
             ++itCarrier)
        {
            if (DynamicCast<SatPhyRxCarrier>(itCarrier->second)->GetCarrierType() !=
                GetValidCarrierType())
            {
                continue;
            }
            const bool ret =
                itCarrier->second->TraceConnectWithoutContext(GetTraceSourceName(), callback);
            if (ret)
            {
                NS_LOG_INFO(this << " successfully connected with node ID " << satNode->GetId()
                                 << " device #" << dev->GetIfIndex() << " RX carrier #"
                                 << itCarrier->first);
            }
            else
            {
                NS_FATAL_ERROR("Error connecting to "
                               << GetTraceSourceName() << " trace source" << " of SatPhyRxCarrier"
                               << " at node ID " << satNode->GetId() << " device #"
                               << dev->GetIfIndex() << " RX carrier #" << itCarrier->first);
            }
 
        } // end of `for (ObjectVectorValue::Iterator itCarrier = carriers)`
 
    } // end of `for (std::map<uint32_t, Ptr<SatPhy>>::iterator itPhy = satOrbiterUserPhys)`
 
} // end of `void InstallProbeOnSatUser (Ptr<Node>)`
 
void
SatStatsPacketErrorHelper::InstallProbeOnUt(Ptr<Node> utNode)
{
    NS_LOG_FUNCTION(this << utNode->GetId());
 
    const int32_t utId = GetUtId(utNode);
    NS_ASSERT_MSG(utId > 0, "Node " << utNode->GetId() << " is not a valid UT");
    const uint32_t identifier = GetIdentifierForUt(utNode);
 
    // Create the probe.
    std::ostringstream probeName;
    probeName << utId;
    Ptr<SatPhyRxCarrierPacketProbe> probe = CreateObject<SatPhyRxCarrierPacketProbe>();
    probe->SetName(probeName.str());
 
    Ptr<NetDevice> dev = GetUtSatNetDevice(utNode);
    Ptr<SatNetDevice> satDev = dev->GetObject<SatNetDevice>();
    NS_ASSERT(satDev != nullptr);
    Ptr<SatPhy> satPhy = satDev->GetPhy();
    NS_ASSERT(satPhy != nullptr);
    Ptr<SatPhyRx> satPhyRx = satPhy->GetPhyRx();
    NS_ASSERT(satPhyRx != nullptr);
    ObjectVectorValue carriers;
    satPhyRx->GetAttribute("RxCarrierList", carriers);
    NS_LOG_DEBUG(this << " Node ID " << utNode->GetId() << " device #" << dev->GetIfIndex()
                      << " has " << carriers.GetN() << " RX carriers");
 
    for (ObjectVectorValue::Iterator itCarrier = carriers.Begin(); itCarrier != carriers.End();
         ++itCarrier)
    {
        if (DynamicCast<SatPhyRxCarrier>(itCarrier->second)->GetCarrierType() !=
            GetValidCarrierType())
        {
            continue;
        }
        // Connect the object to the probe.
        if (probe->ConnectByObject(GetTraceSourceName(), itCarrier->second) &&
            ConnectProbeToCollector(probe, identifier))
        {
            m_probes.insert(
                std::make_pair(probe->GetObject<Probe>(), std::make_pair(utNode, identifier)));
 
        } // end of `if (probe->ConnectByObject (GetTraceSourceName (), itCarrier->second))`
        else
        {
            NS_FATAL_ERROR("Error connecting to "
                           << GetTraceSourceName() << " trace source" << " of SatPhyRxCarrier"
                           << " at node ID " << utNode->GetId() << " device #" << dev->GetIfIndex()
                           << " RX carrier #" << itCarrier->first);
        }
 
    } // end of `for (ObjectVectorValue::Iterator itCarrier = carriers)`
 
} // end of `void InstallProbeOnUt (Ptr<Node>)`
 
// FORWARD FEEDER LINK DEDICATED ACCESS //////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsFwdFeederDaPacketErrorHelper);
 
SatStatsFwdFeederDaPacketErrorHelper::SatStatsFwdFeederDaPacketErrorHelper(
    Ptr<const SatHelper> satHelper)
    : SatStatsPacketErrorHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
    SetTraceSourceName("DaRx");
    SetChannelType(SatEnums::FORWARD_FEEDER_CH);
    SetValidCarrierType(SatPhyRxCarrier::DEDICATED_ACCESS);
}
 
SatStatsFwdFeederDaPacketErrorHelper::~SatStatsFwdFeederDaPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsFwdFeederDaPacketErrorHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatStatsFwdFeederDaPacketErrorHelper").SetParent<SatStatsPacketErrorHelper>();
    return tid;
}
 
// FORWARD USER LINK DEDICATED ACCESS //////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsFwdUserDaPacketErrorHelper);
 
SatStatsFwdUserDaPacketErrorHelper::SatStatsFwdUserDaPacketErrorHelper(
    Ptr<const SatHelper> satHelper)
    : SatStatsPacketErrorHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
    SetTraceSourceName("DaRx");
    SetChannelType(SatEnums::FORWARD_USER_CH);
    SetValidCarrierType(SatPhyRxCarrier::DEDICATED_ACCESS);
}
 
SatStatsFwdUserDaPacketErrorHelper::~SatStatsFwdUserDaPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsFwdUserDaPacketErrorHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatStatsFwdUserDaPacketErrorHelper").SetParent<SatStatsPacketErrorHelper>();
    return tid;
}
 
// RETURN FEEDER LINK DEDICATED ACCESS ///////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsRtnFeederDaPacketErrorHelper);
 
SatStatsRtnFeederDaPacketErrorHelper::SatStatsRtnFeederDaPacketErrorHelper(
    Ptr<const SatHelper> satHelper)
    : SatStatsPacketErrorHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
    SetTraceSourceName("DaRx");
    SetChannelType(SatEnums::RETURN_FEEDER_CH);
    SetValidCarrierType(SatPhyRxCarrier::DEDICATED_ACCESS);
}
 
SatStatsRtnFeederDaPacketErrorHelper::~SatStatsRtnFeederDaPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsRtnFeederDaPacketErrorHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatStatsRtnFeederDaPacketErrorHelper").SetParent<SatStatsPacketErrorHelper>();
    return tid;
}
 
// RETURN USER LINK DEDICATED ACCESS ///////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsRtnUserDaPacketErrorHelper);
 
SatStatsRtnUserDaPacketErrorHelper::SatStatsRtnUserDaPacketErrorHelper(
    Ptr<const SatHelper> satHelper)
    : SatStatsPacketErrorHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
    SetTraceSourceName("DaRx");
    SetChannelType(SatEnums::RETURN_USER_CH);
    SetValidCarrierType(SatPhyRxCarrier::DEDICATED_ACCESS);
}
 
SatStatsRtnUserDaPacketErrorHelper::~SatStatsRtnUserDaPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsRtnUserDaPacketErrorHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatStatsRtnUserDaPacketErrorHelper").SetParent<SatStatsPacketErrorHelper>();
    return tid;
}
 
// FEEDER SLOTTED ALOHA //////////////////////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsFeederSlottedAlohaPacketErrorHelper);
 
SatStatsFeederSlottedAlohaPacketErrorHelper::SatStatsFeederSlottedAlohaPacketErrorHelper(
    Ptr<const SatHelper> satHelper)
    : SatStatsPacketErrorHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
    SetTraceSourceName("SlottedAlohaRxError");
    SetChannelType(SatEnums::RETURN_FEEDER_CH);
    SetValidCarrierType(SatPhyRxCarrier::RA_SLOTTED_ALOHA);
}
 
SatStatsFeederSlottedAlohaPacketErrorHelper::~SatStatsFeederSlottedAlohaPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsFeederSlottedAlohaPacketErrorHelper::GetTypeId()
{
    static TypeId tid = TypeId("ns3::SatStatsFeederSlottedAlohaPacketErrorHelper")
                            .SetParent<SatStatsPacketErrorHelper>();
    return tid;
}
 
// USER SLOTTED ALOHA //////////////////////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsUserSlottedAlohaPacketErrorHelper);
 
SatStatsUserSlottedAlohaPacketErrorHelper::SatStatsUserSlottedAlohaPacketErrorHelper(
    Ptr<const SatHelper> satHelper)
    : SatStatsPacketErrorHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
    SetTraceSourceName("SlottedAlohaRxError");
    SetChannelType(SatEnums::RETURN_USER_CH);
    SetValidCarrierType(SatPhyRxCarrier::RA_SLOTTED_ALOHA);
}
 
SatStatsUserSlottedAlohaPacketErrorHelper::~SatStatsUserSlottedAlohaPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsUserSlottedAlohaPacketErrorHelper::GetTypeId()
{
    static TypeId tid = TypeId("ns3::SatStatsUserSlottedAlohaPacketErrorHelper")
                            .SetParent<SatStatsPacketErrorHelper>();
    return tid;
}
 
// FEEDER CRDSA //////////////////////////////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsFeederCrdsaPacketErrorHelper);
 
SatStatsFeederCrdsaPacketErrorHelper::SatStatsFeederCrdsaPacketErrorHelper(
    Ptr<const SatHelper> satHelper)
    : SatStatsPacketErrorHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
    SetTraceSourceName("CrdsaUniquePayloadRx");
    SetChannelType(SatEnums::RETURN_FEEDER_CH);
    SetValidCarrierType(SatPhyRxCarrier::RA_CRDSA);
}
 
SatStatsFeederCrdsaPacketErrorHelper::~SatStatsFeederCrdsaPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsFeederCrdsaPacketErrorHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatStatsFeederCrdsaPacketErrorHelper").SetParent<SatStatsPacketErrorHelper>();
    return tid;
}
 
// USER CRDSA //////////////////////////////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsUserCrdsaPacketErrorHelper);
 
SatStatsUserCrdsaPacketErrorHelper::SatStatsUserCrdsaPacketErrorHelper(
    Ptr<const SatHelper> satHelper)
    : SatStatsPacketErrorHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
    SetTraceSourceName("CrdsaUniquePayloadRx");
    SetChannelType(SatEnums::RETURN_USER_CH);
    SetValidCarrierType(SatPhyRxCarrier::RA_CRDSA);
}
 
SatStatsUserCrdsaPacketErrorHelper::~SatStatsUserCrdsaPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsUserCrdsaPacketErrorHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatStatsUserCrdsaPacketErrorHelper").SetParent<SatStatsPacketErrorHelper>();
    return tid;
}
 
// FEEDER E-SSA //////////////////////////////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsFeederEssaPacketErrorHelper);
 
SatStatsFeederEssaPacketErrorHelper::SatStatsFeederEssaPacketErrorHelper(
    Ptr<const SatHelper> satHelper)
    : SatStatsPacketErrorHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
    SetTraceSourceName("EssaRxError");
    SetChannelType(SatEnums::RETURN_FEEDER_CH);
    SetValidCarrierType(SatPhyRxCarrier::RA_ESSA);
}
 
SatStatsFeederEssaPacketErrorHelper::~SatStatsFeederEssaPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsFeederEssaPacketErrorHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatStatsFeederEssaPacketErrorHelper").SetParent<SatStatsPacketErrorHelper>();
    return tid;
}
 
// USER E-SSA //////////////////////////////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsUserEssaPacketErrorHelper);
 
SatStatsUserEssaPacketErrorHelper::SatStatsUserEssaPacketErrorHelper(Ptr<const SatHelper> satHelper)
    : SatStatsPacketErrorHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
    SetTraceSourceName("EssaRxError");
    SetChannelType(SatEnums::RETURN_USER_CH);
    SetValidCarrierType(SatPhyRxCarrier::RA_ESSA);
}
 
SatStatsUserEssaPacketErrorHelper::~SatStatsUserEssaPacketErrorHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsUserEssaPacketErrorHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatStatsUserEssaPacketErrorHelper").SetParent<SatStatsPacketErrorHelper>();
    return tid;
}
 
} // end of namespace ns3