Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::SatUtHandoverModule Class Reference

UT handover module. More...

#include "satellite-ut-handover-module.h"

+ Inheritance diagram for ns3::SatUtHandoverModule:
+ Collaboration diagram for ns3::SatUtHandoverModule:

Public Types

typedef Callback< void, uint32_t > HandoverRequestCallback
 Handover recommendation message sending callback. More...
 

Public Member Functions

 SatUtHandoverModule ()
 Default constructor, which is not used. More...
 
 SatUtHandoverModule (Ptr< SatAntennaGainPatternContainer > agpContainer)
 Construct a SatUtHandoverModule. More...
 
 ~SatUtHandoverModule ()
 Destroy a SatUtHandoverModule. More...
 
bool CheckForHandoverRecommendation (uint32_t satId, uint32_t beamId)
 Inspect whether or not the given beam is still suitable for the underlying mobility model. More...
 
virtual void DoDispose ()
 Dispose of this class instance. More...
 
uint32_t GetAskedBeamId ()
 Get the best beam ID. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Derived from Object. More...
 
void SetHandoverRequestCallback (SatUtHandoverModule::HandoverRequestCallback cb)
 Set the handover recommendation message sending callback. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Derived from Object. More...
 

Private Attributes

Ptr< SatAntennaGainPatternContainer > m_antennaGainPatterns
 
TracedCallback< double > m_antennaGainTrace
 
uint32_t m_askedBeamId
 
HandoverRequestCallback m_handoverCallback
 
bool m_hasPendingRequest
 
Time m_lastMessageSentAt
 
Time m_repeatRequestTimeout
 

Detailed Description

UT handover module.

Definition at line 38 of file satellite-ut-handover-module.h.

Member Typedef Documentation

◆ HandoverRequestCallback

typedef Callback<void, uint32_t> ns3::SatUtHandoverModule::HandoverRequestCallback

Handover recommendation message sending callback.

Parameters
uint32_tThe beam ID this UT want to change to

Definition at line 45 of file satellite-ut-handover-module.h.

Constructor & Destructor Documentation

◆ SatUtHandoverModule() [1/2]

ns3::SatUtHandoverModule::SatUtHandoverModule ( )

Default constructor, which is not used.

Definition at line 75 of file satellite-ut-handover-module.cc.

◆ SatUtHandoverModule() [2/2]

ns3::SatUtHandoverModule::SatUtHandoverModule ( Ptr< SatAntennaGainPatternContainer >  agpContainer)

Construct a SatUtHandoverModule.

Parameters
agpContainerthe antenna gain patterns of the simulation

Definition at line 87 of file satellite-ut-handover-module.cc.

◆ ~SatUtHandoverModule()

ns3::SatUtHandoverModule::~SatUtHandoverModule ( )

Destroy a SatUtHandoverModule.

Definition at line 94 of file satellite-ut-handover-module.cc.

Member Function Documentation

◆ CheckForHandoverRecommendation()

bool ns3::SatUtHandoverModule::CheckForHandoverRecommendation ( uint32_t  satId,
uint32_t  beamId 
)

Inspect whether or not the given beam is still suitable for the underlying mobility model.

Parameters
satIdThe current satellite ID the underlying mobility model is emitting in
beamIdThe current beam ID the underlying mobility model is emitting in
Returns
whether or not an handover recommendation has been sent

Definition at line 114 of file satellite-ut-handover-module.cc.

References m_antennaGainPatterns, m_antennaGainTrace, m_askedBeamId, m_handoverCallback, m_hasPendingRequest, m_lastMessageSentAt, and m_repeatRequestTimeout.

Referenced by ns3::SatUtHelper::InstallDvb().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::SatUtHandoverModule::DoDispose ( void  )
virtual

Dispose of this class instance.

Definition at line 65 of file satellite-ut-handover-module.cc.

References m_antennaGainPatterns, and m_handoverCallback.

◆ GetAskedBeamId()

uint32_t ns3::SatUtHandoverModule::GetAskedBeamId ( )

Get the best beam ID.

Returns
The best beam ID

Definition at line 108 of file satellite-ut-handover-module.cc.

References m_askedBeamId.

Referenced by ns3::SatUtHelper::InstallDvb().

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::SatUtHandoverModule::GetInstanceTypeId ( void  ) const
virtual

Derived from Object.

Definition at line 57 of file satellite-ut-handover-module.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetTypeId()

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

Derived from Object.

Definition at line 37 of file satellite-ut-handover-module.cc.

References m_antennaGainTrace, and m_repeatRequestTimeout.

Referenced by GetInstanceTypeId().

+ Here is the caller graph for this function:

◆ SetHandoverRequestCallback()

void ns3::SatUtHandoverModule::SetHandoverRequestCallback ( SatUtHandoverModule::HandoverRequestCallback  cb)

Set the handover recommendation message sending callback.

Parameters
cbcallback to send handover recommendation messages

Definition at line 100 of file satellite-ut-handover-module.cc.

References m_handoverCallback.

Referenced by ns3::SatUtHelper::InstallDvb().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_antennaGainPatterns

Ptr<SatAntennaGainPatternContainer> ns3::SatUtHandoverModule::m_antennaGainPatterns
private

Definition at line 102 of file satellite-ut-handover-module.h.

Referenced by CheckForHandoverRecommendation(), and DoDispose().

◆ m_antennaGainTrace

TracedCallback<double> ns3::SatUtHandoverModule::m_antennaGainTrace
private

Definition at line 109 of file satellite-ut-handover-module.h.

Referenced by CheckForHandoverRecommendation(), and GetTypeId().

◆ m_askedBeamId

uint32_t ns3::SatUtHandoverModule::m_askedBeamId
private

Definition at line 107 of file satellite-ut-handover-module.h.

Referenced by CheckForHandoverRecommendation(), and GetAskedBeamId().

◆ m_handoverCallback

HandoverRequestCallback ns3::SatUtHandoverModule::m_handoverCallback
private

Definition at line 100 of file satellite-ut-handover-module.h.

Referenced by CheckForHandoverRecommendation(), DoDispose(), and SetHandoverRequestCallback().

◆ m_hasPendingRequest

bool ns3::SatUtHandoverModule::m_hasPendingRequest
private

Definition at line 106 of file satellite-ut-handover-module.h.

Referenced by CheckForHandoverRecommendation().

◆ m_lastMessageSentAt

Time ns3::SatUtHandoverModule::m_lastMessageSentAt
private

Definition at line 104 of file satellite-ut-handover-module.h.

Referenced by CheckForHandoverRecommendation().

◆ m_repeatRequestTimeout

Time ns3::SatUtHandoverModule::m_repeatRequestTimeout
private

Definition at line 105 of file satellite-ut-handover-module.h.

Referenced by CheckForHandoverRecommendation(), and GetTypeId().

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