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

The abstract base class of a handover algorithm that operates using the Handover Management SAP interface. More...

#include "lte-handover-algorithm.h"

+ Inheritance diagram for ns3::LteHandoverAlgorithm:
+ Collaboration diagram for ns3::LteHandoverAlgorithm:

Public Member Functions

 LteHandoverAlgorithm ()
 
virtual ~LteHandoverAlgorithm ()
 
virtual LteHandoverManagementSapProviderGetLteHandoverManagementSapProvider ()=0
 Export the "provider" part of the Handover Management SAP interface. More...
 
virtual void SetLteHandoverManagementSapUser (LteHandoverManagementSapUser *s)=0
 Set the "user" part of the Handover Management SAP interface that this handover algorithm instance will interact with. More...
 
- 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...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
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 ()
 Get the type ID. 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...
 

Protected Member Functions

virtual void DoDispose ()
 Destructor implementation. More...
 
virtual void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults)=0
 Implementation of LteHandoverManagementSapProvider::ReportUeMeas. More...
 
- 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...
 

Additional Inherited Members

Detailed Description

The abstract base class of a handover algorithm that operates using the Handover Management SAP interface.


Handover algorithm receives measurement reports from an eNodeB RRC instance and tells the eNodeB RRC instance when to do a handover.

This class is an abstract class intended to be inherited by subclasses that implement its virtual methods. By inheriting from this abstract class, the subclasses gain the benefits of being compatible with the LteEnbNetDevice class, being accessible using namespace-based access through ns-3 Config subsystem, and being installed and configured by LteHelper class (see LteHelper::SetHandoverAlgorithmType and LteHelper::SetHandoverAlgorithmAttribute methods).

The communication with the eNodeB RRC instance is done through the Handover Management SAP interface. The handover algorithm instance corresponds to the "provider" part of this interface, while the eNodeB RRC instance takes the role of the "user" part. The following code skeleton establishes the connection between both instances:

Ptr<LteEnbRrc> u = ...;
Ptr<LteHandoverAlgorithm> p = ...;
u->SetLteHandoverManagementSapProvider (p->GetLteHandoverManagementSapProvider ());
p->SetLteHandoverManagementSapUser (u->GetLteHandoverManagementSapUser ());

However, user rarely needs to use the above code, since it has already been taken care by LteHelper::InstallEnbDevice.

See also
LteHandoverManagementSapProvider, LteHandoverManagementSapUser

Config Paths

ns3::LteHandoverAlgorithm is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteHandoverAlgorithm"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LteEnbNetDevice/LteHandoverAlgorithm"

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 66 of file lte-handover-algorithm.h.

Constructor & Destructor Documentation

◆ LteHandoverAlgorithm()

ns3::LteHandoverAlgorithm::LteHandoverAlgorithm ( )

Definition at line 32 of file lte-handover-algorithm.cc.

◆ ~LteHandoverAlgorithm()

ns3::LteHandoverAlgorithm::~LteHandoverAlgorithm ( )
virtual

Definition at line 37 of file lte-handover-algorithm.cc.

Member Function Documentation

◆ DoDispose()

void ns3::LteHandoverAlgorithm::DoDispose ( void  )
protectedvirtual

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::A2A4RsrqHandoverAlgorithm, ns3::A3RsrpHandoverAlgorithm, and ns3::NoOpHandoverAlgorithm.

Definition at line 54 of file lte-handover-algorithm.cc.

◆ DoReportUeMeas()

virtual void ns3::LteHandoverAlgorithm::DoReportUeMeas ( uint16_t  rnti,
LteRrcSap::MeasResults  measResults 
)
protectedpure virtual

Implementation of LteHandoverManagementSapProvider::ReportUeMeas.

Parameters
rntiRadio Network Temporary Identity, an integer identifying the UE where the report originates from
measResultsa single report of one measurement identity

Implemented in ns3::A2A4RsrqHandoverAlgorithm, ns3::A3RsrpHandoverAlgorithm, and ns3::NoOpHandoverAlgorithm.

◆ GetLteHandoverManagementSapProvider()

virtual LteHandoverManagementSapProvider* ns3::LteHandoverAlgorithm::GetLteHandoverManagementSapProvider ( )
pure virtual

Export the "provider" part of the Handover Management SAP interface.

Returns
the reference to the "provider" part of the interface, typically to be kept by an LteEnbRrc instance

Implemented in ns3::A2A4RsrqHandoverAlgorithm, ns3::A3RsrpHandoverAlgorithm, and ns3::NoOpHandoverAlgorithm.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 43 of file lte-handover-algorithm.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetLteHandoverManagementSapUser()

virtual void ns3::LteHandoverAlgorithm::SetLteHandoverManagementSapUser ( LteHandoverManagementSapUser s)
pure virtual

Set the "user" part of the Handover Management SAP interface that this handover algorithm instance will interact with.

Parameters
sa reference to the "user" part of the interface, typically a member of an LteEnbRrc instance

Implemented in ns3::A2A4RsrqHandoverAlgorithm, ns3::A3RsrpHandoverAlgorithm, and ns3::NoOpHandoverAlgorithm.


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