ns3::SatHandoverRecommendationMessage Class Reference

Handover recommendation control message (Tagged by SatControlMsgTag with type value SAT_HR_CTRL_MSG) More...

#include "satellite-control-message.h"

+ Inheritance diagram for ns3::SatHandoverRecommendationMessage:
+ Collaboration diagram for ns3::SatHandoverRecommendationMessage:

Public Member Functions

 SatHandoverRecommendationMessage ()
 Constructor for SatRaMessage. More...
 
 ~SatHandoverRecommendationMessage ()
 Destructor for SatRaMessage. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the type ID of instance. More...
 
SatControlMsgTag::SatControlMsgType_t GetMsgType () const
 Get type of the message. More...
 
uint32_t GetRecommendedBeamId () const
 Get the recommended beam ID. More...
 
uint32_t GetRecommendedSatId () const
 Get the recommended sat ID. More...
 
virtual uint32_t GetSizeInBytes () const
 Get real size of the random access message, which can be used to e.g. More...
 
void SetRecommendedBeamId (uint32_t beamId)
 Set recommended beam ID. More...
 
void SetRecommendedSatId (uint32_t beamId)
 Set recommended sat ID. More...
 
- Public Member Functions inherited from ns3::SatControlMessage
 SatControlMessage ()
 Default constructor for SatControlMessage. More...
 
 ~SatControlMessage ()
 Destructor. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 methods derived from base classes More...
 
- Static Public Member Functions inherited from ns3::SatControlMessage
static TypeId GetTypeId (void)
 methods derived from base classes More...
 

Private Attributes

uint32_t m_beamId
 Recommended beam ID. More...
 
uint32_t m_satId
 Recommended sat ID. More...
 

Detailed Description

Handover recommendation control message (Tagged by SatControlMsgTag with type value SAT_HR_CTRL_MSG)

Definition at line 880 of file satellite-control-message.h.

Constructor & Destructor Documentation

◆ SatHandoverRecommendationMessage()

ns3::SatHandoverRecommendationMessage::SatHandoverRecommendationMessage ( )

Constructor for SatRaMessage.

Definition at line 792 of file satellite-control-message.cc.

◆ ~SatHandoverRecommendationMessage()

ns3::SatHandoverRecommendationMessage::~SatHandoverRecommendationMessage ( )

Destructor for SatRaMessage.

Definition at line 799 of file satellite-control-message.cc.

Member Function Documentation

◆ GetInstanceTypeId()

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

Get the type ID of instance.

Returns
the object TypeId

Definition at line 785 of file satellite-control-message.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetMsgType()

SatControlMsgTag::SatControlMsgType_t ns3::SatHandoverRecommendationMessage::GetMsgType ( void  ) const
inlinevirtual

Get type of the message.

Returns
SatControlMsgTag::SAT_HR_CTRL_MSG

Implements ns3::SatControlMessage.

Definition at line 909 of file satellite-control-message.h.

References ns3::SatControlMsgTag::SAT_HR_CTRL_MSG.

◆ GetRecommendedBeamId()

uint32_t ns3::SatHandoverRecommendationMessage::GetRecommendedBeamId ( ) const

Get the recommended beam ID.

Returns
Recommended beam ID

Definition at line 812 of file satellite-control-message.cc.

References m_beamId.

◆ GetRecommendedSatId()

uint32_t ns3::SatHandoverRecommendationMessage::GetRecommendedSatId ( ) const

Get the recommended sat ID.

Returns
Recommended sat ID

Definition at line 825 of file satellite-control-message.cc.

References m_satId.

◆ GetSizeInBytes()

uint32_t ns3::SatHandoverRecommendationMessage::GetSizeInBytes ( ) const
virtual

Get real size of the random access message, which can be used to e.g.

simulate real size.

Returns
Real size of the random access message.

Implements ns3::SatControlMessage.

Definition at line 831 of file satellite-control-message.cc.

◆ GetTypeId()

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

methods derived from base classes

Definition at line 776 of file satellite-control-message.cc.

Referenced by GetInstanceTypeId().

+ Here is the caller graph for this function:

◆ SetRecommendedBeamId()

void ns3::SatHandoverRecommendationMessage::SetRecommendedBeamId ( uint32_t  beamId)

Set recommended beam ID.

Parameters
beamIdRecommended beam ID

Definition at line 805 of file satellite-control-message.cc.

References m_beamId.

◆ SetRecommendedSatId()

void ns3::SatHandoverRecommendationMessage::SetRecommendedSatId ( uint32_t  beamId)

Set recommended sat ID.

Parameters
beamIdRecommended sat ID

Definition at line 818 of file satellite-control-message.cc.

References m_satId.

Member Data Documentation

◆ m_beamId

uint32_t ns3::SatHandoverRecommendationMessage::m_beamId
private

Recommended beam ID.

Definition at line 948 of file satellite-control-message.h.

Referenced by GetRecommendedBeamId(), and SetRecommendedBeamId().

◆ m_satId

uint32_t ns3::SatHandoverRecommendationMessage::m_satId
private

Recommended sat ID.

Definition at line 953 of file satellite-control-message.h.

Referenced by GetRecommendedSatId(), and SetRecommendedSatId().


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