satellite-beam-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
 * 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: Sami Rantanen <sami.rantanen@magister.fi>
 * Author: Mathias Ettinger <mettinger@viveris.toulouse.fr>
 */
 
#ifndef SATELLITE_BEAM_HELPER_H
#define SATELLITE_BEAM_HELPER_H
 
#include "satellite-gw-helper.h"
#include "satellite-orbiter-helper.h"
#include "satellite-ut-helper.h"
 
#include "ns3/ipv4-address-helper.h"
#include "ns3/node-container.h"
#include "ns3/satellite-antenna-gain-pattern-container.h"
#include "ns3/satellite-beam-channel-pair.h"
#include "ns3/satellite-bstp-controller.h"
#include "ns3/satellite-markov-container.h"
#include "ns3/satellite-mobility-observer.h"
#include "ns3/satellite-ncc.h"
#include "ns3/satellite-packet-trace.h"
#include "ns3/satellite-phy-rx-carrier-conf.h"
#include "ns3/satellite-superframe-sequence.h"
#include "ns3/satellite-typedefs.h"
 
#include <list>
#include <map>
#include <set>
#include <stdint.h>
#include <string>
#include <utility>
#include <vector>
 
namespace ns3
{
 
class PropagationDelayModel;

class SatBeamHelper : public Object
{
  public:
    typedef SatChannel::CarrierFreqConverter CarrierFreqConverter;

    typedef SatTypedefs::CarrierBandwidthConverter_t CarrierBandwidthConverter;
 
    typedef std::pair<uint32_t, uint32_t> FrequencyPair_t; // user = first, feeder = second
    typedef std::pair<uint32_t, uint32_t> GwLink_t; // first GW ID, second feeder link frequency id
 
    typedef std::set<Ptr<Node>>
        MulticastBeamInfoItem_t; // set container having receiving UT nodes in beam
    typedef std::map<uint32_t, std::set<Ptr<Node>>>
        MulticastBeamInfo_t; // key = beam ID, value = receiving UT nodes in beam

    static TypeId GetTypeId(void);

    SatBeamHelper();

    SatBeamHelper(std::vector<std::pair<uint32_t, uint32_t>> isls,
                  SatTypedefs::CarrierBandwidthConverter_t bandwidthConverterCb,
                  uint32_t fwdLinkCarrierCount,
                  uint32_t rtnLinkCarrierCount,
                  Ptr<SatSuperframeSeq> seq);

    virtual void NotifyConstructionCompleted() override;

    virtual ~SatBeamHelper()
    {
    }

    void Init();

    void SetAntennaGainPatterns(Ptr<SatAntennaGainPatternContainer> antennaPatterns);

    void SetDeviceAttribute(std::string name, const AttributeValue& value);

    void SetChannelAttribute(std::string name, const AttributeValue& value);

    void SetNccRoutingCallback(SatNcc::UpdateRoutingCallback cb);

    std::pair<Ptr<NetDevice>, NetDeviceContainer> Install(
        NodeContainer ut,
        Ptr<Node> gwNode,
        uint32_t gwId,
        uint32_t satId,
        uint32_t beamId,
        uint32_t rtnUlFreqId,
        uint32_t rtnFlFreqId,
        uint32_t fwdUlFreqId,
        uint32_t fwdFlFreqId,
        SatMac::RoutingUpdateCallback routingCallback);

    Ptr<NetDevice> InstallFeeder(Ptr<SatOrbiterNetDevice> orbiterNetDevice,
                                 Ptr<Node> gwNode,
                                 uint32_t gwId,
                                 uint32_t satId,
                                 uint32_t beamId,
                                 uint32_t feederSatId,
                                 uint32_t feederBeamId,
                                 SatChannelPair::ChannelPair_t feederLink,
                                 uint32_t rtnFlFreqId,
                                 uint32_t fwdFlFreqId,
                                 SatMac::RoutingUpdateCallback routingCallback);

    NetDeviceContainer InstallUser(Ptr<SatOrbiterNetDevice> orbiterNetDevice,
                                   NodeContainer ut,
                                   Ptr<NetDevice> gwNd,
                                   uint32_t satId,
                                   uint32_t beamId,
                                   SatChannelPair::ChannelPair_t userLink,
                                   uint32_t rtnUlFreqId,
                                   uint32_t fwdUlFreqId,
                                   SatMac::RoutingUpdateCallback routingCallback);

    void InstallIsls();

    void SetIslRoutes();

    uint32_t GetGwId(uint32_t satId, uint32_t beamId) const;

    NodeContainer GetUtNodes(uint32_t satId, uint32_t beamId) const;

    std::list<std::pair<uint32_t, uint32_t>> GetBeams() const;

    void EnableCreationTraces(Ptr<OutputStreamWrapper> stream, CallbackBase& cb);

    std::string GetBeamInfo() const;

    std::string GetUtInfo() const;

    Ptr<Node> GetGwNode(uint32_t gwId) const;

    Ptr<SatUtHelper> GetUtHelper() const;

    Ptr<SatGwHelper> GetGwHelper() const;

    Ptr<SatOrbiterHelper> GetOrbiterHelper() const;

    Ptr<SatNcc> GetNcc() const;

    uint32_t GetUtBeamId(Ptr<Node> utNode) const;

    NetDeviceContainer AddMulticastGroupRoutes(MulticastBeamInfo_t beamInfo,
                                               Ptr<Node> sourceUtNode,
                                               Ipv4Address sourceAddress,
                                               Ipv4Address groupAddress,
                                               bool routeToGwUsers,
                                               Ptr<NetDevice>& gwOutputDev);

    virtual void DoDispose();

    void EnablePacketTrace();
 
    Ptr<PropagationDelayModel> GetPropagationDelayModel(uint32_t satId,
                                                        uint32_t beamId,
                                                        SatEnums::ChannelType_t channelType);
 
    SatEnums::PropagationDelayModel_t GetPropagationDelayModelEnum();
 
  private:
    CarrierFreqConverter m_carrierFreqConverter;
    SatTypedefs::CarrierBandwidthConverter_t m_carrierBandwidthConverter;
 
    uint32_t m_rtnLinkCarrierCount;
    uint32_t m_fwdLinkCarrierCount;
 
    Ptr<SatSuperframeSeq> m_superframeSeq;
 
    ObjectFactory m_channelFactory;
    Ptr<SatOrbiterHelper> m_orbiterHelper;
    Ptr<SatGwHelper> m_gwHelper;
    Ptr<SatUtHelper> m_utHelper;
    Ptr<SatNcc> m_ncc;
 
    Ptr<SatAntennaGainPatternContainer> m_antennaGainPatterns;
 
    std::map<std::pair<uint32_t, uint32_t>, uint32_t>
        m_beam;                             // first pair sat ID / beam ID, second GW ID
    std::map<uint32_t, Ptr<Node>> m_gwNode; // first GW ID, second node pointer
    std::multimap<std::pair<uint32_t, uint32_t>, Ptr<Node>>
        m_utNode;                     // first pair sat ID / beam ID, second node pointer of the UT
    Ptr<SatChannelPair> m_ulChannels; // user link ID, channel pointers pair
    Ptr<SatChannelPair> m_flChannels; // feeder link ID, channel pointers pair
    std::map<std::pair<uint32_t, uint32_t>, FrequencyPair_t>
        m_beamFreqs; // first beam ID, channel frequency IDs pair

    TracedCallback<std::string> m_creationTrace;

    bool m_printDetailedInformationToCreationTraces;

    Time m_ctrlMsgStoreTimeFwdLink;

    Time m_ctrlMsgStoreTimeRtnLink;

    SatEnums::LinkResults_t m_rlLinkResultsType;

    SatEnums::FadingModel_t m_fadingModel;

    Ptr<SatMarkovConf> m_markovConf;

    SatEnums::PropagationDelayModel_t m_propagationDelayModel;

    Time m_constantPropagationDelay;

    SatEnums::RandomAccessModel_t m_randomAccessModel;

    SatPhyRxCarrierConf::InterferenceModel m_raInterferenceModel;

    SatPhyRxCarrierConf::InterferenceEliminationModel m_raInterferenceEliminationModel;

    SatPhyRxCarrierConf::RandomAccessCollisionModel m_raCollisionModel;

    double m_raConstantErrorRate;

    bool m_enableFwdLinkBeamHopping;

    Ptr<SatBstpController> m_bstpController;

    Ptr<SatPacketTrace> m_packetTrace;

    bool m_enableTracesOnReturnLink;

    std::string CreateBeamInfo() const;

    SatChannelPair::ChannelPair_t GetChannelPair(uint32_t satId,
                                                 uint32_t beamId,
                                                 uint32_t fwdFrequencyId,
                                                 uint32_t rtnFrequencyId,
                                                 bool isUserLink);

    bool StoreGwNode(uint32_t id, Ptr<Node> node);

    Ptr<SatBaseFading> InstallFadingContainer(Ptr<Node> node) const;

    void AddMulticastRouteToUt(Ptr<Node> utNode,
                               Ipv4Address sourceAddress,
                               Ipv4Address groupAddress,
                               bool routeToSatellite);

    SatEnums::DvbVersion_t m_dvbVersion;

    std::map<uint32_t, Ptr<NetDevice>> m_gwNdMap;

    std::vector<std::pair<uint32_t, uint32_t>> m_isls;
};
 
} // namespace ns3
 
#endif /* SATELLITE_BEAM_HELPER_H */