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. More... | |
| ~SatRaMessage () | |
| Destructor for SatRaMessage. More... | |
| uint8_t | GetAllocationChannelId () const |
| Get allocation chanel ID. More... | |
| uint16_t | GetBackoffProbability () const |
| Get backoff probability. More... | |
| uint16_t | GetBackoffTime () const |
| Get backoff time. More... | |
| virtual TypeId | GetInstanceTypeId (void) const |
| Get the type ID of instance. More... | |
| SatControlMsgTag::SatControlMsgType_t | GetMsgType () const |
| Get type of the message. More... | |
| virtual uint32_t | GetSizeInBytes () const |
| Get real size of the random access message, which can be used to e.g. More... | |
| void | SetAllocationChannelId (uint8_t allocationChannel) |
| Set allocation channel ID. More... | |
| void | SetBackoffProbability (uint16_t backoffProbability) |
| Set backoff probability. More... | |
| void | SetBackoffTime (uint16_t backoffTime) |
| Set backoff time. More... | |
| Public Member Functions inherited from ns3::SatControlMessage | |
Static Public Member Functions | |
| static TypeId | GetTypeId (void) |
| methods derived from base classes More... | |
| Static Public Member Functions inherited from ns3::SatControlMessage | |
Private Attributes | |
| uint8_t | m_allocationChannelId |
| Allocation channel ID. More... | |
| uint16_t | m_backoffProbability |
| Backoff probability. More... | |
| uint16_t | m_backoffTime |
| Backoff time. More... | |
Static Private Attributes | |
| static const uint32_t | RA_CONTROL_MSG_HEADER_SIZE_IN_BYTES = 5 |
| Common header of the random access element. More... | |
Detailed Description
Random access load control message (Tagged by SatControlMsgTag with type value SAT_RA_CTRL_MSG)
Definition at line 673 of file satellite-control-message.h.
Constructor & Destructor Documentation
◆ SatRaMessage()
| ns3::SatRaMessage::SatRaMessage | ( | ) |
Constructor for SatRaMessage.
Definition at line 543 of file satellite-control-message.cc.
◆ ~SatRaMessage()
| ns3::SatRaMessage::~SatRaMessage | ( | ) |
Destructor for SatRaMessage.
Definition at line 551 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 565 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 587 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 593 of file satellite-control-message.cc.
References m_backoffTime.
◆ GetInstanceTypeId()
|
virtual |
Get the type ID of instance.
- Returns
- the object TypeId
Definition at line 536 of file satellite-control-message.cc.
References GetTypeId().
Here is the call graph for this function:
◆ GetMsgType()
|
inlinevirtual |
Get type of the message.
Implements ns3::SatControlMessage.
Definition at line 702 of file satellite-control-message.h.
References ns3::SatControlMsgTag::SAT_RA_CTRL_MSG.
◆ GetSizeInBytes()
|
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 599 of file satellite-control-message.cc.
References RA_CONTROL_MSG_HEADER_SIZE_IN_BYTES.
◆ GetTypeId()
|
static |
methods derived from base classes
Definition at line 528 of file satellite-control-message.cc.
Referenced by GetInstanceTypeId().
Here is the caller graph for this function:
◆ SetAllocationChannelId()
| void ns3::SatRaMessage::SetAllocationChannelId | ( | uint8_t | allocationChannel | ) |
Set allocation channel ID.
- Parameters
-
allocationChannel Allocation channel ID
Definition at line 557 of file satellite-control-message.cc.
References m_allocationChannelId.
◆ SetBackoffProbability()
| void ns3::SatRaMessage::SetBackoffProbability | ( | uint16_t | backoffProbability | ) |
Set backoff probability.
- Parameters
-
backoffProbability Backoff probability
Definition at line 571 of file satellite-control-message.cc.
References m_backoffProbability.
◆ SetBackoffTime()
| void ns3::SatRaMessage::SetBackoffTime | ( | uint16_t | backoffTime | ) |
Set backoff time.
- Parameters
-
backoffTime Backoff time
Definition at line 579 of file satellite-control-message.cc.
References m_backoffTime.
Member Data Documentation
◆ m_allocationChannelId
|
private |
Allocation channel ID.
Definition at line 758 of file satellite-control-message.h.
Referenced by GetAllocationChannelId(), and SetAllocationChannelId().
◆ m_backoffProbability
|
private |
Backoff probability.
Definition at line 763 of file satellite-control-message.h.
Referenced by GetBackoffProbability(), and SetBackoffProbability().
◆ m_backoffTime
|
private |
Backoff time.
Definition at line 768 of file satellite-control-message.h.
Referenced by GetBackoffTime(), and SetBackoffTime().
◆ RA_CONTROL_MSG_HEADER_SIZE_IN_BYTES
|
staticprivate |
Common header of the random access element.
Definition at line 753 of file satellite-control-message.h.
Referenced by GetSizeInBytes().
The documentation for this class was generated from the following files:
- /builds/sns3/satellite/satellite/model/satellite-control-message.h
- /builds/sns3/satellite/satellite/model/satellite-control-message.cc
