ns3::SatLowerLayerServiceRaEntry Class Reference

The SatLowerLayerService class holds information of a satellite lower layer service RA entry. More...

#include "satellite-lower-layer-service.h"

Public Member Functions

 SatLowerLayerServiceRaEntry ()
 
 ~SatLowerLayerServiceRaEntry ()
 Destructor for SatLowerLayerServiceRaEntry. More...
 

Private Member Functions

double GetAverageNormalizedOfferedLoadThreshold () const
 Get average normalized offered load threshold. More...
 
uint16_t GetBackOffProbability () const
 Get back off probability. More...
 
uint16_t GetBackOffTimeInMilliSeconds () const
 Get back off time in milliseconds. More...
 
uint16_t GetHighLoadBackOffProbability () const
 Get high load back off probability. More...
 
uint16_t GetHighLoadBackOffTimeInMilliSeconds () const
 Get high load back off time in milliseconds. More...
 
bool GetIsCrdsaAllowed () const
 Get CRDSA allowance. More...
 
bool GetIsEssaAllowed () const
 Get ESSA allowance. More...
 
bool GetIsSlottedAlohaAllowed () const
 Get Slotted Aloha allowance. More...
 
uint8_t GetMaximumConsecutiveBlockAccessed () const
 Get maximum consecutive block accessed. More...
 
uint8_t GetMaximumUniquePayloadPerBlock () const
 Get maximum unique payload per block. More...
 
uint8_t GetMinimumIdleBlock () const
 Get minimum idle block. More...
 
uint8_t GetNumberOfInstances () const
 Get number of instances. More...
 
void SetAverageNormalizedOfferedLoadThreshold (double averageNormalizedOfferedLoadThreshold)
 Set average normalized offered load threshold. More...
 
void SetBackOffProbability (uint16_t backOffProbability)
 Set back off probability. More...
 
void SetBackOffTimeInMilliSeconds (uint16_t backOffTimeInMilliSeconds)
 Set back off time in milliseconds. More...
 
void SetHighLoadBackOffProbability (uint16_t highLoadBackOffProbability)
 Set high load back off probability. More...
 
void SetHighLoadBackOffTimeInMilliSeconds (uint16_t backOffTimeInMilliSeconds)
 Set high load back off time in milliseconds. More...
 
void SetIsCrdsaAllowed (bool isCrdsaAllowed)
 Set CRDSA allowance. More...
 
void SetIsEssaAllowed (bool isEssaAllowed)
 Set ESSA allowance. More...
 
void SetIsSlottedAlohaAllowed (bool isSlottedAlohaAllowed)
 Set Slotted Aloha allowance. More...
 
void SetMaximumConsecutiveBlockAccessed (uint8_t maxConsecutiveBlockAccessed)
 Set maximum consecutive block accessed. More...
 
void SetMaximumUniquePayloadPerBlock (uint8_t maxUniquePayloadPerBlock)
 Set maximum unique payload per block. More...
 
void SetMinimumIdleBlock (uint8_t minimumIdleBlock)
 Set minimum idle block. More...
 
void SetNumberOfInstances (uint8_t numberOfInstances)
 Set number of instances. More...
 

Private Attributes

double m_averageNormalizedOfferedLoadThreshold
 
uint16_t m_backOffProbability
 
uint16_t m_backOffTimeInMilliSeconds
 
uint16_t m_highLoadBackOffProbability
 
uint16_t m_highLoadBackOffTimeInMilliSeconds
 
bool m_isCrdsaAllowed
 
bool m_isEssaAllowed
 
bool m_isSlottedAlohaAllowed
 
uint8_t m_maxConsecutiveBlockAccessed
 
uint8_t m_maxUniquePayloadPerBlock
 
uint8_t m_minimumIdleBlock
 
uint8_t m_numberOfInstances
 

Friends

class SatLowerLayerServiceConf
 

Detailed Description

The SatLowerLayerService class holds information of a satellite lower layer service RA entry.

