The abstract base class of a handover algorithm that operates using the Handover Management SAP interface. More...
#include "lte-handover-algorithm.h"
Public Member Functions | |
LteHandoverAlgorithm () | |
~LteHandoverAlgorithm () override | |
virtual LteHandoverManagementSapProvider * | GetLteHandoverManagementSapProvider ()=0 |
Export the "provider" part of the Handover Management SAP interface. | |
virtual void | SetLteHandoverManagementSapUser (LteHandoverManagementSapUser *s)=0 |
Set the "user" part of the Handover Management SAP interface that this handover algorithm instance will interact with. | |
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 () |
Get the type ID. | |
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. | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
virtual void | DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults)=0 |
Implementation of LteHandoverManagementSapProvider::ReportUeMeas. | |
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. | |
Additional Inherited Members | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
ns3::LteHandoverAlgorithm is accessible through the following paths with Config::Set and Config::Connect:
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Lte
Size of this type is 56 bytes (on a 64-bit architecture).
Definition at line 54 of file lte-handover-algorithm.h.
ns3::LteHandoverAlgorithm::LteHandoverAlgorithm | ( | ) |
Definition at line 21 of file lte-handover-algorithm.cc.
|
override |
Definition at line 25 of file lte-handover-algorithm.cc.
|
overrideprotectedvirtual |
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::NoOpHandoverAlgorithm.
Definition at line 37 of file lte-handover-algorithm.cc.
|
protectedpure virtual |
Implementation of LteHandoverManagementSapProvider::ReportUeMeas.
rnti | Radio Network Temporary Identity, an integer identifying the UE where the report originates from |
measResults | a single report of one measurement identity |
Implemented in ns3::A2A4RsrqHandoverAlgorithm, ns3::A3RsrpHandoverAlgorithm, and ns3::NoOpHandoverAlgorithm.
|
pure virtual |
Export the "provider" part of the Handover Management SAP interface.
Implemented in ns3::A2A4RsrqHandoverAlgorithm, ns3::A3RsrpHandoverAlgorithm, and ns3::NoOpHandoverAlgorithm.
|
static |
Get the type ID.
Definition at line 30 of file lte-handover-algorithm.cc.
References ns3::TypeId::SetParent().
|
pure virtual |
Set the "user" part of the Handover Management SAP interface that this handover algorithm instance will interact with.
s | a reference to the "user" part of the interface, typically a member of an LteEnbRrc instance |
Implemented in ns3::A2A4RsrqHandoverAlgorithm, ns3::A3RsrpHandoverAlgorithm, and ns3::NoOpHandoverAlgorithm.