A Discrete-Event Network Simulator
API
ns3::EmuEpcHelper Class Reference

Create an EPC network using EmuFdNetDevice. More...

#include "emu-epc-helper.h"

+ Inheritance diagram for ns3::EmuEpcHelper:
+ Collaboration diagram for ns3::EmuEpcHelper:

Public Member Functions

 EmuEpcHelper ()
 Constructor. More...
 
virtual ~EmuEpcHelper ()
 Destructor. More...
 
virtual void AddEnb (Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, uint16_t cellId)
 Add an eNB to the EPC. More...
 
virtual void AddX2Interface (Ptr< Node > enbNode1, Ptr< Node > enbNode2)
 Add an X2 interface between two eNB. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
TypeId GetInstanceTypeId () const
 Get the most derived TypeId for this Object. More...
 
- Public Member Functions inherited from ns3::NoBackhaulEpcHelper
 NoBackhaulEpcHelper ()
 Constructor. More...
 
virtual ~NoBackhaulEpcHelper ()
 Destructor. More...
 
virtual uint8_t ActivateEpsBearer (Ptr< NetDevice > ueLteDevice, uint64_t imsi, Ptr< EpcTft > tft, EpsBearer bearer)
 Activate an EPS bearer, setting up the corresponding S1-U tunnel. More...
 
virtual void AddEnb (Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, uint16_t cellId)
 Add an eNB to the EPC. More...
 
virtual void AddS1Interface (Ptr< Node > enb, Ipv4Address enbAddress, Ipv4Address sgwAddress, uint16_t cellId=0)
 Add an S1 interface between an eNB and a SGW. More...
 
virtual void AddUe (Ptr< NetDevice > ueLteDevice, uint64_t imsi)
 Notify the EPC of the existence of a new UE which might attach at a later time. More...
 
virtual void AddX2Interface (Ptr< Node > enbNode1, Ptr< Node > enbNode2)
 Add an X2 interface between two eNB. More...
 
virtual Ipv4InterfaceContainer AssignUeIpv4Address (NetDeviceContainer ueDevices)
 Assign IPv4 addresses to UE devices. More...
 
virtual Ipv6InterfaceContainer AssignUeIpv6Address (NetDeviceContainer ueDevices)
 Assign IPv6 addresses to UE devices. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
TypeId GetInstanceTypeId () const
 Get the most derived TypeId for this Object. More...
 
virtual Ptr< NodeGetPgwNode () const
 Get the PGW node. More...
 
virtual Ptr< NodeGetSgwNode () const
 Get the SGW node. More...
 
virtual Ipv4Address GetUeDefaultGatewayAddress ()
 
virtual Ipv6Address GetUeDefaultGatewayAddress6 ()
 
- Public Member Functions inherited from ns3::EpcHelper
 EpcHelper ()
 Constructor. More...
 
virtual ~EpcHelper ()
 Destructor. More...
 
virtual uint8_t ActivateEpsBearer (Ptr< NetDevice > ueLteDevice, uint64_t imsi, Ptr< EpcTft > tft, EpsBearer bearer)=0
 Activate an EPS bearer, setting up the corresponding S1-U tunnel. More...
 
virtual void AddEnb (Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, uint16_t cellId)=0
 Add an eNB to the EPC. More...
 
virtual void AddS1Interface (Ptr< Node > enb, Ipv4Address enbAddress, Ipv4Address sgwAddress, uint16_t cellId=0)=0
 Add an S1 interface between an eNB and a SGW. More...
 
virtual void AddUe (Ptr< NetDevice > ueLteDevice, uint64_t imsi)=0
 Notify the EPC of the existence of a new UE which might attach at a later time. More...
 
virtual void AddX2Interface (Ptr< Node > enbNode1, Ptr< Node > enbNode2)=0
 Add an X2 interface between two eNB. More...
 
virtual Ipv4InterfaceContainer AssignUeIpv4Address (NetDeviceContainer ueDevices)=0
 Assign IPv4 addresses to UE devices. More...
 
virtual Ipv6InterfaceContainer AssignUeIpv6Address (NetDeviceContainer ueDevices)=0
 Assign IPv6 addresses to UE devices. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
virtual Ptr< NodeGetPgwNode () const =0
 Get the PGW node. More...
 
virtual Ptr< NodeGetSgwNode () const =0
 Get the SGW node. More...
 
virtual Ipv4Address GetUeDefaultGatewayAddress ()=0
 
virtual Ipv6Address GetUeDefaultGatewayAddress6 ()=0
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::NoBackhaulEpcHelper
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::EpcHelper
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

std::string m_enbDeviceName
 The name of the device used for the S1-U interface of the eNB. More...
 
std::string m_enbMacAddressBase
 First 5 bytes of the Enb MAC address base. More...
 
Ipv4AddressHelper m_epcIpv4AddressHelper
 helper to assign addresses to S1-U NetDevices More...
 
std::string m_sgwDeviceName
 The name of the device used for the S1-U interface of the SGW. More...
 
Ipv4InterfaceContainer m_sgwIpIfaces
 Container for Ipv4Interfaces of the SGW. More...
 
std::string m_sgwMacAddress
 MAC address used for the SGW. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::NoBackhaulEpcHelper
virtual void DoActivateEpsBearerForUe (const Ptr< NetDevice > &ueDevice, const Ptr< EpcTft > &tft, const EpsBearer &bearer) const
 DoActivateEpsBearerForUe: Schedule ActivateEpsBearer on the UE. More...
 