Definition at line 224 of file satellite-lower-layer-service.h.

Constructor & Destructor Documentation

◆ SatLowerLayerServiceRaEntry()

ns3::SatLowerLayerServiceRaEntry::SatLowerLayerServiceRaEntry ( )

Definition at line 61 of file satellite-lower-layer-service.cc.

◆ ~SatLowerLayerServiceRaEntry()

ns3::SatLowerLayerServiceRaEntry::~SatLowerLayerServiceRaEntry ( )

Destructor for SatLowerLayerServiceRaEntry.

Definition at line 78 of file satellite-lower-layer-service.cc.

Member Function Documentation

◆ GetAverageNormalizedOfferedLoadThreshold()

double ns3::SatLowerLayerServiceRaEntry::GetAverageNormalizedOfferedLoadThreshold ( ) const
inlineprivate

Get average normalized offered load threshold.

Returns
Average normalized offered load threshold

Definition at line 416 of file satellite-lower-layer-service.h.

References m_averageNormalizedOfferedLoadThreshold.

Referenced by ns3::SatLowerLayerServiceConf::GetRaAverageNormalizedOfferedLoadThreshold().

+ Here is the caller graph for this function:

◆ GetBackOffProbability()

uint16_t ns3::SatLowerLayerServiceRaEntry::GetBackOffProbability ( ) const
inlineprivate

Get back off probability.

Returns
Back off probability

Definition at line 356 of file satellite-lower-layer-service.h.

References m_backOffProbability.

Referenced by ns3::SatLowerLayerServiceConf::GetRaBackOffProbability().

+ Here is the caller graph for this function:

◆ GetBackOffTimeInMilliSeconds()

uint16_t ns3::SatLowerLayerServiceRaEntry::GetBackOffTimeInMilliSeconds ( ) const
inlineprivate

Get back off time in milliseconds.

Returns
Back off time

Definition at line 316 of file satellite-lower-layer-service.h.

References m_backOffTimeInMilliSeconds.

Referenced by ns3::SatLowerLayerServiceConf::GetRaBackOffTimeInMilliSeconds().

+ Here is the caller graph for this function:

◆ GetHighLoadBackOffProbability()

uint16_t ns3::SatLowerLayerServiceRaEntry::GetHighLoadBackOffProbability ( ) const
inlineprivate

Get high load back off probability.

Returns
High load back off probability

Definition at line 376 of file satellite-lower-layer-service.h.

References m_highLoadBackOffProbability.

Referenced by ns3::SatLowerLayerServiceConf::GetRaHighLoadBackOffProbability().

+ Here is the caller graph for this function:

◆ GetHighLoadBackOffTimeInMilliSeconds()

uint16_t ns3::SatLowerLayerServiceRaEntry::GetHighLoadBackOffTimeInMilliSeconds ( ) const
inlineprivate

Get high load back off time in milliseconds.

Returns
Back off time

Definition at line 336 of file satellite-lower-layer-service.h.

References m_highLoadBackOffTimeInMilliSeconds.

Referenced by ns3::SatLowerLayerServiceConf::GetRaHighLoadBackOffTimeInMilliSeconds().

+ Here is the caller graph for this function:

◆ GetIsCrdsaAllowed()

bool ns3::SatLowerLayerServiceRaEntry::GetIsCrdsaAllowed ( ) const
inlineprivate

Get CRDSA allowance.

Returns
Is CRDSA allowed

Definition at line 457 of file satellite-lower-layer-service.h.

References m_isCrdsaAllowed.

Referenced by ns3::SatLowerLayerServiceConf::GetRaIsCrdsaAllowed().

+ Here is the caller graph for this function:

◆ GetIsEssaAllowed()

bool ns3::SatLowerLayerServiceRaEntry::GetIsEssaAllowed ( ) const
inlineprivate

Get ESSA allowance.

Returns
Is ESSA allowed

Definition at line 477 of file satellite-lower-layer-service.h.

References m_isEssaAllowed.

