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 LteHandoverManagementSapProvider *	GetLteHandoverManagementSapProvider ()=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 ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId ()

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

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Protected Member Functions
virtual void	DoDispose ()
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. 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)

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

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 eNode 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::LteEnbNetDevice/LteHandoverAlgorithm
/NodeList/[i]/DeviceList/[i]/$ns3::LteNetDevice/$ns3::LteEnbNetDevice/LteHandoverAlgorithm

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 66 of file lte-handover-algorithm.h.

Constructor & Destructor Documentation

ns3::LteHandoverAlgorithm::LteHandoverAlgorithm ( )

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

ns3::LteHandoverAlgorithm::~LteHandoverAlgorithm ( )

virtual

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

Member Function Documentation

void ns3::LteHandoverAlgorithm::DoDispose ( void )

protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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.

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

protectedpure virtual

Implementation of LteHandoverManagementSapProvider::ReportUeMeas.

Parameters

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.

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.

TypeId ns3::LteHandoverAlgorithm::GetTypeId ( void )

static

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

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

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.

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

src/lte/model/lte-handover-algorithm.h
src/lte/model/lte-handover-algorithm.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Config Paths

Constructor & Destructor Documentation

Member Function Documentation