simulation-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2016 Magister Solutions
 * Copyright (c) 2018 CNES
 *
 * 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: Lauri Sormunen <lauri.sormunen@magister.fi>
 * Author: Mathias Ettinger <mettinger@viveris.toulouse.fr>
 */
 
#ifndef SIMULATION_HELPER_H
#define SIMULATION_HELPER_H
 
#include <ns3/command-line.h>
#include <ns3/random-variable-stream.h>
#include <ns3/satellite-cno-helper.h>
#include <ns3/satellite-enums.h>
#include <ns3/satellite-group-helper.h>
#include <ns3/satellite-helper.h>
#include <ns3/satellite-stats-helper-container.h>
#include <ns3/satellite-traffic-helper.h>
 
#include <set>
 
#define STRINGIFY(x) #x
#define TOSTRING(x) STRINGIFY(x)
 
namespace ns3
{
 
class SimulationHelper : public Object
{
  public:
    SimulationHelper();
 
    SimulationHelper(std::string simulationName);
 
    virtual ~SimulationHelper();
 
    void DoDispose(void);
 
    static TypeId GetTypeId(void);
 
    TypeId GetInstanceTypeId(void) const;
 
    void SetDefaultValues();
 
    void SetBeams(const std::string& beamList);
 
    void SetBeamSet(std::set<uint32_t> beamSet);
 
    inline std::set<uint32_t> GetBeamSet(void) const
    {
        return m_enabledBeams;
    }
 
    const std::set<uint32_t>& GetBeams();
 
    void SetUtCountPerBeam(uint32_t count);
 
    void SetUtCountPerBeam(Ptr<RandomVariableStream> rs);
 
    void SetUtCountPerBeam(uint32_t beamId, uint32_t count);
 
    void SetUtCountPerBeam(uint32_t beamId, Ptr<RandomVariableStream> rs);
 
    void SetUserCountPerUt(uint32_t count);
 
    void SetUserCountPerUt(Ptr<RandomVariableStream> rs);
 
    void SetUserCountPerMobileUt(uint32_t count);
 
    void SetUserCountPerMobileUt(Ptr<RandomVariableStream> rs);
 
    void SetGwUserCount(uint32_t gwUserCount);
 
    void SetSimulationTime(double seconds);
 
    inline void SetSimulationTime(Time time)
    {
        m_simTime = time;
    }
 
    void SetIdealPhyParameterization();
 
    void EnableAcm(SatEnums::SatLinkDir_t dir);
 
    void DisableAcm(SatEnums::SatLinkDir_t dir);
 
    void DisableAllCapacityAssignmentCategories();
 
    void EnableOnlyConstantRate(uint32_t rcIndex, double rateKbps);
 
    void EnableOnlyRbdc(uint32_t rcIndex);
 
    void EnableOnlyVbdc(uint32_t rcIndex);
 
    void EnableFca();
 
    void DisableFca();
 
    void EnablePeriodicalControlSlots(Time periodicity);
 
    void EnableArq(SatEnums::SatLinkDir_t dir);
 
    void DisableRandomAccess();
 
    void EnableSlottedAloha();
 
    void EnableCrdsa();
 
    void ConfigureFrame(uint32_t superFrameId,
                        double bw,
                        double carrierBw,
                        double rollOff,
                        double carrierSpacing,
                        bool isRandomAccess = false);
 
    void ConfigureFrequencyBands();
 
    void ConfigureFwdLinkBeamHopping();
 
    void EnableExternalFadingInputTrace();
 
    void EnableOutputTraces();
 
    void ConfigureLinkBudget();
 
    void SetErrorModel(SatPhyRxCarrierConf::ErrorModel em, double errorRate = 0.0);
 
    void SetInterferenceModel(SatPhyRxCarrierConf::InterferenceModel ifModel,
                              double constantIf = 0.0);
 
    void EnableProgressLogs();
 
    void DisableProgressLogs();
 
    void AddDefaultUiArguments(CommandLine& cmd);
 
    void AddDefaultUiArguments(CommandLine& cmd, std::string& xmlInputFile);
 
    void RunSimulation();
 
    Ptr<SatHelper> CreateSatScenario(SatHelper::PreDefinedScenario_t scenario = SatHelper::NONE,
                                     const std::string& mobileUtsFolder = "");
 
    void CreateDefaultStats();
 
    void CreateDefaultFwdLinkStats();
 
    void CreateDefaultRtnLinkStats();
 
    void SetOutputTag(std::string tag);
 
    void SetOutputPath(std::string path);
 
    void ConfigureAttributesFromFile(std::string filePath, bool overrideManualConfiguration = true);
 
    void ReadInputAttributesFromFile(std::string filePath);
 
    std::string StoreAttributesToFile(std::string fileName, bool outputAttributes = false);
 
