satellite-stats-window-load-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-window-load-helper.h"
 
#include <ns3/boolean.h>
#include <ns3/data-collection-object.h>
#include <ns3/distribution-collector.h>
#include <ns3/enum.h>
#include <ns3/log.h>
#include <ns3/magister-gnuplot-aggregator.h>
#include <ns3/multi-file-aggregator.h>
#include <ns3/node.h>
#include <ns3/object-map.h>
#include <ns3/object-vector.h>
#include <ns3/satellite-helper.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 <ns3/unit-conversion-collector.h>
 
#include <sstream>
 
NS_LOG_COMPONENT_DEFINE("SatStatsWindowLoadHelper");
 
namespace ns3
{
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsWindowLoadHelper);
 
SatStatsWindowLoadHelper::SatStatsWindowLoadHelper(Ptr<const SatHelper> satHelper)
    : SatStatsHelper(satHelper),
      m_traceSinkCallback(MakeCallback(&SatStatsWindowLoadHelper::WindowLoadCallback, this))
{
    NS_LOG_FUNCTION(this << satHelper);
}
 
SatStatsWindowLoadHelper::~SatStatsWindowLoadHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsWindowLoadHelper::GetTypeId()
{
    static TypeId tid = TypeId("ns3::SatStatsWindowLoadHelper").SetParent<SatStatsHelper>();
    return tid;
}
 
void
SatStatsWindowLoadHelper::WindowLoadCallback(double windowLoad)
{
    NS_LOG_FUNCTION(this << windowLoad);
 
    switch (GetOutputType())
    {
    case SatStatsHelper::OUTPUT_SCALAR_FILE:
    case SatStatsHelper::OUTPUT_SCALAR_PLOT: {
        Ptr<ScalarCollector> c = m_collector->GetObject<ScalarCollector>();
        NS_ASSERT(c != nullptr);
        c->TraceSinkDouble(0.0, windowLoad);
        break;
    }
 
    case SatStatsHelper::OUTPUT_SCATTER_FILE:
    case SatStatsHelper::OUTPUT_SCATTER_PLOT: {
        Ptr<UnitConversionCollector> c = m_collector->GetObject<UnitConversionCollector>();
        NS_ASSERT(c != nullptr);
        c->TraceSinkDouble(0.0, windowLoad);
        break;
    }
 
    case SatStatsHelper::OUTPUT_HISTOGRAM_FILE:
    case SatStatsHelper::OUTPUT_HISTOGRAM_PLOT:
    case SatStatsHelper::OUTPUT_PDF_FILE:
    case SatStatsHelper::OUTPUT_PDF_PLOT:
    case SatStatsHelper::OUTPUT_CDF_FILE:
    case SatStatsHelper::OUTPUT_CDF_PLOT: {
        Ptr<DistributionCollector> c = m_collector->GetObject<DistributionCollector>();
        NS_ASSERT(c != nullptr);
        c->TraceSinkDouble(0.0, windowLoad);
        break;
    }
 
    default:
        NS_FATAL_ERROR(GetOutputTypeName(GetOutputType())
                       << " is not a valid output type for this statistics.");
        break;
 
    } // end of `switch (GetOutputType ())`
 
} // end of `void RxPowerCallback (double);`
 
Callback<void, double>
SatStatsWindowLoadHelper::GetTraceSinkCallback() const
{
    return m_traceSinkCallback;
}
 