virtual void DoAddX2Interface (const Ptr< EpcX2 > &enb1X2, const Ptr< NetDevice > &enb1LteDev, const Ipv4Address &enb1X2Address, const Ptr< EpcX2 > &enb2X2, const Ptr< NetDevice > &enb2LteDev, const Ipv4Address &enb2X2Address) const
 DoAddX2Interface: Call AddX2Interface on top of the Enb device pointers. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Create an EPC network using EmuFdNetDevice.

Introspection did not find any typical Config paths.

This Helper will create an EPC network topology comprising of a single node that implements both the SGW and PGW functionality, and an MME node. The S1-U, X2-U and X2-C interfaces are realized using EmuFdNetDevice; in particular, one device is used to send all the traffic related to these interfaces.


Attributes

  • SgwDeviceName: The name of the device used for the S1-U interface of the SGW
    • Set with class: StringValue
    • Underlying type:
    • Initial value: veth0
    • Flags: construct write read
  • EnbDeviceName: The name of the device used for the S1-U interface of the eNB
    • Set with class: StringValue
    • Underlying type:
    • Initial value: veth1
    • Flags: construct write read
  • SgwMacAddress: MAC address used for the SGW
    • Set with class: StringValue
    • Underlying type:
    • Initial value: 00:00:00:59:00:aa
    • Flags: construct write read
  • EnbMacAddressBase: First 5 bytes of the eNB MAC address base
    • Set with class: StringValue
    • Underlying type:
    • Initial value: 00:00:00:eb:00
    • Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 464 bytes (on a 64-bit architecture).

Definition at line 41 of file emu-epc-helper.h.

Constructor & Destructor Documentation

◆ EmuEpcHelper()

◆ ~EmuEpcHelper()

ns3::EmuEpcHelper::~EmuEpcHelper ( )
virtual

Destructor.

Definition at line 66 of file emu-epc-helper.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddEnb()

void ns3::EmuEpcHelper::AddEnb ( Ptr< Node enbNode,
Ptr< NetDevice lteEnbNetDevice,
uint16_t  cellId 
)
virtual

◆ AddX2Interface()

void ns3::EmuEpcHelper::AddX2Interface ( Ptr< Node enbNode1,
Ptr< Node enbNode2 
)
virtual

Add an X2 interface between two eNB.

Parameters
enbNode1one eNB peer of the X2 interface
enbNode2the other eNB peer of the X2 interface

Reimplemented from ns3::NoBackhaulEpcHelper.

Definition at line 151 of file emu-epc-helper.cc.

References ns3::LteEnbNetDevice::GetCellId(), ns3::Node::GetDevice(), ns3::Node::GetNDevices(), ns3::Object::GetObject(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and NS_LOG_WARN.

+ Here is the call graph for this function:

◆ DoDispose()

void ns3::EmuEpcHelper::DoDispose ( void  )
virtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::NoBackhaulEpcHelper.

Definition at line 109 of file emu-epc-helper.cc.

References ns3::NoBackhaulEpcHelper::DoDispose(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::EmuEpcHelper::GetInstanceTypeId ( ) const
virtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns
The TypeId associated to the most-derived type of this instance.

Reimplemented from ns3::Object.

Definition at line 103 of file emu-epc-helper.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::EmuEpcHelper::GetTypeId ( void  )
static

Register this type.

Returns
The object TypeId.

Definition at line 72 of file emu-epc-helper.cc.

References m_enbDeviceName, m_enbMacAddressBase, m_sgwDeviceName, m_sgwMacAddress, ns3::MakeStringAccessor(), ns3::MakeStringChecker(), and ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_enbDeviceName

std::string ns3::EmuEpcHelper::m_enbDeviceName
private

The name of the device used for the S1-U interface of the eNB.

Definition at line 87 of file emu-epc-helper.h.

Referenced by AddEnb(), and GetTypeId().

◆ m_enbMacAddressBase

std::string ns3::EmuEpcHelper::m_enbMacAddressBase
private

First 5 bytes of the Enb MAC address base.

Definition at line 97 of file emu-epc-helper.h.

Referenced by AddEnb(), and GetTypeId().

◆ m_epcIpv4AddressHelper

Ipv4AddressHelper ns3::EmuEpcHelper::m_epcIpv4AddressHelper
private

helper to assign addresses to S1-U NetDevices

Definition at line 72 of file emu-epc-helper.h.

Referenced by EmuEpcHelper(), and AddEnb().

◆ m_sgwDeviceName

std::string ns3::EmuEpcHelper::m_sgwDeviceName
private

The name of the device used for the S1-U interface of the SGW.

Definition at line 82 of file emu-epc-helper.h.

Referenced by EmuEpcHelper(), and GetTypeId().

◆ m_sgwIpIfaces

Ipv4InterfaceContainer ns3::EmuEpcHelper::m_sgwIpIfaces
private

Container for Ipv4Interfaces of the SGW.

Definition at line 77 of file emu-epc-helper.h.

Referenced by EmuEpcHelper(), and AddEnb().

◆ m_sgwMacAddress

std::string ns3::EmuEpcHelper::m_sgwMacAddress
private

MAC address used for the SGW.

Definition at line 92 of file emu-epc-helper.h.

Referenced by EmuEpcHelper(), and GetTypeId().


The documentation for this class was generated from the following files: