A Discrete-Event Network Simulator
API
ns3::EpcHelper Class Referenceabstract

Base helper class to handle the creation of the EPC entities. More...

#include "epc-helper.h"

+ Inheritance diagram for ns3::EpcHelper:
+ Collaboration diagram for ns3::EpcHelper:

Public Member Functions

 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. 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...
 
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::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...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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

Base helper class to handle the creation of the EPC entities.


Introspection did not find any typical Config paths.

This class provides the API for the implementation of helpers that allow to create EPC entities and the nodes and interfaces that host and connect them.


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

Definition at line 49 of file epc-helper.h.

Constructor & Destructor Documentation

◆ EpcHelper()

ns3::EpcHelper::EpcHelper ( )

Constructor.

Definition at line 36 of file epc-helper.cc.

References NS_LOG_FUNCTION.

◆ ~EpcHelper()

ns3::EpcHelper::~EpcHelper ( )
virtual

Destructor.

Definition at line 41 of file epc-helper.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ActivateEpsBearer()

virtual uint8_t ns3::EpcHelper::ActivateEpsBearer ( Ptr< NetDevice ueLteDevice,
uint64_t  imsi,
Ptr< EpcTft tft,
EpsBearer  bearer 
)
pure virtual

Activate an EPS bearer, setting up the corresponding S1-U tunnel.

Parameters
ueLteDevicethe Ipv4-enabled device of the UE, normally connected via the LTE radio interface
imsithe unique identifier of the UE
tftthe Traffic Flow Template of the new bearer
bearerstruct describing the characteristics of the EPS bearer to be activated
Returns
bearer ID

Implemented in ns3::NoBackhaulEpcHelper.

◆ AddEnb()

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

Add an eNB to the EPC.

Parameters
enbNodethe previously created eNB node which is to be added to the EPC
lteEnbNetDevicethe LteEnbNetDevice of the eNB node
cellIdID of the eNB

Implemented in ns3::NoBackhaulEpcHelper, ns3::EmuEpcHelper, and ns3::PointToPointEpcHelper.

◆ AddS1Interface()

virtual void ns3::EpcHelper::AddS1Interface ( Ptr< Node enb,
Ipv4Address  enbAddress,
Ipv4Address  sgwAddress,
uint16_t  cellId = 0 
)
pure virtual

Add an S1 interface between an eNB and a SGW.

Parameters
enbeNB peer of the S1 interface
enbAddresseNB IPv4 address of the S1 interface
sgwAddressSGW IPv4 address of the S1 interface
cellIdcellId of the eNB

Implemented in ns3::NoBackhaulEpcHelper.

◆ AddUe()

virtual void ns3::EpcHelper::AddUe ( Ptr< NetDevice ueLteDevice,
uint64_t  imsi 
)
pure virtual

Notify the EPC of the existence of a new UE which might attach at a later time.

Parameters
ueLteDevicethe UE device to be attached
imsithe unique identifier of the UE

Implemented in ns3::NoBackhaulEpcHelper.

◆ AddX2Interface()

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

Add an X2 interface between two eNB.

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

Implemented in ns3::NoBackhaulEpcHelper, and ns3::EmuEpcHelper.

◆ AssignUeIpv4Address()

virtual Ipv4InterfaceContainer ns3::EpcHelper::AssignUeIpv4Address ( NetDeviceContainer  ueDevices)
pure virtual

Assign IPv4 addresses to UE devices.

Parameters
ueDevicesthe set of UE devices
Returns
the interface container,
See also
Ipv4AddressHelper::Assign() which has similar semantics

Implemented in ns3::NoBackhaulEpcHelper.

◆ AssignUeIpv6Address()

virtual Ipv6InterfaceContainer ns3::EpcHelper::AssignUeIpv6Address ( NetDeviceContainer  ueDevices)
pure virtual

Assign IPv6 addresses to UE devices.

Parameters
ueDevicesthe set of UE devices
Returns
the interface container,
See also
Ipv6AddressHelper::Assign() which has similar semantics

Implemented in ns3::NoBackhaulEpcHelper.

◆ DoDispose()

void ns3::EpcHelper::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::Object.

Reimplemented in ns3::NoBackhaulEpcHelper, ns3::EmuEpcHelper, and ns3::PointToPointEpcHelper.

Definition at line 57 of file epc-helper.cc.

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

+ Here is the call graph for this function:

◆ GetPgwNode()

virtual Ptr<Node> ns3::EpcHelper::GetPgwNode ( ) const
pure virtual

Get the PGW node.

Returns
a pointer to the PGW node The primary use intended for this method is to allow the user to configure the SGi interface of the PGW, i.e., to connect the PGW to the internet.

Implemented in ns3::NoBackhaulEpcHelper.

◆ GetSgwNode()

virtual Ptr<Node> ns3::EpcHelper::GetSgwNode ( ) const
pure virtual

Get the SGW node.

Returns
a pointer to the SGW

Implemented in ns3::NoBackhaulEpcHelper.

◆ GetTypeId()

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

Register this type.

Returns
The object TypeId.

Definition at line 47 of file epc-helper.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ GetUeDefaultGatewayAddress()

virtual Ipv4Address ns3::EpcHelper::GetUeDefaultGatewayAddress ( )
pure virtual
Returns
the IPv4 address of the Default Gateway to be used by UEs to reach the internet

Implemented in ns3::NoBackhaulEpcHelper.

◆ GetUeDefaultGatewayAddress6()

virtual Ipv6Address ns3::EpcHelper::GetUeDefaultGatewayAddress6 ( )
pure virtual
Returns
the IPv6 address of the Default Gateway to be used by UEs to reach the internet

Implemented in ns3::NoBackhaulEpcHelper.


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