void
SatStatsWindowLoadHelper::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("window_load")));
        Ptr<MultiFileAggregator> aggregator = m_aggregator->GetObject<MultiFileAggregator>();
 
        // Setup collector.
        Ptr<ScalarCollector> collector = CreateObject<ScalarCollector>();
        collector->SetName("0");
        collector->SetInputDataType(ScalarCollector::INPUT_DATA_TYPE_DOUBLE);
        collector->SetOutputType(ScalarCollector::OUTPUT_TYPE_AVERAGE_PER_SAMPLE);
        collector->TraceConnect("Output",
                                "0",
                                MakeCallback(&MultiFileAggregator::Write1d, aggregator));
        m_collector = collector->GetObject<DataCollectionObject>();
 
        break;
    }
 
    case SatStatsHelper::OUTPUT_SCATTER_FILE: {
        // Setup aggregator.
        m_aggregator = CreateAggregator("ns3::MultiFileAggregator",
                                        "OutputFileName",
                                        StringValue(GetOutputFileName()),
                                        "GeneralHeading",
                                        StringValue(GetTimeHeading("window_load")));
        Ptr<MultiFileAggregator> aggregator = m_aggregator->GetObject<MultiFileAggregator>();
 
        // Setup collector.
        Ptr<UnitConversionCollector> collector = CreateObject<UnitConversionCollector>();
        collector->SetName("0");
        collector->SetConversionType(UnitConversionCollector::TRANSPARENT);
        collector->TraceConnect("OutputTimeValue",
                                "0",
                                MakeCallback(&MultiFileAggregator::Write2d, aggregator));
        m_collector = collector->GetObject<DataCollectionObject>();
 
        break;
    }
 
    case SatStatsHelper::OUTPUT_HISTOGRAM_FILE:
    case SatStatsHelper::OUTPUT_PDF_FILE:
    case SatStatsHelper::OUTPUT_CDF_FILE: {
        // Setup aggregator.
        m_aggregator = CreateAggregator("ns3::MultiFileAggregator",
                                        "OutputFileName",
                                        StringValue(GetOutputFileName()),
                                        "GeneralHeading",
                                        StringValue(GetDistributionHeading("window_load")));
        Ptr<MultiFileAggregator> aggregator = m_aggregator->GetObject<MultiFileAggregator>();
 
        // Setup collector.
        Ptr<DistributionCollector> collector = CreateObject<DistributionCollector>();
        collector->SetName("0");
        if (GetOutputType() == SatStatsHelper::OUTPUT_HISTOGRAM_FILE)
        {
            collector->SetOutputType(DistributionCollector::OUTPUT_TYPE_HISTOGRAM);
        }
        else if (GetOutputType() == SatStatsHelper::OUTPUT_PDF_FILE)
        {
            collector->SetOutputType(DistributionCollector::OUTPUT_TYPE_PROBABILITY);
        }
        else if (GetOutputType() == SatStatsHelper::OUTPUT_CDF_FILE)
        {
            collector->SetOutputType(DistributionCollector::OUTPUT_TYPE_CUMULATIVE);
        }
        collector->TraceConnect("Output",
                                "0",
                                MakeCallback(&MultiFileAggregator::Write2d, aggregator));
        collector->TraceConnect("OutputString",
                                "0",
                                MakeCallback(&MultiFileAggregator::AddContextHeading, aggregator));
        collector->TraceConnect(
            "Warning",
            "0",
            MakeCallback(&MultiFileAggregator::EnableContextWarning, aggregator));
        m_collector = collector->GetObject<DataCollectionObject>();
 
        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)", "Window normalized load (in bps/Hz)");
        plotAggregator->Add2dDataset("0", "0");
        plotAggregator->Set2dDatasetDefaultStyle(Gnuplot2dDataset::LINES);
 
        // Setup collector.
        Ptr<UnitConversionCollector> collector = CreateObject<UnitConversionCollector>();
        collector->SetName("0");
        collector->SetConversionType(UnitConversionCollector::TRANSPARENT);
        collector->TraceConnect("OutputTimeValue",
                                "0",
                                MakeCallback(&MagisterGnuplotAggregator::Write2d, plotAggregator));
        m_collector = collector->GetObject<DataCollectionObject>();
 
        break;
    }
 
    case SatStatsHelper::OUTPUT_HISTOGRAM_PLOT:
    case SatStatsHelper::OUTPUT_PDF_PLOT:
    case SatStatsHelper::OUTPUT_CDF_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("Window normalized load (in bps/Hz)", "Frequency");
        plotAggregator->Add2dDataset("0", "0");
        plotAggregator->Set2dDatasetDefaultStyle(Gnuplot2dDataset::LINES);
 
        // Setup collector.
        Ptr<DistributionCollector> collector = CreateObject<DistributionCollector>();
        collector->SetName("0");
        if (GetOutputType() == SatStatsHelper::OUTPUT_HISTOGRAM_PLOT)
        {
            collector->SetOutputType(DistributionCollector::OUTPUT_TYPE_HISTOGRAM);
        }
        else if (GetOutputType() == SatStatsHelper::OUTPUT_PDF_PLOT)
        {
            collector->SetOutputType(DistributionCollector::OUTPUT_TYPE_PROBABILITY);
        }
        else if (GetOutputType() == SatStatsHelper::OUTPUT_CDF_PLOT)
        {
            collector->SetOutputType(DistributionCollector::OUTPUT_TYPE_CUMULATIVE);
        }
        collector->TraceConnect("Output",
                                "0",
                                MakeCallback(&MagisterGnuplotAggregator::Write2d, plotAggregator));
        m_collector = collector->GetObject<DataCollectionObject>();
 
        break;
    }
 
    default:
        NS_FATAL_ERROR("SatStatsWindowLoadHelper - Invalid output type");
        break;
    }
 
    // Setup probes and connect them to the collectors.
    InstallProbes();
 
} // end of `void DoInstall ();`
 
