Loading...
Searching...
No Matches
ns3::SatTimuMessage Class Reference

TIM unicast control message (Tagged by SatControlMsgTag with type value SAT_TIMU_CTRL_MSG). More...

#include "satellite-control-message.h"

Inheritance diagram for ns3::SatTimuMessage:
Collaboration diagram for ns3::SatTimuMessage:

Public Member Functions

 SatTimuMessage ()
 Constructor for SatRaMessage.
 ~SatTimuMessage ()
 Destructor for SatRaMessage.
uint32_t GetAllocatedBeamId () const
 Get the allocated beam ID.
uint32_t GetAllocatedSatId () const
 Get the allocated sat ID.
Address GetGwAddress () const
SatControlMsgTag::SatControlMsgType_t GetMsgType () const
 Get type of the message.
Address GetSatAddress () const
virtual uint32_t GetSizeInBytes () const
 Get real size of the random access message, which can be used to e.g.
void SetAllocatedBeamId (uint32_t beamId)
 Set allocated beam ID.
void SetAllocatedSatId (uint32_t beamId)
 Set allocated sat ID.
void SetGwAddress (Address address)
void SetSatAddress (Address address)
Public Member Functions inherited from ns3::SatControlMessage
 SatControlMessage ()
 Default constructor for SatControlMessage.
 ~SatControlMessage ()
 Destructor.

Static Public Member Functions

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

Private Attributes

uint32_t m_beamId
 Allocated beam ID.
Address m_gwAddress
 Mac address of the new gateway.
Address m_satAddress
 Satellite mac address of the new gateway.
uint32_t m_satId
 Allocated sat ID.

Detailed Description

TIM unicast control message (Tagged by SatControlMsgTag with type value SAT_TIMU_CTRL_MSG).

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

Constructor & Destructor Documentation

◆ SatTimuMessage()

ns3::SatTimuMessage::SatTimuMessage ( )

Constructor for SatRaMessage.

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

References m_beamId.

◆ ~SatTimuMessage()

ns3::SatTimuMessage::~SatTimuMessage ( )

Destructor for SatRaMessage.

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

Member Function Documentation

◆ GetAllocatedBeamId()

uint32_t ns3::SatTimuMessage::GetAllocatedBeamId ( ) const

Get the allocated beam ID.

Returns
Allocated beam ID

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

References m_beamId.

◆ GetAllocatedSatId()

uint32_t ns3::SatTimuMessage::GetAllocatedSatId ( ) const

Get the allocated sat ID.

Returns
Allocated sat ID

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

References m_satId.

◆ GetGwAddress()

Address ns3::SatTimuMessage::GetGwAddress ( ) const

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

References m_gwAddress.

◆ GetMsgType()

SatControlMsgTag::SatControlMsgType_t ns3::SatTimuMessage::GetMsgType ( ) const
inlinevirtual

Get type of the message.

Returns
SatControlMsgTag::SAT_TIMU_CTRL_MSG

Implements ns3::SatControlMessage.

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

References ns3::SatControlMsgTag::SAT_TIMU_CTRL_MSG.

◆ GetSatAddress()

Address ns3::SatTimuMessage::GetSatAddress ( ) const

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

References m_satAddress.

◆ GetSizeInBytes()

uint32_t ns3::SatTimuMessage::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 717 of file satellite-control-message.cc.

◆ GetTypeId()

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

methods derived from base classes

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

References ns3::SatControlMessage::SatControlMessage().

Here is the call graph for this function:

◆ SetAllocatedBeamId()

void ns3::SatTimuMessage::SetAllocatedBeamId ( uint32_t beamId)

Set allocated beam ID.

Parameters
beamIdAllocated beam ID

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

References m_beamId.

◆ SetAllocatedSatId()

void ns3::SatTimuMessage::SetAllocatedSatId ( uint32_t beamId)

Set allocated sat ID.

Parameters
satIdAllocated sat ID

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

References m_satId.

◆ SetGwAddress()

void ns3::SatTimuMessage::SetGwAddress ( Address address)

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

References m_gwAddress.

◆ SetSatAddress()

void ns3::SatTimuMessage::SetSatAddress ( Address address)

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

References m_satAddress.

Member Data Documentation

◆ m_beamId

uint32_t ns3::SatTimuMessage::m_beamId
private

Allocated beam ID.

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

Referenced by SatTimuMessage(), GetAllocatedBeamId(), and SetAllocatedBeamId().

◆ m_gwAddress

Address ns3::SatTimuMessage::m_gwAddress
private

Mac address of the new gateway.

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

Referenced by GetGwAddress(), and SetGwAddress().

◆ m_satAddress

Address ns3::SatTimuMessage::m_satAddress
private

Satellite mac address of the new gateway.

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

Referenced by GetSatAddress(), and SetSatAddress().

◆ m_satId

uint32_t ns3::SatTimuMessage::m_satId
private

Allocated sat ID.

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

Referenced by GetAllocatedSatId(), and SetAllocatedSatId().

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