satellite-user-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@toulouse.viveris.com>
 */
 
#ifndef SAT_USER_HELPER_H
#define SAT_USER_HELPER_H
 
#include "ns3/csma-helper.h"
#include "ns3/ipv4-address-helper.h"
#include "ns3/node-container.h"
#include "ns3/satellite-enums.h"
#include "ns3/traced-callback.h"
 
#include <map>
#include <set>
#include <stdint.h>
#include <string>
 
namespace ns3
{
 
class PropagationDelayModel;
class SatArpCache;
class NetDevice;
class Node;
 
class SatUserHelper : public Object
{
  public:
    enum NetworkType
    {
        NETWORK_TYPE_SAT_SIMPLE,
        NETWORK_TYPE_CSMA
    };
 
    typedef std::map<Ptr<Node>, NodeContainer> UtUsersContainer_t;
 
    static TypeId GetTypeId(void);
 
    TypeId GetInstanceTypeId(void) const;
    SatUserHelper();
    virtual ~SatUserHelper();
 
    void SetCsmaQueue(std::string type,
                      std::string name1 = "",
                      const AttributeValue& value1 = EmptyAttributeValue(),
                      std::string name2 = "",
                      const AttributeValue& value2 = EmptyAttributeValue(),
                      std::string name3 = "",
                      const AttributeValue& value3 = EmptyAttributeValue(),
                      std::string name4 = "",
                      const AttributeValue& value4 = EmptyAttributeValue());
 
    void SetCsmaDeviceAttribute(std::string name, const AttributeValue& value);
 
    void SetCsmaChannelAttribute(std::string name, const AttributeValue& value);
 
    void SetUtBaseAddress(const Ipv4Address& network,
                          const Ipv4Mask& mask,
                          Ipv4Address base = "0.0.0.1");
 
    void SetGwBaseAddress(const Ipv4Address& network,
                          const Ipv4Mask& mask,
                          Ipv4Address base = "0.0.0.1");
 
    void SetBeamBaseAddress(const Ipv4Address& network,
                            const Ipv4Mask& mask,
                            Ipv4Address base = "0.0.0.1");
 
    NodeContainer InstallUt(NodeContainer ut, uint32_t users);
 
    NodeContainer InstallUt(Ptr<Node> ut, uint32_t users);
 
    NodeContainer InstallGw(NodeContainer gw, uint32_t users);
 
    NodeContainer GetGwUsers() const;
 
    bool IsGwUser(Ptr<Node> node) const;
 
    NodeContainer GetUtUsers() const;
 
    NodeContainer GetUtUsers(Ptr<Node> ut) const;
 
    uint32_t GetGwUserCount() const;
 
    uint32_t GetUtUserCount() const;
 
    uint32_t GetUtUserCount(Ptr<Node> ut) const;
 
    Ptr<Node> GetUtNode(Ptr<Node> utUserNode) const;
 
    NodeContainer GetUtNodes() const;
 
    void EnableCreationTraces(Ptr<OutputStreamWrapper> stream, CallbackBase& cb);
 
    std::string GetRouterInfo() const;
 
    Ptr<Node> GetRouter() const;
 
    void PopulateBeamRoutings(NodeContainer ut,
                              NetDeviceContainer utNd,
                              Ptr<Node> gw,
                              Ptr<NetDevice> gwNd);
 
    void UpdateUtRoutes(Address ut, Address newGateway);
 
    void UpdateGwRoutes(Address ut, Address oldGateway, Address newGateway);
 
    typedef Callback<Ptr<PropagationDelayModel>, uint32_t, uint32_t, SatEnums::ChannelType_t>
        PropagationDelayCallback;
 
  private:
    NetDeviceContainer InstallSubscriberNetwork(const NodeContainer& c) const;
 
    NetDeviceContainer InstallBackboneNetwork(const NodeContainer& c) const;
 
    NetDeviceContainer InstallSatSimpleNetwork(const NodeContainer& c) const;
 
    void InstallRouter(NodeContainer gw, Ptr<Node> router);
 
    CsmaHelper m_csma;
    Ipv4AddressHelper m_ipv4Ut;
    Ipv4AddressHelper m_ipv4Gw;
    Ipv4AddressHelper m_ipv4Beam;
 
    NodeContainer m_gwUsers;
    UtUsersContainer_t m_utUsers;
    NodeContainer m_allUtUsers;
 
    NetworkType m_backboneNetworkType;
    NetworkType m_subscriberNetworkType;
 
    Ptr<Node> m_router;
 
    std::map<Ptr<Node>, Ptr<Node>> m_utMap;
 
    TracedCallback<std::string> m_creationTrace;
 
    std::map<Address, Ptr<NetDevice>> m_utDevices;
 
    std::map<Address, Ptr<NetDevice>> m_gwDevices;
 
    std::map<Address, Ptr<SatArpCache>> m_arpCachesToGateway;
 
    SatUserHelper::PropagationDelayCallback m_propagationDelayCallback;
};
 
} // namespace ns3
 
#endif /* SAT_USER_HELPER_H */