satellite-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd
 *
 * 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: Sami Rantanen <sami.rantanen@magister.fi>
 */
#ifndef __SATELLITE_HELPER_H__
#define __SATELLITE_HELPER_H__
 
#include "satellite-beam-helper.h"
#include "satellite-beam-user-info.h"
#include "satellite-conf.h"
#include "satellite-group-helper.h"
#include "satellite-user-helper.h"
 
#include "ns3/csma-helper.h"
#include "ns3/ipv4-address-helper.h"
#include "ns3/node-container.h"
#include "ns3/object.h"
#include "ns3/output-stream-wrapper.h"
#include "ns3/satellite-antenna-gain-pattern-container.h"
#include "ns3/satellite-fading-input-trace-container.h"
#include "ns3/satellite-fading-output-trace-container.h"
#include "ns3/satellite-interference-input-trace-container.h"
#include "ns3/satellite-interference-output-trace-container.h"
#include "ns3/satellite-position-allocator.h"
#include "ns3/satellite-rx-power-input-trace-container.h"
#include "ns3/satellite-rx-power-output-trace-container.h"
#include "ns3/satellite-stats-helper-container.h"
#include "ns3/trace-helper.h"
 
#include <map>
#include <set>
#include <stdint.h>
#include <string>
#include <utility>
#include <vector>
 
namespace ns3
{
 
class SatGroupHelper;

class SatHelper : public Object
{
  public:
    typedef std::map<std::pair<uint32_t, uint32_t>, SatBeamUserInfo> BeamUserInfoMap_t;

    typedef enum
    {
        NONE,   
        SIMPLE, 
        LARGER, 
        FULL    
    } PreDefinedScenario_t;

    static TypeId GetTypeId(void);

    SatHelper();

    SatHelper(std::string scenarioPath);

    virtual void NotifyConstructionCompleted() override;

    virtual ~SatHelper()
    {
    }

    typedef Callback<uint32_t> GetNextUtUserCountCallback;

    void CreatePredefinedScenario(PreDefinedScenario_t scenario);

    void CreateUserDefinedScenario(BeamUserInfoMap_t& info);

    void CreateUserDefinedScenarioFromListPositions(uint32_t satId,
                                                    BeamUserInfoMap_t& info,
                                                    std::string inputFileUtListPositions,
                                                    bool checkBeam);

    void LoadConstellationScenario(BeamUserInfoMap_t& info,
                                   GetNextUtUserCountCallback getNextUtUserCountCallback);

    void SetGwAddressInUts();

    void SetBeamRoutingConstellations();

    Ipv4Address GetUserAddress(Ptr<Node> node);

    Ptr<SatBeamHelper> GetBeamHelper() const;

    Ptr<SatGroupHelper> GetGroupHelper() const;

    void SetGroupHelper(Ptr<SatGroupHelper> groupHelper);

    void SetAntennaGainPatterns(Ptr<SatAntennaGainPatternContainer> antennaGainPattern);

    Ptr<SatAntennaGainPatternContainer> GetAntennaGainPatterns();

    Ptr<SatUserHelper> GetUserHelper() const;

    uint32_t GetBeamCount() const;

    void SetCustomUtPositionAllocator(Ptr<SatListPositionAllocator> posAllocator);

    void SetUtPositionAllocatorForBeam(uint32_t beamId, Ptr<SatListPositionAllocator> posAllocator);

    void LoadMobileUTsFromFolder(const std::string& folderName, Ptr<RandomVariableStream> utUsers);

    Ptr<Node> LoadMobileUtFromFile(const std::string& filename);

    Ptr<Node> LoadMobileUtFromFile(uint32_t satId, const std::string& filename);

    void SetMulticastGroupRoutes(Ptr<Node> source,
                                 NodeContainer receivers,
                                 Ipv4Address sourceAddress,
                                 Ipv4Address groupAddress);

    void DoDispose();

    Ptr<SatSpotBeamPositionAllocator> GetBeamAllocator(uint32_t beamId);
 
    inline bool IsSatConstellationEnabled()
    {
        return m_satConstellationEnabled;
    }
 
  private:
    static const uint16_t MIN_ADDRESS_PREFIX_LENGTH = 1;
    static const uint16_t MAX_ADDRESS_PREFIX_LENGTH = 31;
 
    typedef SatBeamHelper::MulticastBeamInfoItem_t MulticastBeamInfoItem_t;
    typedef SatBeamHelper::MulticastBeamInfo_t MulticastBeamInfo_t;

    std::string m_scenarioPath;