Referenced by ns3::SatLowerLayerServiceConf::GetRaIsEssaAllowed().

+ Here is the caller graph for this function:

◆ GetIsSlottedAlohaAllowed()

bool ns3::SatLowerLayerServiceRaEntry::GetIsSlottedAlohaAllowed ( ) const
inlineprivate

Get Slotted Aloha allowance.

Returns
Is Slotted Aloha allowed

Definition at line 437 of file satellite-lower-layer-service.h.

References m_isSlottedAlohaAllowed.

Referenced by ns3::SatLowerLayerServiceConf::GetRaIsSlottedAlohaAllowed().

+ Here is the caller graph for this function:

◆ GetMaximumConsecutiveBlockAccessed()

uint8_t ns3::SatLowerLayerServiceRaEntry::GetMaximumConsecutiveBlockAccessed ( ) const
inlineprivate

Get maximum consecutive block accessed.

Returns
Maximum consecutive block accessed

Definition at line 276 of file satellite-lower-layer-service.h.

References m_maxConsecutiveBlockAccessed.

Referenced by ns3::SatLowerLayerServiceConf::GetRaMaximumConsecutiveBlockAccessed().

+ Here is the caller graph for this function:

◆ GetMaximumUniquePayloadPerBlock()

uint8_t ns3::SatLowerLayerServiceRaEntry::GetMaximumUniquePayloadPerBlock ( ) const
inlineprivate

Get maximum unique payload per block.

Returns
Maximum unique payload per block

Definition at line 256 of file satellite-lower-layer-service.h.

References m_maxUniquePayloadPerBlock.

Referenced by ns3::SatLowerLayerServiceConf::GetRaMaximumUniquePayloadPerBlock().

+ Here is the caller graph for this function:

◆ GetMinimumIdleBlock()

uint8_t ns3::SatLowerLayerServiceRaEntry::GetMinimumIdleBlock ( ) const
inlineprivate

Get minimum idle block.

Returns
Minimum idle block

Definition at line 296 of file satellite-lower-layer-service.h.

References m_minimumIdleBlock.

Referenced by ns3::SatLowerLayerServiceConf::GetRaMinimumIdleBlock().

+ Here is the caller graph for this function:

◆ GetNumberOfInstances()

uint8_t ns3::SatLowerLayerServiceRaEntry::GetNumberOfInstances ( ) const
inlineprivate

Get number of instances.

Returns
Number of instances

Definition at line 396 of file satellite-lower-layer-service.h.

References m_numberOfInstances.

Referenced by ns3::SatLowerLayerServiceConf::GetRaNumberOfInstances().

+ Here is the caller graph for this function:

◆ SetAverageNormalizedOfferedLoadThreshold()

void ns3::SatLowerLayerServiceRaEntry::SetAverageNormalizedOfferedLoadThreshold ( double  averageNormalizedOfferedLoadThreshold)
inlineprivate

Set average normalized offered load threshold.

Parameters
averageNormalizedOfferedLoadThresholdAverage normalized offered load threshold

Definition at line 426 of file satellite-lower-layer-service.h.

References m_averageNormalizedOfferedLoadThreshold.

Referenced by ns3::SatLowerLayerServiceConf::SetRaAverageNormalizedOfferedLoadThreshold().

+ Here is the caller graph for this function:

◆ SetBackOffProbability()

void ns3::SatLowerLayerServiceRaEntry::SetBackOffProbability ( uint16_t  backOffProbability)
inlineprivate

Set back off probability.

Parameters
backOffProbabilityBack off probability

Definition at line 366 of file satellite-lower-layer-service.h.

References m_backOffProbability.

Referenced by ns3::SatLowerLayerServiceConf::SetRaBackOffProbability().

+ Here is the caller graph for this function:

◆ SetBackOffTimeInMilliSeconds()

void ns3::SatLowerLayerServiceRaEntry::SetBackOffTimeInMilliSeconds ( uint16_t  backOffTimeInMilliSeconds)
inlineprivate

Set back off time in milliseconds.

Parameters
backOffTimeInMilliSecondsBack off time

Definition at line 326 of file satellite-lower-layer-service.h.

References m_backOffTimeInMilliSeconds.

Referenced by ns3::SatLowerLayerServiceConf::SetRaBackOffTimeInMilliSeconds().

+ Here is the caller graph for this function:

◆ SetHighLoadBackOffProbability()

void ns3::SatLowerLayerServiceRaEntry::SetHighLoadBackOffProbability ( uint16_t  highLoadBackOffProbability)
inlineprivate

Set high load back off probability.

Parameters
highLoadBackOffProbabilityHigh load back off probability

Definition at line 386 of file satellite-lower-layer-service.h.

References m_highLoadBackOffProbability.

Referenced by ns3::SatLowerLayerServiceConf::SetRaHighLoadBackOffProbability().

+ Here is the caller graph for this function:

◆ SetHighLoadBackOffTimeInMilliSeconds()

void ns3::SatLowerLayerServiceRaEntry::SetHighLoadBackOffTimeInMilliSeconds ( uint16_t  backOffTimeInMilliSeconds)
inlineprivate

Set high load back off time in milliseconds.

Parameters
backOffTimeInMilliSecondsBack off time

Definition at line 346 of file satellite-lower-layer-service.h.

References m_highLoadBackOffTimeInMilliSeconds.

Referenced by ns3::SatLowerLayerServiceConf::SetRaHighLoadBackOffTimeInMilliSeconds().

+ Here is the caller graph for this function:

◆ SetIsCrdsaAllowed()

void ns3::SatLowerLayerServiceRaEntry::SetIsCrdsaAllowed ( bool  isCrdsaAllowed)
inlineprivate

Set CRDSA allowance.

Parameters
isCrdsaAllowedIs CRDSA allowed

Definition at line 467 of file satellite-lower-layer-service.h.

References m_isCrdsaAllowed.

Referenced by ns3::SatLowerLayerServiceConf::SetRaIsCrdsaAllowed().

+ Here is the caller graph for this function:

◆ SetIsEssaAllowed()

void ns3::SatLowerLayerServiceRaEntry::SetIsEssaAllowed ( bool  isEssaAllowed)
inlineprivate

Set ESSA allowance.

Parameters
isEssaAllowedIs ESSA allowed

Definition at line 487 of file satellite-lower-layer-service.h.

References m_isEssaAllowed.

Referenced by ns3::SatLowerLayerServiceConf::SetRaIsEssaAllowed().

+ Here is the caller graph for this function:

◆ SetIsSlottedAlohaAllowed()

void ns3::SatLowerLayerServiceRaEntry::SetIsSlottedAlohaAllowed ( bool  isSlottedAlohaAllowed)
inlineprivate

Set Slotted Aloha allowance.

Parameters
isSlottedAlohaAllowedIs Slotted Aloha allowed

Definition at line 447 of file satellite-lower-layer-service.h.

References m_isSlottedAlohaAllowed.

Referenced by ns3::SatLowerLayerServiceConf::SetRaIsSlottedAlohaAllowed().

+ Here is the caller graph for this function:

◆ SetMaximumConsecutiveBlockAccessed()

void ns3::SatLowerLayerServiceRaEntry::SetMaximumConsecutiveBlockAccessed ( uint8_t  maxConsecutiveBlockAccessed)
inlineprivate

Set maximum consecutive block accessed.

Parameters
maxConsecutiveBlockAccessedMaximum consecutive block accessed

Definition at line 286 of file satellite-lower-layer-service.h.

References m_maxConsecutiveBlockAccessed.

Referenced by ns3::SatLowerLayerServiceConf::SetRaMaximumConsecutiveBlockAccessed().

+ Here is the caller graph for this function:

◆ SetMaximumUniquePayloadPerBlock()

void ns3::SatLowerLayerServiceRaEntry::SetMaximumUniquePayloadPerBlock ( uint8_t  maxUniquePayloadPerBlock)
inlineprivate

Set maximum unique payload per block.

Parameters
maxUniquePayloadPerBlockMaximum unique payload per block

Definition at line 266 of file satellite-lower-layer-service.h.

References m_maxUniquePayloadPerBlock.

Referenced by ns3::SatLowerLayerServiceConf::SetRaMaximumUniquePayloadPerBlock().

+ Here is the caller graph for this function:

◆ SetMinimumIdleBlock()

void ns3::SatLowerLayerServiceRaEntry::SetMinimumIdleBlock ( uint8_t  minimumIdleBlock)
inlineprivate

Set minimum idle block.

Parameters
minimumIdleBlockMinimum idle block

Definition at line 306 of file satellite-lower-layer-service.h.

References m_minimumIdleBlock.

Referenced by ns3::SatLowerLayerServiceConf::SetRaMinimumIdleBlock().

+ Here is the caller graph for this function:

◆ SetNumberOfInstances()

void ns3::SatLowerLayerServiceRaEntry::SetNumberOfInstances ( uint8_t  numberOfInstances)
inlineprivate

Set number of instances.

Parameters
numberOfInstancesNumber of instances

Definition at line 406 of file satellite-lower-layer-service.h.

References m_numberOfInstances.

Referenced by ns3::SatLowerLayerServiceConf::SetRaNumberOfInstances().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

◆ SatLowerLayerServiceConf

friend class SatLowerLayerServiceConf
friend

Definition at line 227 of file satellite-lower-layer-service.h.

Member Data Documentation

◆ m_averageNormalizedOfferedLoadThreshold

double ns3::SatLowerLayerServiceRaEntry::m_averageNormalizedOfferedLoadThreshold
private

◆ m_backOffProbability

uint16_t ns3::SatLowerLayerServiceRaEntry::m_backOffProbability
private

◆ m_backOffTimeInMilliSeconds

uint16_t ns3::SatLowerLayerServiceRaEntry::m_backOffTimeInMilliSeconds
private

◆ m_highLoadBackOffProbability

uint16_t ns3::SatLowerLayerServiceRaEntry::m_highLoadBackOffProbability
private

◆ m_highLoadBackOffTimeInMilliSeconds

uint16_t ns3::SatLowerLayerServiceRaEntry::m_highLoadBackOffTimeInMilliSeconds
private

◆ m_isCrdsaAllowed

bool ns3::SatLowerLayerServiceRaEntry::m_isCrdsaAllowed
private

Definition at line 247 of file satellite-lower-layer-service.h.

Referenced by GetIsCrdsaAllowed(), and SetIsCrdsaAllowed().

◆ m_isEssaAllowed

bool ns3::SatLowerLayerServiceRaEntry::m_isEssaAllowed
private

Definition at line 249 of file satellite-lower-layer-service.h.

Referenced by GetIsEssaAllowed(), and SetIsEssaAllowed().

◆ m_isSlottedAlohaAllowed

bool ns3::SatLowerLayerServiceRaEntry::m_isSlottedAlohaAllowed
private

◆ m_maxConsecutiveBlockAccessed

uint8_t ns3::SatLowerLayerServiceRaEntry::m_maxConsecutiveBlockAccessed
private

◆ m_maxUniquePayloadPerBlock

uint8_t ns3::SatLowerLayerServiceRaEntry::m_maxUniquePayloadPerBlock
private

◆ m_minimumIdleBlock

uint8_t ns3::SatLowerLayerServiceRaEntry::m_minimumIdleBlock
private

Definition at line 240 of file satellite-lower-layer-service.h.

Referenced by GetMinimumIdleBlock(), and SetMinimumIdleBlock().

◆ m_numberOfInstances

uint8_t ns3::SatLowerLayerServiceRaEntry::m_numberOfInstances
private

Definition at line 245 of file satellite-lower-layer-service.h.

Referenced by GetNumberOfInstances(), and SetNumberOfInstances().


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