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

Random access load control message (Tagged by SatControlMsgTag with type value SAT_RA_CTRL_MSG). More...

#include "satellite-control-message.h"

Inheritance diagram for ns3::SatRaMessage:
Collaboration diagram for ns3::SatRaMessage:

Public Member Functions

 SatRaMessage ()
 Constructor for SatRaMessage.
 ~SatRaMessage ()
 Destructor for SatRaMessage.
uint8_t GetAllocationChannelId () const
 Get allocation chanel ID.
uint16_t GetBackoffProbability () const
 Get backoff probability.
uint16_t GetBackoffTime () const
 Get backoff time.
SatControlMsgTag::SatControlMsgType_t GetMsgType () const
 Get type of the message.
virtual uint32_t GetSizeInBytes () const
 Get real size of the random access message, which can be used to e.g.
void SetAllocationChannelId (uint8_t allocationChannel)
 Set allocation channel ID.
void SetBackoffProbability (uint16_t backoffProbability)
 Set backoff probability.
void SetBackoffTime (uint16_t backoffTime)
 Set backoff time.
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

uint8_t m_allocationChannelId
 Allocation channel ID.
uint16_t m_backoffProbability
 Backoff probability.
uint16_t m_backoffTime
 Backoff time.

Static Private Attributes

static const uint32_t RA_CONTROL_MSG_HEADER_SIZE_IN_BYTES = 5
 Common header of the random access element.

Detailed Description

Random access load control message (Tagged by SatControlMsgTag with type value SAT_RA_CTRL_MSG).

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

Constructor & Destructor Documentation

◆ SatRaMessage()

ns3::SatRaMessage::SatRaMessage ( )

Constructor for SatRaMessage.

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

References m_allocationChannelId, m_backoffProbability, and m_backoffTime.

◆ ~SatRaMessage()

ns3::SatRaMessage::~SatRaMessage ( )

Destructor for SatRaMessage.

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

Member Function Documentation

◆ GetAllocationChannelId()

uint8_t ns3::SatRaMessage::GetAllocationChannelId ( ) const

Get allocation chanel ID.

Returns
Allocation channel ID

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

References m_allocationChannelId.

◆ GetBackoffProbability()

uint16_t ns3::SatRaMessage::GetBackoffProbability ( ) const

Get backoff probability.

Returns
backoff probability

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

References m_backoffProbability.

◆ GetBackoffTime()

uint16_t ns3::SatRaMessage::GetBackoffTime ( ) const

Get backoff time.

Returns
backoff time

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

References m_backoffTime.

◆ GetMsgType()

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

Get type of the message.

Returns
SatControlMsgTag::SAT_RA_CTRL_MSG

Implements ns3::SatControlMessage.

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

References ns3::SatControlMsgTag::SAT_RA_CTRL_MSG.

◆ GetSizeInBytes()

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

References RA_CONTROL_MSG_HEADER_SIZE_IN_BYTES.

◆ GetTypeId()

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

methods derived from base classes

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

References ns3::SatControlMessage::SatControlMessage().

Here is the call graph for this function:

◆ SetAllocationChannelId()

void ns3::SatRaMessage::SetAllocationChannelId ( uint8_t allocationChannel)

Set allocation channel ID.

Parameters
allocationChannelAllocation channel ID

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

References m_allocationChannelId.

◆ SetBackoffProbability()

void ns3::SatRaMessage::SetBackoffProbability ( uint16_t backoffProbability)

Set backoff probability.

Parameters
backoffProbabilityBackoff probability

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

References m_backoffProbability.

◆ SetBackoffTime()

void ns3::SatRaMessage::SetBackoffTime ( uint16_t backoffTime)

Set backoff time.

Parameters
backoffTimeBackoff time

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

References m_backoffTime.

Member Data Documentation

◆ m_allocationChannelId

uint8_t ns3::SatRaMessage::m_allocationChannelId
private

Allocation channel ID.

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

Referenced by SatRaMessage(), GetAllocationChannelId(), and SetAllocationChannelId().

◆ m_backoffProbability

uint16_t ns3::SatRaMessage::m_backoffProbability
private

Backoff probability.

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

Referenced by SatRaMessage(), GetBackoffProbability(), and SetBackoffProbability().

◆ m_backoffTime

uint16_t ns3::SatRaMessage::m_backoffTime
private

Backoff time.

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

Referenced by SatRaMessage(), GetBackoffTime(), and SetBackoffTime().

◆ RA_CONTROL_MSG_HEADER_SIZE_IN_BYTES

const uint32_t ns3::SatRaMessage::RA_CONTROL_MSG_HEADER_SIZE_IN_BYTES = 5
staticprivate

Common header of the random access element.

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

Referenced by GetSizeInBytes().

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