Base helper class to handle the creation of the EPC entities. More...
#include "epc-helper.h"
Public Member Functions | |
EpcHelper () | |
Constructor. More... | |
~EpcHelper () override | |
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, std::vector< uint16_t > cellIds)=0 |
Add an eNB to the EPC. More... | |
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. 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 int64_t | AssignStreams (int64_t stream)=0 |
Assign a fixed random variable stream number to the random variables used. 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... | |
void | DoDispose () override |
Destructor implementation. More... | |
virtual Ptr< Node > | GetPgwNode () const =0 |
Get the PGW node. More... | |
virtual Ptr< Node > | GetSgwNode () 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... | |
~Object () override | |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose () |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. More... | |
template<> | |
Ptr< Object > | GetObject () 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< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized () 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[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () 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 errors. 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 () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
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 () |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate () |
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 () |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
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 50 of file epc-helper.h.
ns3::EpcHelper::EpcHelper | ( | ) |
|
override |
|
pure virtual |
Activate an EPS bearer, setting up the corresponding S1-U tunnel.
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 |
Implemented in ns3::NoBackhaulEpcHelper.
|
pure virtual |
Add an eNB to the EPC.
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::PointToPointEpcHelper, ns3::NoBackhaulEpcHelper, and ns3::EmuEpcHelper.
|
pure virtual |
Add an S1 interface between an eNB and a SGW.
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.
Notify the EPC of the existence of a new UE which might attach at a later time.
ueLteDevice | the UE device to be attached |
imsi | the unique identifier of the UE |
Implemented in ns3::NoBackhaulEpcHelper.
|
pure virtual |
Add an X2 interface between two eNB.
enbNode1 | one eNB peer of the X2 interface |
enbNode2 | the other eNB peer of the X2 interface |
Implemented in ns3::NoBackhaulEpcHelper, and ns3::EmuEpcHelper.
|
pure virtual |
Assign a fixed random variable stream number to the random variables used.
stream | first stream index to use |
Implemented in ns3::NoBackhaulEpcHelper.
|
pure virtual |
Assign IPv4 addresses to UE devices.
ueDevices | the set of UE devices |
Implemented in ns3::NoBackhaulEpcHelper.
|
pure virtual |
Assign IPv6 addresses to UE devices.
ueDevices | the set of UE devices |
Implemented in ns3::NoBackhaulEpcHelper.
|
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::PointToPointEpcHelper, and ns3::NoBackhaulEpcHelper.
Definition at line 55 of file epc-helper.cc.
References ns3::Object::DoDispose(), and NS_LOG_FUNCTION.
Get the PGW node.
Implemented in ns3::NoBackhaulEpcHelper.
|
static |
Register this type.
Definition at line 48 of file epc-helper.cc.
References ns3::TypeId::SetParent().
|
pure virtual |
Implemented in ns3::NoBackhaulEpcHelper.
|
pure virtual |
Implemented in ns3::NoBackhaulEpcHelper.