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 "satellite-cno-helper.h"
#include "satellite-group-helper.h"
#include "satellite-helper.h"
#include "satellite-traffic-helper.h"
 
#include "ns3/command-line.h"
#include "ns3/random-variable-stream.h"
#include "ns3/satellite-enums.h"
#include "ns3/satellite-stats-helper-container.h"
 
#include <map>
#include <set>
#include <stdint.h>
#include <string>
 
namespace ns3
{

class SimulationHelper : public Object
{
  public:
    SimulationHelper();

    SimulationHelper(std::string simulationName);

    virtual ~SimulationHelper();

    void DoDispose(void);

    static TypeId GetTypeId(void);

    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();

    void LoadScenario(std::string name);

    void ParseScenarioFolder();

    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 != nullptr,
                      "CreateSatScenario not called before calling GetSatelliteHelper");
        return m_satHelper;
    }

    Ptr<SatStatsHelperContainer> GetStatisticsContainer();

    Ptr<SatTrafficHelper> GetTrafficHelper();

    Ptr<SatGroupHelper> GetGroupHelper();

    Ptr<SatCnoHelper> GetCnoHelper();
 
    typedef enum
    {
        CR_NOT_CONFIGURED,
        CR_PERIODIC_CONTROL,
        CR_SLOTTED_ALOHA,
        CR_CRDSA_LOOSE_RC_0,
    } CrTxConf_t;
 
    void SetCrTxConf(CrTxConf_t crTxConf);
 
  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 != nullptr, "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_scenarioPath;
    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;
    std::string m_inputFileUtListPositions;
    bool m_inputFileUtPositionsCheckBeams;
 
    bool m_progressLoggingEnabled;
    Time m_progressUpdateInterval;
    EventId m_progressReportEvent;
};
 
class SimulationHelperConf : public Object
{
  public:
    SimulationHelperConf();

    virtual ~SimulationHelperConf();

    static TypeId GetTypeId(void);
 
    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::string m_mobileUtsFolder;
};
 
} // namespace ns3
 
#endif /* TEST_SCRIPT_INPUT_HELPER_H */