void
SatStatsWindowLoadHelper::InstallProbes()
{
    // The method below is supposed to be implemented by the child class.
    DoInstallProbes();
}
 
// RETURN FEEDER LINK ////////////////////////////////////////////////////////
 
NS_OBJECT_ENSURE_REGISTERED(SatStatsRtnFeederWindowLoadHelper);
 
SatStatsRtnFeederWindowLoadHelper::SatStatsRtnFeederWindowLoadHelper(Ptr<const SatHelper> satHelper)
    : SatStatsWindowLoadHelper(satHelper)
{
    NS_LOG_FUNCTION(this << satHelper);
}
 
SatStatsRtnFeederWindowLoadHelper::~SatStatsRtnFeederWindowLoadHelper()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId // static
SatStatsRtnFeederWindowLoadHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::SatStatsRtnFeederWindowLoadHelper").SetParent<SatStatsWindowLoadHelper>();
    return tid;
}
 
void
SatStatsRtnFeederWindowLoadHelper::DoInstallProbes()
{
    NS_LOG_FUNCTION(this);
 
    NodeContainer gws = Singleton<SatTopology>::Get()->GetGwNodes();
    for (NodeContainer::Iterator it = gws.Begin(); it != gws.End(); ++it)
    {
        NetDeviceContainer devs = GetGwSatNetDevice(*it);
 
        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 " << (*it)->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() !=
                    SatPhyRxCarrier::CarrierType::RA_ESSA)
                {
                    continue;
                }
                // NS_ASSERT (itCarrier->second->m_channelType == SatEnums::RETURN_FEEDER_CH)
                if (!itCarrier->second->TraceConnectWithoutContext("WindowLoad",
                                                                   GetTraceSinkCallback()))
                {
                    NS_FATAL_ERROR("Error connecting to WindowLoad trace source"
                                   << " of SatPhyRxCarrier"
                                   << " at node ID " << (*it)->GetId() << " device #"
                                   << (*itDev)->GetIfIndex() << " RX carrier #"
                                   << itCarrier->first);
                }
 
            } // end of `for (ObjectVectorValue::Iterator itCarrier = carriers)`
 
        } // end of `for (it = gws.Begin(); it != gws.End (); ++it)`
 
    } // end of `for (itDev = devs.Begin (); itDev != devs.End (); ++itDev)`
 
} // end of `void DoInstallProbes ();`
 
} // end of namespace ns3