    inline Time& GetSimTime()
    {
        return m_simTime;
    }
 
    void SetCommonUtPositionAllocator(Ptr<SatListPositionAllocator> posAllocator);
 
    void SetUtPositionAllocatorForBeam(uint32_t beamId, Ptr<SatListPositionAllocator> posAllocator);
 
    void EnableUtListPositionsFromInputFile(std::string inputFile, bool checkBeams = true);
 
    inline Ptr<SatHelper> GetSatelliteHelper()
    {
        NS_ASSERT_MSG(m_satHelper != NULL,
                      "CreateSatScenario not called before calling GetSatelliteHelper");
        return m_satHelper;
    }
 
    Ptr<SatStatsHelperContainer> GetStatisticsContainer();
 
    Ptr<SatTrafficHelper> GetTrafficHelper();
 
    Ptr<SatGroupHelper> GetGroupHelper();
 
    Ptr<SatCnoHelper> GetCnoHelper();
 
    typedef enum
    {
        CBR,
        ONOFF,
        HTTP,
        NRTV,
    } TrafficModel_t;
 
    typedef enum
    {
        ONE_SHOT,
        PERIODIC,
        LORA_CBR,
    } LoraTrafficModel_t;
 
    typedef enum
    {
        UDP,
        TCP
    } TransportLayerProtocol_t;
 
    typedef enum
    {
        RTN_LINK,
        FWD_LINK
    } TrafficDirection_t;
 
    void InstallTrafficModel(TrafficModel_t trafficModel,
                             TransportLayerProtocol_t protocol,
                             TrafficDirection_t direction,
                             Time startTime,
                             Time stopTime,
                             Time startDelay,
                             double percentage);
 
    void InstallTrafficModel(TrafficModel_t trafficModel,
                             TransportLayerProtocol_t protocol,
                             TrafficDirection_t direction,
                             Time startTime,
                             Time stopTime,
                             Time startDelay)
    {
        InstallTrafficModel(trafficModel,
                            protocol,
                            direction,
                            startTime,
                            stopTime,
                            startDelay,
                            1.0);
    }
 
    void InstallTrafficModel(TrafficModel_t trafficModel,
                             TransportLayerProtocol_t protocol,
                             TrafficDirection_t direction,
                             Time startTime,
                             Time stopTime)
    {
        InstallTrafficModel(trafficModel, protocol, direction, startTime, stopTime, Seconds(0));
    }
 
    void InstallTrafficModel(TrafficModel_t trafficModel,
                             TransportLayerProtocol_t protocol,
                             TrafficDirection_t direction,
                             Time startTime)
    {
        InstallTrafficModel(trafficModel,
                            protocol,
                            direction,
                            startTime,
                            m_simTime + Seconds(1),
                            Seconds(0));
    }
 
    void InstallTrafficModel(TrafficModel_t trafficModel,
                             TransportLayerProtocol_t protocol,
                             TrafficDirection_t direction)
    {
        InstallTrafficModel(trafficModel,
                            protocol,
                            direction,
                            Seconds(0.001),
                            m_simTime + Seconds(1),
                            Seconds(0));
    }
 
    void InstallLoraTrafficModel(LoraTrafficModel_t trafficModel,
                                 Time interval,
                                 uint32_t packetSize,
                                 Time startTime,
                                 Time stopTime,
                                 Time startDelay);
 
    typedef enum
    {
        CR_NOT_CONFIGURED,
        CR_PERIODIC_CONTROL,
        CR_SLOTTED_ALOHA,
        CR_CRDSA_LOOSE_RC_0,
    } CrTxConf_t;
 
    void SetCrTxConf(CrTxConf_t crTxConf);
 
    inline void SetGwUserId(uint32_t gwUserId)
    {
        m_gwUserId = gwUserId;
    }
 
  protected:
    void EnableRandomAccess();
 
    void ProgressCb();
 
    bool IsBeamEnabled(uint32_t beamId) const;
 
    uint32_t GetNextUtCount(uint32_t beamId = 0) const;
 
    inline uint32_t GetNextUtUserCount() const
    {
        NS_ASSERT_MSG(m_utUserCount != NULL, "User count per UT not set");
        return m_utUserCount->GetInteger();
    }
 
    bool HasSinkInstalled(Ptr<Node> node, uint16_t port);
 
    void SetupOutputPath();
 
  private:
    Ptr<SatHelper> m_satHelper;
    Ptr<SatStatsHelperContainer> m_statContainer;
    Ptr<SatTrafficHelper> m_trafficHelper;
    Ptr<SatGroupHelper> m_groupHelper;
    Ptr<SatCnoHelper> m_cnoHelper;
    Ptr<SatListPositionAllocator> m_commonUtPositions;
    std::map<uint32_t, Ptr<SatListPositionAllocator>> m_utPositionsByBeam;
 
