nr-epc-helper.h

// Copyright (c) 2011-2013 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
//
// Authors:
//   Jaume Nin <jnin@cttc.es>
//   Nicola Baldo <nbaldo@cttc.es>
//   Manuel Requena <manuel.requena@cttc.es>
 
#ifndef NR_EPC_HELPER_H
#define NR_EPC_HELPER_H
 
#include "ns3/data-rate.h"
#include "ns3/ipv4-address-helper.h"
#include "ns3/ipv6-address-helper.h"
#include "ns3/node-container.h"
#include "ns3/nr-epc-tft.h"
#include "ns3/nr-eps-bearer.h"
#include "ns3/object.h"
 
#include <optional>
 
namespace ns3
{
 
class Node;
class NetDevice;
class VirtualNetDevice;
class NrEpcX2;
 
class NrEpcHelper : public Object
{
  public:
    NrEpcHelper();
 
    ~NrEpcHelper() override;
 
    // inherited from Object
    static TypeId GetTypeId();
    void DoDispose() override;
 
    virtual void AddGnb(Ptr<Node> gnbNode,
                        Ptr<NetDevice> nrGnbNetDevice,
                        std::vector<uint16_t> cellIds) = 0;
 
    virtual void AddUe(Ptr<NetDevice> ueNrDevice, uint64_t imsi) = 0;
 
    virtual void AddX2Interface(Ptr<Node> gnbNode1, Ptr<Node> gnbNode2) = 0;
 
    virtual void AddS1Interface(Ptr<Node> gnb,
                                Ipv4Address gnbAddress,
                                Ipv4Address sgwAddress,
                                std::vector<uint16_t> cellIds) = 0;
 
    virtual uint8_t ActivateEpsBearer(Ptr<NetDevice> ueNrDevice,
                                      uint64_t imsi,
                                      Ptr<NrEpcTft> tft,
                                      NrEpsBearer bearer) = 0;
 
    virtual Ptr<Node> GetSgwNode() const = 0;
 
    virtual Ptr<Node> GetPgwNode() const = 0;
 
    virtual Ipv4InterfaceContainer AssignUeIpv4Address(NetDeviceContainer ueDevices) = 0;
 
    virtual Ipv6InterfaceContainer AssignUeIpv6Address(NetDeviceContainer ueDevices) = 0;
 
    virtual Ipv4Address GetUeDefaultGatewayAddress() = 0;
 
    virtual Ipv6Address GetUeDefaultGatewayAddress6() = 0;
 
    virtual int64_t AssignStreams(int64_t stream) = 0;
 
    virtual std::pair<Ptr<Node>, Ipv4Address> SetupRemoteHost(std::optional<std::string> dataRate,
                                                              std::optional<uint16_t> mtu,
                                                              std::optional<Time> delay) = 0;
 
    virtual std::pair<Ptr<Node>, Ipv6Address> SetupRemoteHost6(std::optional<std::string> dataRate,
                                                               std::optional<uint16_t> mtu,
                                                               std::optional<Time> delay) = 0;
};
 
} // namespace ns3
 
#endif // NR_EPC_HELPER_H