Class for random access allocation channel configuration. More...
#include "satellite-random-access-allocation-channel.h"
Public Member Functions | |
SatRandomAccessAllocationChannel () | |
Constructor. More... | |
virtual | ~SatRandomAccessAllocationChannel () |
Destructor. More... | |
void | DoCrdsaVariableSanityCheck () |
Function for checking the CRDSA parameter sanity. More... | |
bool | GetCrdsaAllowed () |
Function for getting the status of CRDSA allowance. More... | |
double | GetCrdsaBackoffProbability () |
Function for getting the CRDSA backoff probability. More... | |
Time | GetCrdsaBackoffReleaseTime () |
Function for getting the CRDSA backoff release time. More... | |
uint32_t | GetCrdsaBackoffTimeInMilliSeconds () |
Function for getting the CRDSA backoff time. More... | |
uint32_t | GetCrdsaIdleBlocksLeft () |
Function for getting the CRDSA number of idle blocks left. More... | |
uint32_t | GetCrdsaMaxConsecutiveBlocksAccessed () |
Function for getting the CRDSA number of consecutive blocks accessed. More... | |
uint32_t | GetCrdsaMaxRandomizationValue () |
Function for getting the CRDSA maximum randomization value. More... | |
uint32_t | GetCrdsaMaxUniquePayloadPerBlock () |
Function for getting the CRDSA maximum number of unique payloads per block. More... | |
uint32_t | GetCrdsaMinIdleBlocks () |
Function for getting the CRDSA minimum number of idle blocks. More... | |
uint32_t | GetCrdsaMinRandomizationValue () |
Function for getting the CRDSA minimum randomization value. More... | |
uint32_t | GetCrdsaNumOfConsecutiveBlocksUsed () |
Function for getting the CRDSA number of consecutive blocks used. More... | |
uint32_t | GetCrdsaNumOfInstances () |
Function for getting the CRDSA number of packet instances (replicas) More... | |
bool | GetEssaAllowed () |
Function for getting the status of ESSA allowance. More... | |
double | GetFSimBackoffProbability () |
Function for getting the F-SIM backoff probability. More... | |
uint32_t | GetFSimBackoffTimeInMilliSeconds () |
Function for getting the F-SIM backoff time. More... | |
bool | GetSlottedAlohaAllowed () |
Function for getting the status of Slotted Aloha allowance. More... | |
void | SetCrdsaAllowed (bool isCrdsaAllowed) |
Function for setting the status of CRDSA allowance. More... | |
void | SetCrdsaBackoffProbability (uint16_t crdsaBackoffProbability) |
Function for setting the CRDSA backoff probability. More... | |
void | SetCrdsaBackoffReleaseTime (Time crdsaBackoffReleaseTime) |
Function for setting the CRDSA backoff release time. More... | |
void | SetCrdsaBackoffTimeInMilliSeconds (uint32_t crdsaBackoffTimeInMilliSeconds) |
Function for setting the CRDSA backoff time. More... | |
void | SetCrdsaIdleBlocksLeft (uint32_t idleBlocksLeft) |
Function for setting the CRDSA number of idle blocks left. More... | |
void | SetCrdsaMaxConsecutiveBlocksAccessed (uint32_t maxConsecutiveBlocksAccessed) |
Function for setting the CRDSA maximum number of consecutive blocks accessed. More... | |
void | SetCrdsaMaxRandomizationValue (uint32_t maxRandomizationValue) |
Function for setting the CRDSA maximum randomization value. More... | |
void | SetCrdsaMaxUniquePayloadPerBlock (uint32_t maxUniquePayloadPerBlock) |
Function for setting the CRDSA maximum number of unique payloads per block. More... | |
void | SetCrdsaMinIdleBlocks (uint32_t minIdleBlocks) |
Function for setting the CRDSA minimum number of idle blocks. More... | |
void | SetCrdsaMinRandomizationValue (uint32_t minRandomizationValue) |
Function for setting the CRDSA minimum randomization value. More... | |
void | SetCrdsaNumOfConsecutiveBlocksUsed (uint32_t numOfConsecutiveBlocksUsed) |
Function for setting the CRDSA number of consecutive blocks used. More... | |
void | SetCrdsaNumOfInstances (uint32_t numOfInstances) |
Function for setting the CRDSA number of packet instances (replicas) More... | |
void | SetEssaAllowed (bool isEssaAllowed) |
Function for setting the status of ESSA allowance. More... | |
void | SetFSimBackoffProbability (uint16_t fSimPersistence) |
Function for setting the F-SIM backoff probability. More... | |
void | SetFSimBackoffTimeInFrames (uint32_t fSimBackoffTimeInFrames) |
Function for setting the F-SIM backoff time. More... | |
void | SetFSimBackoffTimeInMilliSeconds (uint32_t fSimBackoffTimeInMilliSeconds) |
Function for setting the F-SIM backoff time. More... | |
void | SetFSimPhysicalLayerFrameInMilliSeconds (uint32_t fSimPhysicalLayerFrameInMilliSeconds) |
Function for setting the F-SIM physical layer frame duration. More... | |
void | SetSlottedAlohaAllowed (bool isSlottedAlohaAllowed) |
Function for setting the status of Slotted Aloha allowance. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
NS-3 type id function. More... | |
Private Attributes | |
bool | m_crdsaAllowed |
CRDSA allowed. More... | |
double | m_crdsaBackoffProbability |
CRDSA backoff probability. More... | |
Time | m_crdsaBackoffReleaseTime |
CRDSA backoff release time. More... | |
uint32_t | m_crdsaBackoffTimeInMilliSeconds |
CRDSA backoff time. More... | |
uint32_t | m_crdsaIdleBlocksLeft |
CRDSA number of idle blocks left. More... | |
uint32_t | m_crdsaMaxConsecutiveBlocksAccessed |
CRDSA maximum number of consecutive blocks accessed. More... | |
uint32_t | m_crdsaMaxRandomizationValue |
CRDSA maximum randomization value. More... | |
uint32_t | m_crdsaMaxUniquePayloadPerBlock |
CRDSA maximum number of unique payloads per block. More... | |
uint32_t | m_crdsaMinIdleBlocks |
CRDSA minimum number of idle blocks. More... | |
uint32_t | m_crdsaMinRandomizationValue |
CRDSA minimum randomization value. More... | |
uint32_t | m_crdsaNumOfConsecutiveBlocksUsed |
CRDSA number of consecutive blocks used. More... | |
uint32_t | m_crdsaNumOfInstances |
CRDSA number of packet instances (replicas) More... | |
bool | m_essaAllowed |
ESSA allowed. More... | |
double | m_fSimBackoffProbability |
F-SIM Backoff Probability. More... | |
uint32_t | m_fSimBackoffTimeInMilliSeconds |
F-SIM Backoff Time in physical layer frame units. More... | |
uint32_t | m_fSimPhysicalLayerFrameInMilliSeconds |
F-SIM physical layer frame duration in milliseconds TODO: maybe this shouldn't be here. More... | |
bool | m_slottedAlohaAllowed |
Slotted Aloha allowed. More... | |
Class for random access allocation channel configuration.
This class holds the allocation channel specific variables and the configuration parameters used by the random access module
Definition at line 42 of file satellite-random-access-allocation-channel.h.
ns3::SatRandomAccessAllocationChannel::SatRandomAccessAllocationChannel | ( | ) |
Constructor.
Definition at line 45 of file satellite-random-access-allocation-channel.cc.
|
virtual |
Destructor.
Definition at line 67 of file satellite-random-access-allocation-channel.cc.
void ns3::SatRandomAccessAllocationChannel::DoCrdsaVariableSanityCheck | ( | ) |
Function for checking the CRDSA parameter sanity.
Definition at line 73 of file satellite-random-access-allocation-channel.cc.
References m_crdsaAllowed, m_crdsaMaxRandomizationValue, m_crdsaMinRandomizationValue, and m_crdsaNumOfInstances.
|
inline |
Function for getting the status of CRDSA allowance.
Definition at line 83 of file satellite-random-access-allocation-channel.h.
References m_crdsaAllowed.
|
inline |
Function for getting the CRDSA backoff probability.
Definition at line 192 of file satellite-random-access-allocation-channel.h.
References m_crdsaBackoffProbability.
|
inline |
Function for getting the CRDSA backoff release time.
Definition at line 165 of file satellite-random-access-allocation-channel.h.
References m_crdsaBackoffReleaseTime.
|
inline |
Function for getting the CRDSA backoff time.
Definition at line 119 of file satellite-random-access-allocation-channel.h.
References m_crdsaBackoffTimeInMilliSeconds.
|
inline |
Function for getting the CRDSA number of idle blocks left.
Definition at line 300 of file satellite-random-access-allocation-channel.h.
References m_crdsaIdleBlocksLeft.
|
inline |
Function for getting the CRDSA number of consecutive blocks accessed.
Definition at line 336 of file satellite-random-access-allocation-channel.h.
References m_crdsaMaxConsecutiveBlocksAccessed.
|
inline |
Function for getting the CRDSA maximum randomization value.
Definition at line 246 of file satellite-random-access-allocation-channel.h.
References m_crdsaMaxRandomizationValue.
|
inline |
Function for getting the CRDSA maximum number of unique payloads per block.
Definition at line 318 of file satellite-random-access-allocation-channel.h.
References m_crdsaMaxUniquePayloadPerBlock.
|
inline |
Function for getting the CRDSA minimum number of idle blocks.
Definition at line 282 of file satellite-random-access-allocation-channel.h.
References m_crdsaMinIdleBlocks.
|
inline |
Function for getting the CRDSA minimum randomization value.
Definition at line 228 of file satellite-random-access-allocation-channel.h.
References m_crdsaMinRandomizationValue.
|
inline |
Function for getting the CRDSA number of consecutive blocks used.
Definition at line 354 of file satellite-random-access-allocation-channel.h.
References m_crdsaNumOfConsecutiveBlocksUsed.
|
inline |
Function for getting the CRDSA number of packet instances (replicas)
Definition at line 264 of file satellite-random-access-allocation-channel.h.
References m_crdsaNumOfInstances.
|
inline |
Function for getting the status of ESSA allowance.
Definition at line 101 of file satellite-random-access-allocation-channel.h.
References m_essaAllowed.
|
inline |
Function for getting the F-SIM backoff probability.
Definition at line 210 of file satellite-random-access-allocation-channel.h.
References m_fSimBackoffProbability.
|
inline |
Function for getting the F-SIM backoff time.
Definition at line 137 of file satellite-random-access-allocation-channel.h.
References m_fSimBackoffTimeInMilliSeconds.
|
inline |
Function for getting the status of Slotted Aloha allowance.
Definition at line 65 of file satellite-random-access-allocation-channel.h.
References m_slottedAlohaAllowed.
|
static |
NS-3 type id function.
Definition at line 37 of file satellite-random-access-allocation-channel.cc.
|
inline |
Function for setting the status of CRDSA allowance.
isCrdsaAllowed | Is CRDSA allowed |
Definition at line 92 of file satellite-random-access-allocation-channel.h.
References m_crdsaAllowed.
|
inline |
Function for setting the CRDSA backoff probability.
crdsaBackoffProbability | CRDSA backoff probability |
Definition at line 201 of file satellite-random-access-allocation-channel.h.
References m_crdsaBackoffProbability.
|
inline |
Function for setting the CRDSA backoff release time.
crdsaBackoffReleaseTime | CRDSA backoff time |
Definition at line 183 of file satellite-random-access-allocation-channel.h.
References m_crdsaBackoffReleaseTime.
|
inline |
Function for setting the CRDSA backoff time.
crdsaBackoffTimeInMilliSeconds | CRDSA backoff time in milliseconds |
Definition at line 128 of file satellite-random-access-allocation-channel.h.
References m_crdsaBackoffTimeInMilliSeconds.
|
inline |
Function for setting the CRDSA number of idle blocks left.
idleBlocksLeft | CRDSA number of idle blocks left |
Definition at line 309 of file satellite-random-access-allocation-channel.h.
References m_crdsaIdleBlocksLeft.
|
inline |
Function for setting the CRDSA maximum number of consecutive blocks accessed.
maxConsecutiveBlocksAccessed | CRDSA maximum number of consecutive blocks accessed |
Definition at line 345 of file satellite-random-access-allocation-channel.h.
References m_crdsaMaxConsecutiveBlocksAccessed.
|
inline |
Function for setting the CRDSA maximum randomization value.
maxRandomizationValue | CRDSA maximum randomization value |
Definition at line 255 of file satellite-random-access-allocation-channel.h.
References m_crdsaMaxRandomizationValue.
|
inline |
Function for setting the CRDSA maximum number of unique payloads per block.
maxUniquePayloadPerBlock | CRDSA maximum number of unique payloads per block |
Definition at line 327 of file satellite-random-access-allocation-channel.h.
References m_crdsaMaxUniquePayloadPerBlock.
|
inline |
Function for setting the CRDSA minimum number of idle blocks.
minIdleBlocks | CRDSA minimum idle blocks |
Definition at line 291 of file satellite-random-access-allocation-channel.h.
References m_crdsaMinIdleBlocks.
|
inline |
Function for setting the CRDSA minimum randomization value.
minRandomizationValue | CRDSA minimum randomization value |
Definition at line 237 of file satellite-random-access-allocation-channel.h.
References m_crdsaMinRandomizationValue.
|
inline |
Function for setting the CRDSA number of consecutive blocks used.
numOfConsecutiveBlocksUsed | CRDSA number of consecutive blocks used |
Definition at line 363 of file satellite-random-access-allocation-channel.h.
References m_crdsaNumOfConsecutiveBlocksUsed.
|
inline |
Function for setting the CRDSA number of packet instances (replicas)
numOfInstances | CRDSA number of instances |
Definition at line 273 of file satellite-random-access-allocation-channel.h.
References m_crdsaNumOfInstances.
|
inline |
Function for setting the status of ESSA allowance.
isEssaAllowed | Is ESSA allowed |
Definition at line 110 of file satellite-random-access-allocation-channel.h.
References m_essaAllowed.
|
inline |
Function for setting the F-SIM backoff probability.
fSimPersistence | F-SIM persistence |
Definition at line 219 of file satellite-random-access-allocation-channel.h.
References m_fSimBackoffProbability.
|
inline |
Function for setting the F-SIM backoff time.
fSimBackoffTimeInFrames | F-SIM backoff time in frames |
Definition at line 155 of file satellite-random-access-allocation-channel.h.
References m_fSimBackoffTimeInMilliSeconds, and m_fSimPhysicalLayerFrameInMilliSeconds.
|
inline |
Function for setting the F-SIM backoff time.
fSimBackoffTimeInFrames | F-SIM backoff time in milliseconds |
Definition at line 146 of file satellite-random-access-allocation-channel.h.
References m_fSimBackoffTimeInMilliSeconds.
|
inline |
Function for setting the F-SIM physical layer frame duration.
fSimPhysicalLayerFrameInMilliSeconds | F-SIM physical layer frame in milliseconds |
Definition at line 174 of file satellite-random-access-allocation-channel.h.
References m_fSimPhysicalLayerFrameInMilliSeconds.
|
inline |
Function for setting the status of Slotted Aloha allowance.
isSlottedAlohaAllowed | Is Slotted Aloha allowed |
Definition at line 74 of file satellite-random-access-allocation-channel.h.
References m_slottedAlohaAllowed.
|
private |
CRDSA allowed.
Definition at line 382 of file satellite-random-access-allocation-channel.h.
Referenced by DoCrdsaVariableSanityCheck(), GetCrdsaAllowed(), and SetCrdsaAllowed().
|
private |
CRDSA backoff probability.
Definition at line 422 of file satellite-random-access-allocation-channel.h.
Referenced by GetCrdsaBackoffProbability(), and SetCrdsaBackoffProbability().
|
private |
CRDSA backoff release time.
Definition at line 442 of file satellite-random-access-allocation-channel.h.
Referenced by GetCrdsaBackoffReleaseTime(), and SetCrdsaBackoffReleaseTime().
|
private |
CRDSA backoff time.
Definition at line 417 of file satellite-random-access-allocation-channel.h.
Referenced by GetCrdsaBackoffTimeInMilliSeconds(), and SetCrdsaBackoffTimeInMilliSeconds().
|
private |
CRDSA number of idle blocks left.
Definition at line 412 of file satellite-random-access-allocation-channel.h.
Referenced by GetCrdsaIdleBlocksLeft(), and SetCrdsaIdleBlocksLeft().
|
private |
CRDSA maximum number of consecutive blocks accessed.
Definition at line 432 of file satellite-random-access-allocation-channel.h.
Referenced by GetCrdsaMaxConsecutiveBlocksAccessed(), and SetCrdsaMaxConsecutiveBlocksAccessed().
|
private |
CRDSA maximum randomization value.
Definition at line 397 of file satellite-random-access-allocation-channel.h.
Referenced by DoCrdsaVariableSanityCheck(), GetCrdsaMaxRandomizationValue(), and SetCrdsaMaxRandomizationValue().
|
private |
CRDSA maximum number of unique payloads per block.
Definition at line 427 of file satellite-random-access-allocation-channel.h.
Referenced by GetCrdsaMaxUniquePayloadPerBlock(), and SetCrdsaMaxUniquePayloadPerBlock().
|
private |
CRDSA minimum number of idle blocks.
Definition at line 407 of file satellite-random-access-allocation-channel.h.
Referenced by GetCrdsaMinIdleBlocks(), and SetCrdsaMinIdleBlocks().
|
private |
CRDSA minimum randomization value.
Definition at line 392 of file satellite-random-access-allocation-channel.h.
Referenced by DoCrdsaVariableSanityCheck(), GetCrdsaMinRandomizationValue(), and SetCrdsaMinRandomizationValue().
|
private |
CRDSA number of consecutive blocks used.
Definition at line 437 of file satellite-random-access-allocation-channel.h.
Referenced by GetCrdsaNumOfConsecutiveBlocksUsed(), and SetCrdsaNumOfConsecutiveBlocksUsed().
|
private |
CRDSA number of packet instances (replicas)
Definition at line 402 of file satellite-random-access-allocation-channel.h.
Referenced by DoCrdsaVariableSanityCheck(), GetCrdsaNumOfInstances(), and SetCrdsaNumOfInstances().
|
private |
ESSA allowed.
Definition at line 387 of file satellite-random-access-allocation-channel.h.
Referenced by GetEssaAllowed(), and SetEssaAllowed().
|
private |
F-SIM Backoff Probability.
Definition at line 452 of file satellite-random-access-allocation-channel.h.
Referenced by GetFSimBackoffProbability(), and SetFSimBackoffProbability().
|
private |
F-SIM Backoff Time in physical layer frame units.
Definition at line 447 of file satellite-random-access-allocation-channel.h.
Referenced by GetFSimBackoffTimeInMilliSeconds(), SetFSimBackoffTimeInFrames(), and SetFSimBackoffTimeInMilliSeconds().
|
private |
F-SIM physical layer frame duration in milliseconds TODO: maybe this shouldn't be here.
Definition at line 458 of file satellite-random-access-allocation-channel.h.
Referenced by SetFSimBackoffTimeInFrames(), and SetFSimPhysicalLayerFrameInMilliSeconds().
|
private |
Slotted Aloha allowed.
Definition at line 377 of file satellite-random-access-allocation-channel.h.
Referenced by GetSlottedAlohaAllowed(), and SetSlottedAlohaAllowed().