    std::string m_simulationName;
    std::string m_simulationTag;
    std::string m_enabledBeamsStr;
    std::set<uint32_t> m_enabledBeams;
    std::string m_outputPath;
 
    std::map<uint32_t, Ptr<RandomVariableStream>> m_utCount;
 
    Ptr<RandomVariableStream> m_utUserCount;
    Ptr<RandomVariableStream> m_utMobileUserCount;
    Time m_simTime;
    uint32_t m_numberOfConfiguredFrames;
    bool m_randomAccessConfigured;
    bool m_enableInputFileUtListPositions;
    bool m_inputFileUtPositionsCheckBeams;
    uint32_t m_gwUserId;
 
    bool m_progressLoggingEnabled;
    Time m_progressUpdateInterval;
    EventId m_progressReportEvent;
};
 
class SimulationHelperConf : public Object
{
  public:
    SimulationHelperConf();
 
    virtual ~SimulationHelperConf();
 
    static TypeId GetTypeId(void);
 
    TypeId GetInstanceTypeId(void) const;
 
    typedef enum
    {
        PROTOCOL_UDP,
        PROTOCOL_TCP,
        PROTOCOL_BOTH
    } TransportLayerProtocol_t;
 
    typedef enum
    {
        RTN_LINK,
        FWD_LINK,
        BOTH_LINK
    } TrafficDirection_t;
 
    typedef struct TrafficConfiguration_t
    {
        double m_percentage;
        TransportLayerProtocol_t m_protocol;
        TrafficDirection_t m_direction;
        Time m_startTime;
        Time m_stopTime;
        Time m_startDelay;
 
        TrafficConfiguration_t()
            : m_percentage(0.0),
              m_protocol(SimulationHelperConf::PROTOCOL_UDP),
              m_direction(SimulationHelperConf::RTN_LINK),
              m_startTime(0),
              m_stopTime(0),
              m_startDelay(0)
        {
            // do nothing
        }
    } TrafficConfiguration_t;
 
    Time m_simTime;
    std::string m_enabledBeams;
    Ptr<RandomVariableStream> m_utCount;
    Ptr<RandomVariableStream> m_utUserCount;
    Ptr<RandomVariableStream> m_utMobileUserCount;
    bool m_activateStatistics;
    bool m_activateProgressLogging;
    SimulationHelper::CrTxConf_t m_crTxConf;
    std::map<std::string, TrafficConfiguration_t> m_trafficModel;
    std::string m_mobileUtsFolder;
 
  private:
    void SetTrafficPercentage(std::string trafficModel, double percentage)
    {
        std::map<std::string, TrafficConfiguration_t>::iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            TrafficConfiguration_t traffic;
            traffic.m_percentage = percentage;
            m_trafficModel.emplace(trafficModel, traffic);
        }
        else
        {
            it->second.m_percentage = percentage;
        }
    }
 
    double GetTrafficPercentage(std::string trafficModel) const
    {
        std::map<std::string, TrafficConfiguration_t>::const_iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            NS_FATAL_ERROR("Traffic model " << trafficModel << " has not been configured");
        }
 
        return it->second.m_percentage;
    }
 
    void SetTrafficProtocol(std::string trafficModel, TransportLayerProtocol_t protocol)
    {
        std::map<std::string, TrafficConfiguration_t>::iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            TrafficConfiguration_t traffic;
            traffic.m_protocol = protocol;
            m_trafficModel.emplace(trafficModel, traffic);
        }
        else
        {
            it->second.m_protocol = protocol;
        }
    }
 
    TransportLayerProtocol_t GetTrafficProtocol(std::string trafficModel) const
    {
        std::map<std::string, TrafficConfiguration_t>::const_iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            NS_FATAL_ERROR("Traffic model " << trafficModel << " has not been configured");
        }
 
        return it->second.m_protocol;
    }
 
    void SetTrafficDirection(std::string trafficModel, TrafficDirection_t direction)
    {
        std::map<std::string, TrafficConfiguration_t>::iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            TrafficConfiguration_t traffic;
            traffic.m_direction = direction;
            m_trafficModel.emplace(trafficModel, traffic);
        }
        else
        {
            it->second.m_direction = direction;
        }
    }
 
    TrafficDirection_t GetTrafficDirection(std::string trafficModel) const
    {
        std::map<std::string, TrafficConfiguration_t>::const_iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            NS_FATAL_ERROR("Traffic model " << trafficModel << " has not been configured");
        }
 
        return it->second.m_direction;
    }
 
    void SetTrafficStartTime(std::string trafficModel, Time startTime)
    {
        std::map<std::string, TrafficConfiguration_t>::iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            TrafficConfiguration_t traffic;
            traffic.m_startTime = startTime;
            m_trafficModel.emplace(trafficModel, traffic);
        }
        else
        {
            it->second.m_startTime = startTime;
        }
    }
 
    Time GetTrafficStartTime(std::string trafficModel) const
    {
        std::map<std::string, TrafficConfiguration_t>::const_iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            NS_FATAL_ERROR("Traffic model " << trafficModel << " has not been configured");
        }
 
        return it->second.m_startTime;
    }
 
    void SetTrafficStopTime(std::string trafficModel, Time stopTime)
    {
        std::map<std::string, TrafficConfiguration_t>::iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            TrafficConfiguration_t traffic;
            traffic.m_startTime = stopTime;
            m_trafficModel.emplace(trafficModel, traffic);
        }
        else
        {
            it->second.m_stopTime = stopTime;
        }
    }
 
    Time GetTrafficStopTime(std::string trafficModel) const
    {
        std::map<std::string, TrafficConfiguration_t>::const_iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            NS_FATAL_ERROR("Traffic model " << trafficModel << " has not been configured");
        }
 
        return it->second.m_stopTime;
    }
 
    void SetTrafficStartDelay(std::string trafficModel, Time startDelay)
    {
        std::map<std::string, TrafficConfiguration_t>::iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            TrafficConfiguration_t traffic;
            traffic.m_startDelay = startDelay;
            m_trafficModel.emplace(trafficModel, traffic);
        }
        else
        {
            it->second.m_startDelay = startDelay;
        }
    }
 
    Time GetTrafficStartDelay(std::string trafficModel) const
    {
        std::map<std::string, TrafficConfiguration_t>::const_iterator it =
            m_trafficModel.find(trafficModel);
        if (it == m_trafficModel.end())
        {
            NS_FATAL_ERROR("Traffic model " << trafficModel << " has not been configured");
        }
 
        return it->second.m_startDelay;
    }
 
#define TRAFFIC_MODEL_ATTRIBUTE_ACCESSOR_DEFINE(index)                                             \
    inline void SetTraffic##index##Percentage(double value)                                        \
    {                                                                                              \
        return SetTrafficPercentage(TOSTRING(index), value);                                       \
    }                                                                                              \
    inline double GetTraffic##index##Percentage() const                                            \
    {                                                                                              \
        return GetTrafficPercentage(TOSTRING(index));                                              \
    }                                                                                              \
    inline void SetTraffic##index##Protocol(TransportLayerProtocol_t value)                        \
    {                                                                                              \
        return SetTrafficProtocol(TOSTRING(index), value);                                         \
    }                                                                                              \
    inline TransportLayerProtocol_t GetTraffic##index##Protocol() const                            \
    {                                                                                              \
        return GetTrafficProtocol(TOSTRING(index));                                                \
    }                                                                                              \
    inline void SetTraffic##index##Direction(TrafficDirection_t value)                             \
    {                                                                                              \
        return SetTrafficDirection(TOSTRING(index), value);                                        \
    }                                                                                              \
    inline TrafficDirection_t GetTraffic##index##Direction() const                                 \
    {                                                                                              \
        return GetTrafficDirection(TOSTRING(index));                                               \
    }                                                                                              \
    inline void SetTraffic##index##StartTime(Time value)                                           \
    {                                                                                              \
        return SetTrafficStartTime(TOSTRING(index), value);                                        \
    }                                                                                              \
    inline Time GetTraffic##index##StartTime() const                                               \
    {                                                                                              \
        return GetTrafficStartTime(TOSTRING(index));                                               \
    }                                                                                              \
    inline void SetTraffic##index##StopTime(Time value)                                            \
    {                                                                                              \
        return SetTrafficStopTime(TOSTRING(index), value);                                         \
    }                                                                                              \
    inline Time GetTraffic##index##StopTime() const                                                \
    {                                                                                              \
        return GetTrafficStopTime(TOSTRING(index));                                                \
    }                                                                                              \
    inline void SetTraffic##index##StartDelay(Time value)                                          \
    {                                                                                              \
        return SetTrafficStartDelay(TOSTRING(index), value);                                       \
    }                                                                                              \
    inline Time GetTraffic##index##StartDelay() const                                              \
    {                                                                                              \
        return GetTrafficStartDelay(TOSTRING(index));                                              \
    }
 
    TRAFFIC_MODEL_ATTRIBUTE_ACCESSOR_DEFINE(Cbr);
    TRAFFIC_MODEL_ATTRIBUTE_ACCESSOR_DEFINE(Http);
    TRAFFIC_MODEL_ATTRIBUTE_ACCESSOR_DEFINE(OnOff);
    TRAFFIC_MODEL_ATTRIBUTE_ACCESSOR_DEFINE(Nrtv);
};
 
} // namespace ns3
 
#endif /* TEST_SCRIPT_INPUT_HELPER_H */