    std::string m_rtnConfFileName;
    std::string m_fwdConfFileName;
    std::string m_gwPosFileName;
    std::string m_satPosFileName;
    std::string m_utPosFileName;
    std::string m_waveformConfDirectoryName;

    bool m_satConstellationEnabled;
 
    /*
     * The global standard used. Can be either DVB or Lora
     */
    SatEnums::Standard_t m_standard;

    Ptr<SatUserHelper> m_userHelper;

    Ptr<SatBeamHelper> m_beamHelper;

    Ptr<SatGroupHelper> m_groupHelper;

    Ptr<SatConf> m_satConf;

    TracedCallback<std::string> m_creationDetailsTrace;

 
    TracedCallback<std::string> m_creationSummaryTrace;

    Ptr<OutputStreamWrapper> m_creationTraceStream;

    Ptr<OutputStreamWrapper> m_utTraceStream;
 
    Ipv4Address
        m_beamNetworkAddress; 
    Ipv4Address
        m_gwNetworkAddress; 
    Ipv4Address m_utNetworkAddress; 
 
    Ipv4Mask m_beamNetworkMask; 
    Ipv4Mask m_gwNetworkMask;   
    Ipv4Mask m_utNetworkMask;   

    bool m_handoversEnabled;

    bool m_scenarioCreated;

    bool m_creationTraces;

    bool m_detailedCreationTraces;

    bool m_packetTraces;

    uint32_t m_utsInBeam;

    uint32_t m_gwUsers;

    uint32_t m_utUsers;

    BeamUserInfoMap_t m_beamUserInfos;

    std::string m_scenarioCreationFileName;

    std::string m_utCreationFileName;

    std::string m_wfConfigFileName;

    Ptr<SatAntennaGainPatternContainer> m_antennaGainPatterns;

    std::map<uint32_t, Ptr<SatListPositionAllocator>> m_utPositionsByBeam;

    Ptr<SatListPositionAllocator> m_utPositions;

    std::map<uint32_t, NodeContainer> m_mobileUtsByBeam;

    std::multimap<uint32_t, uint32_t> m_mobileUtsUsersByBeam;

    std::map<uint32_t, uint32_t> m_gwSats;

    std::map<Ptr<NetDevice>, NetDeviceContainer> m_utsDistribution;

    void EnableCreationTraces();

    void EnableDetailedCreationTraces();

    void EnablePacketTrace();

    void LoadConstellationTopology(std::vector<std::string>& tles,
                                   std::vector<std::pair<uint32_t, uint32_t>>& isls);

    static void CreationDetailsSink(Ptr<OutputStreamWrapper> stream,
                                    std::string context,
                                    std::string info);
    void CreationSummarySink(std::string title);
    void CreateSimpleScenario();
    void CreateLargerScenario();
    void CreateFullScenario();

    void DoCreateScenario(BeamUserInfoMap_t& info, uint32_t gwUsers);

    std::string CreateCreationSummary(std::string title);

    void SetGwMobility(NodeContainer gwNodes);

    void SetSatMobility(Ptr<Node> node);

    void SetSatMobility(Ptr<Node> node, std::string tle);

    void SetUtMobility(NodeContainer uts, uint32_t satId, uint32_t beamId);

    void SetUtMobilityFromPosition(
        NodeContainer uts,
        uint32_t satId,
        uint32_t beamId,
        std::vector<std::pair<GeoCoordinate, uint32_t>> positionsAndGroupId);

    void InstallMobilityObserver(uint32_t satId, NodeContainer nodes) const;

    Ptr<NetDevice> FindMatchingDevice(Ptr<NetDevice> devA, Ptr<Node> nodeB);


    bool FindMatchingDevices(Ptr<Node> nodeA,
                             Ptr<Node> nodeB,
                             std::pair<Ptr<NetDevice>, Ptr<NetDevice>>& matchingDevices);

    void SetMulticastRouteToSourceNetwork(Ptr<Node> source, Ptr<Node> destination);

    bool ConstructMulticastInfo(Ptr<Node> sourceUtNode,
                                NodeContainer receivers,
                                MulticastBeamInfo_t& beamInfo,
                                Ptr<NetDevice>& routerUserOutputDev);

    void SetNetworkAddresses(BeamUserInfoMap_t& info, uint32_t gwUsers) const;

    void CheckNetwork(std::string networkName,
                      const Ipv4Address& firstNetwork,
                      const Ipv4Mask& mask,
                      const std::set<uint32_t>& networkAddresses,
                      uint32_t networkCount,
                      uint32_t hostCount) const;

    void ReadStandard(std::string pathName);
};
 
} // namespace ns3
 
#endif /* __SATELLITE_HELPER_H__ */