A Discrete-Event Network Simulator
API
ns3::NoOpHandoverAlgorithm Class Reference

Handover algorithm implementation which simply does nothing. More...

#include "no-op-handover-algorithm.h"

+ Inheritance diagram for ns3::NoOpHandoverAlgorithm:
+ Collaboration diagram for ns3::NoOpHandoverAlgorithm:

Public Member Functions

 NoOpHandoverAlgorithm ()
 Creates a No-op handover algorithm instance. More...
 
virtual ~NoOpHandoverAlgorithm ()
 
virtual LteHandoverManagementSapProviderGetLteHandoverManagementSapProvider ()
 Export the "provider" part of the Handover Management SAP interface. More...
 
virtual void SetLteHandoverManagementSapUser (LteHandoverManagementSapUser *s)
 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::LteHandoverAlgorithm
 LteHandoverAlgorithm ()
 
virtual ~LteHandoverAlgorithm ()
 
- 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...
 
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::LteHandoverAlgorithm
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 DoInitialize ()
 Initialize() implementation. More...
 
void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults)
 Implementation of LteHandoverManagementSapProvider::ReportUeMeas. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. 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...
 

Private Attributes

LteHandoverManagementSapProviderm_handoverManagementSapProvider
 Receive API calls from the eNodeB RRC instance. More...
 
LteHandoverManagementSapUserm_handoverManagementSapUser
 Interface to the eNodeB RRC instance. More...
 

Friends

class MemberLteHandoverManagementSapProvider< NoOpHandoverAlgorithm >
 let the forwarder class access the protected and private members More...
 

Additional Inherited Members

Detailed Description

Handover algorithm implementation which simply does nothing.


Selecting this handover algorithm is equivalent to disabling automatic triggering of handover. This is the default choice.

To enable automatic handover, please select another handover algorithm, i.e., another child class of LteHandoverAlgorithm.

Config Paths

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

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

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 48 bytes (on a 64-bit architecture).

Definition at line 41 of file no-op-handover-algorithm.h.

Constructor & Destructor Documentation

◆ NoOpHandoverAlgorithm()

ns3::NoOpHandoverAlgorithm::NoOpHandoverAlgorithm ( )

Creates a No-op handover algorithm instance.

Definition at line 32 of file no-op-handover-algorithm.cc.

References m_handoverManagementSapProvider, and NS_LOG_FUNCTION.

◆ ~NoOpHandoverAlgorithm()

ns3::NoOpHandoverAlgorithm::~NoOpHandoverAlgorithm ( )
virtual

Definition at line 40 of file no-op-handover-algorithm.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::NoOpHandoverAlgorithm::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::LteHandoverAlgorithm.

Definition at line 47 of file no-op-handover-algorithm.cc.

References m_handoverManagementSapProvider, and NS_LOG_FUNCTION.

◆ DoInitialize()

void ns3::NoOpHandoverAlgorithm::DoInitialize ( void  )
protectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 83 of file no-op-handover-algorithm.cc.

References ns3::Object::DoInitialize(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoReportUeMeas()

void ns3::NoOpHandoverAlgorithm::DoReportUeMeas ( uint16_t  rnti,
LteRrcSap::MeasResults  measResults 
)
protectedvirtual

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

Implements ns3::LteHandoverAlgorithm.

Definition at line 91 of file no-op-handover-algorithm.cc.

References ns3::LteRrcSap::MeasResults::measId, and NS_LOG_FUNCTION.

◆ GetLteHandoverManagementSapProvider()

LteHandoverManagementSapProvider * ns3::NoOpHandoverAlgorithm::GetLteHandoverManagementSapProvider ( )
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

Implements ns3::LteHandoverAlgorithm.

Definition at line 75 of file no-op-handover-algorithm.cc.

References m_handoverManagementSapProvider, and NS_LOG_FUNCTION.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 55 of file no-op-handover-algorithm.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetLteHandoverManagementSapUser()

void ns3::NoOpHandoverAlgorithm::SetLteHandoverManagementSapUser ( LteHandoverManagementSapUser s)
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

Implements ns3::LteHandoverAlgorithm.

Definition at line 67 of file no-op-handover-algorithm.cc.

References m_handoverManagementSapUser, and NS_LOG_FUNCTION.

Friends And Related Function Documentation

◆ MemberLteHandoverManagementSapProvider< NoOpHandoverAlgorithm >

let the forwarder class access the protected and private members

Definition at line 60 of file no-op-handover-algorithm.h.

Member Data Documentation

◆ m_handoverManagementSapProvider

LteHandoverManagementSapProvider* ns3::NoOpHandoverAlgorithm::m_handoverManagementSapProvider
private

Receive API calls from the eNodeB RRC instance.

Definition at line 74 of file no-op-handover-algorithm.h.

Referenced by DoDispose(), GetLteHandoverManagementSapProvider(), and NoOpHandoverAlgorithm().

◆ m_handoverManagementSapUser

LteHandoverManagementSapUser* ns3::NoOpHandoverAlgorithm::m_handoverManagementSapUser
private

Interface to the eNodeB RRC instance.

Definition at line 72 of file no-op-handover-algorithm.h.

Referenced by SetLteHandoverManagementSapUser().


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