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.

	~EpcHelper () override
	Destructor.

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.

virtual void	AddEnb (Ptr< Node > enbNode, Ptr< NetDevice > lteEnbNetDevice, std::vector< uint16_t > cellIds)=0
	Add an eNB to the EPC.

virtual void	AddS1Interface (Ptr< Node > enb, Ipv4Address enbAddress, Ipv4Address sgwAddress, std::vector< uint16_t > cellIds)=0
	Add an S1 interface between an eNB and a SGW.

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.

virtual void	AddX2Interface (Ptr< Node > enbNode1, Ptr< Node > enbNode2)=0
	Add an X2 interface between two eNB.

virtual int64_t	AssignStreams (int64_t stream)=0
	Assign a fixed random variable stream number to the random variables used.

virtual Ipv4InterfaceContainer	AssignUeIpv4Address (NetDeviceContainer ueDevices)=0
	Assign IPv4 addresses to UE devices.

virtual Ipv6InterfaceContainer	AssignUeIpv6Address (NetDeviceContainer ueDevices)=0
	Assign IPv6 addresses to UE devices.

void	DoDispose () override
	Destructor implementation.

virtual Ptr< Node >	GetPgwNode () const =0
	Get the PGW node.

virtual Ptr< Node >	GetSgwNode () const =0
	Get the SGW node.

virtual Ipv4Address	GetUeDefaultGatewayAddress ()=0

virtual Ipv6Address	GetUeDefaultGatewayAddress6 ()=0

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

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

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.

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

Constructor & Destructor Documentation

◆ EpcHelper()

ns3::EpcHelper::EpcHelper ( )

Constructor.

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

References NS_LOG_FUNCTION.

◆ ~EpcHelper()

ns3::EpcHelper::~EpcHelper ( )

override

Destructor.

Definition at line 31 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

ueLteDevice	the Ipv4-enabled device of the UE, normally connected via the LTE radio interface
imsi	the unique identifier of the UE
tft	the Traffic Flow Template of the new bearer
bearer	struct 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,
		std::vector< uint16_t >	cellIds )

pure virtual

Add an eNB to the EPC.

Parameters

enbNode	the previously created eNB node which is to be added to the EPC
lteEnbNetDevice	the LteEnbNetDevice of the eNB node
cellIds	IDs of cells served by this eNB

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

◆ AddS1Interface()

virtual void ns3::EpcHelper::AddS1Interface	(	Ptr< Node >	enb,
		Ipv4Address	enbAddress,
		Ipv4Address	sgwAddress,
		std::vector< uint16_t >	cellIds )

pure virtual

Add an S1 interface between an eNB and a SGW.

Parameters

enb	eNB peer of the S1 interface
enbAddress	eNB IPv4 address of the S1 interface
sgwAddress	SGW IPv4 address of the S1 interface
cellIds	cellIds 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

ueLteDevice	the UE device to be attached
imsi	the 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

enbNode1	one eNB peer of the X2 interface
enbNode2	the other eNB peer of the X2 interface

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

◆ AssignStreams()

virtual int64_t ns3::EpcHelper::AssignStreams ( int64_t stream )

pure virtual

Assign a fixed random variable stream number to the random variables used.

Parameters

stream first stream index to use

Returns: the number of stream indices (possibly zero) that have been assigned

Implemented in ns3::NoBackhaulEpcHelper.

◆ AssignUeIpv4Address()

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

pure virtual

Assign IPv4 addresses to UE devices.

Parameters

ueDevices the 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

ueDevices the 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 ( )

overridevirtual

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, and ns3::PointToPointEpcHelper.

Definition at line 44 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 ( )

static

Register this type.

Returns: The object TypeId.

Definition at line 37 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:

src/lte/helper/epc-helper.h
src/lte/helper/epc-helper.cc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EpcHelper()

◆ ~EpcHelper()

Member Function Documentation

◆ ActivateEpsBearer()

◆ AddEnb()

◆ AddS1Interface()

◆ AddUe()

◆ AddX2Interface()

◆ AssignStreams()

◆ AssignUeIpv4Address()

◆ AssignUeIpv6Address()

◆ DoDispose()

◆ GetPgwNode()

◆ GetSgwNode()

◆ GetTypeId()

◆ GetUeDefaultGatewayAddress()

◆ GetUeDefaultGatewayAddress6()