The SatLowerLayerServiceConf class holds information of all configures lower layer service entries. More...

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

Inheritance diagram for ns3::SatLowerLayerServiceConf:

Collaboration diagram for ns3::SatLowerLayerServiceConf:

Public Member Functions
	SatLowerLayerServiceConf ()
	Constructor for SatLowerLayerServiceConf.
	~SatLowerLayerServiceConf ()
	Destructor for SatLowerLayerServiceConf.
bool	GetDaConstantAssignmentProvided (uint8_t index) const
	Get state, if constant assignment is provided for a DA service.
uint16_t	GetDaConstantServiceRateInKbps (uint8_t index) const
	Get constant service rate for a DA service.
Ptr< RandomVariableStream >	GetDaConstantServiceRateStream (uint8_t index) const
	Get constant service rate stream for a DA service.
uint16_t	GetDaMaximumBacklogInKbytes (uint8_t index) const
	Get maximum backlog size for a DA service.
uint16_t	GetDaMaximumServiceRateInKbps (uint8_t index) const
	Get maximum service rate for a DA service.
uint16_t	GetDaMinimumServiceRateInKbps (uint8_t index) const
	Get minimum service rate for a DA service.
bool	GetDaRbdcAllowed (uint8_t index) const
	Get state, if RBDC is allowed for a DA service.
uint8_t	GetDaServiceCount () const
	Get count of configured DA services.
bool	GetDaVolumeAllowed (uint8_t index) const
	Get state, if volume is allowed for a DA service.
Time	GetDefaultControlRandomizationInterval () const
	Get configured default control randomization interval.
uint8_t	GetDynamicRatePersistence () const
	Get configured dynamic rate persistence.
double	GetRaAverageNormalizedOfferedLoadThreshold (uint8_t index) const
	Get average normalized offeredLoad Threshold.
uint16_t	GetRaBackOffProbability (uint8_t index) const
	Get back off probability.
uint16_t	GetRaBackOffTimeInMilliSeconds (uint8_t index) const
	Get back off time in milliseconds.
uint8_t	GetRaDefaultService () const
	Get index of default RA service.
uint16_t	GetRaHighLoadBackOffProbability (uint8_t index) const
	Get high load back off probability.
uint16_t	GetRaHighLoadBackOffTimeInMilliSeconds (uint8_t index) const
	Get high load back off time in milliseconds.
bool	GetRaIsCrdsaAllowed (uint8_t index) const
	Get CRDSA allowance.
bool	GetRaIsEssaAllowed (uint8_t index) const
	Get E-SSA allowance.
bool	GetRaIsSlottedAlohaAllowed (uint8_t index) const
	Get Slotted Aloha allowance.
uint8_t	GetRaMaximumConsecutiveBlockAccessed (uint8_t index) const
	Get maximum consecutive block accessed for a RA service.
uint8_t	GetRaMaximumUniquePayloadPerBlock (uint8_t index) const
	Get maximum unique payload per block for a RA service.
uint8_t	GetRaMinimumIdleBlock (uint8_t index) const
	Get minimum idle block for a RA service.
uint8_t	GetRaNumberOfInstances (uint8_t index) const
	Get number of instances.
uint8_t	GetRaServiceCount () const
	Get count of configured RA services.
uint8_t	GetVolumeBacklogPersistence () const
	Get configured volume backlog persistence.

Static Public Member Functions
static TypeId	GetTypeId (void)
	methods derived from base classes

Static Public Attributes
static const uint8_t	m_maxDaServiceEntries = 4
static const uint8_t	m_maxRaServiceEntries = 3
static const uint8_t	m_minDaServiceEntries = 2
static const uint8_t	m_minRaServiceEntries = 1

Private Member Functions
	SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE (0)
	SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE (1)
	SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE (2)
	SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE (3)
	SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE (0)
	SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE (1)
	SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE (2)
void	SetDaConstantAssignmentProvided (uint8_t index, bool constAssignmentProvided)
	Set state, if constant assignment is provided for a DA service.
void	SetDaConstantServiceRateStream (uint8_t index, Ptr< RandomVariableStream > constantServiceRateStream)
	Set constant service rate stream for a DA service.
void	SetDaMaximumBacklogInKbytes (uint8_t index, uint16_t maximumBacklogInKbytes)
	Set maximum backlog size for a DA service.
void	SetDaMaximumServiceRateInKbps (uint8_t index, uint16_t maximumServiceRateKbps)
	Set maximum service rate for a DA service.
void	SetDaMinimumServiceRateInKbps (uint8_t index, uint16_t minimumServiceRateKbps)
	Set minimum service rate for a DA service.
void	SetDaRbdcAllowed (uint8_t index, bool bdcAllowed)
	Set state, if RBDC is allowed for a DA service.
void	SetDaVolumeAllowed (uint8_t index, bool volumeAllowed)
	Set state, if volume is allowed for a DA service.
void	SetRaAverageNormalizedOfferedLoadThreshold (uint8_t index, double averageNormalizedOfferedLoadThreshold)
	Set average normalized offeredLoad Threshold.
void	SetRaBackOffProbability (uint8_t index, uint16_t backOffProbability)
	Set back off probability.
void	SetRaBackOffTimeInMilliSeconds (uint8_t index, uint16_t backOffTimeInMilliSeconds)
	Set back off time in milliseconds.
void	SetRaHighLoadBackOffProbability (uint8_t index, uint16_t highLoadBackOffProbability)
	Set high load back off probability.
void	SetRaHighLoadBackOffTimeInMilliSeconds (uint8_t index, uint16_t backOffTimeInMilliSeconds)
	Set high load back off time in milliseconds.
void	SetRaIsCrdsaAllowed (uint8_t index, bool isCrdsaAllowed)
	Set CRDSA allowance.
void	SetRaIsEssaAllowed (uint8_t index, bool isEssaAllowed)
	Set ESSA allowance.
void	SetRaIsSlottedAlohaAllowed (uint8_t index, bool isSlottedAlohaAllowed)
	Set Slotted Aloha allowance.
void	SetRaMaximumConsecutiveBlockAccessed (uint8_t index, uint8_t maxConsecutiveBlockAccessed)
	Set maximum consecutive block accessed for a RA service.
void	SetRaMaximumUniquePayloadPerBlock (uint8_t index, uint8_t maxUniquePayloadPerBlock)
	Set maximum unique payload per block for a RA service.
void	SetRaMinimumIdleBlock (uint8_t index, uint8_t minimumIdleBlock)
	Set minimum idle block for a RA service.
void	SetRaNumberOfInstances (uint8_t index, uint8_t numberOfInstances)
	Set number of instances.

Static Private Member Functions
static std::string	GetIndexAsDaServiceName (uint8_t index)
	Method to convert DA service index to service name.
static std::string	GetIndexAsRaServiceName (uint8_t index)
	Method to convert RA service index to service name.
template<class T>
static std::string	GetNumberAsString (T number)
	Template method to convert number to string.

Private Attributes
SatLowerLayerServiceDaEntry	m_daServiceEntries [m_maxDaServiceEntries]
uint8_t	m_daServiceEntryCount
Time	m_defaultControlRandomizationInterval
uint8_t	m_dynamicRatePersistence
SatLowerLayerServiceRaEntry	m_raServiceEntries [m_maxRaServiceEntries]
uint8_t	m_raServiceEntryCount
uint8_t	m_raServiceIndexDefault
uint8_t	m_volumeBacklogPersistence

Detailed Description

The SatLowerLayerServiceConf class holds information of all configures lower layer service entries.

This class is only used by SatLowerLayerServiceConf class.

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

Constructor & Destructor Documentation

◆ SatLowerLayerServiceConf()

ns3::SatLowerLayerServiceConf::SatLowerLayerServiceConf ( )

Constructor for SatLowerLayerServiceConf.

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

References m_daServiceEntryCount, m_defaultControlRandomizationInterval, m_dynamicRatePersistence, m_maxDaServiceEntries, m_maxRaServiceEntries, m_minDaServiceEntries, m_minRaServiceEntries, m_raServiceEntryCount, and m_volumeBacklogPersistence.

◆ ~SatLowerLayerServiceConf()

ns3::SatLowerLayerServiceConf::~SatLowerLayerServiceConf ( )

Destructor for SatLowerLayerServiceConf.

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

Member Function Documentation

◆ GetDaConstantAssignmentProvided()

bool ns3::SatLowerLayerServiceConf::GetDaConstantAssignmentProvided ( uint8_t index ) const

Get state, if constant assignment is provided for a DA service.

Parameters

index Index of the service

Returns: Is constant assignment provided [true or false]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ GetDaConstantServiceRateInKbps()

uint16_t ns3::SatLowerLayerServiceConf::GetDaConstantServiceRateInKbps ( uint8_t index ) const

Get constant service rate for a DA service.

Parameters

index Index of the service

Returns: Constant service rate [KBps]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ GetDaConstantServiceRateStream()

Ptr< RandomVariableStream > ns3::SatLowerLayerServiceConf::GetDaConstantServiceRateStream ( uint8_t index ) const

Get constant service rate stream for a DA service.

Parameters

index Index of the service

Returns: Constant service rate stream [KBps]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ GetDaMaximumBacklogInKbytes()

uint16_t ns3::SatLowerLayerServiceConf::GetDaMaximumBacklogInKbytes ( uint8_t index ) const

Get maximum backlog size for a DA service.

Parameters

index Index of the service

Returns: Maximum backlog size [KBytes]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ GetDaMaximumServiceRateInKbps()

uint16_t ns3::SatLowerLayerServiceConf::GetDaMaximumServiceRateInKbps ( uint8_t index ) const

Get maximum service rate for a DA service.

Parameters

index Index of the service

Returns: Maximum service rate [KBps]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ GetDaMinimumServiceRateInKbps()

uint16_t ns3::SatLowerLayerServiceConf::GetDaMinimumServiceRateInKbps ( uint8_t index ) const

Get minimum service rate for a DA service.

Parameters

index Index of the service

Returns: Minimum service rate [KBps]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ GetDaRbdcAllowed()

bool ns3::SatLowerLayerServiceConf::GetDaRbdcAllowed ( uint8_t index ) const

Get state, if RBDC is allowed for a DA service.

Parameters

index Index of the service

Returns: Is RBDC allowed [true or false]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ GetDaServiceCount()

uint8_t ns3::SatLowerLayerServiceConf::GetDaServiceCount ( ) const

inline

Get count of configured DA services.

Returns: count of configured DA services.

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

References m_daServiceEntryCount.

◆ GetDaVolumeAllowed()

bool ns3::SatLowerLayerServiceConf::GetDaVolumeAllowed ( uint8_t index ) const

Get state, if volume is allowed for a DA service.

Parameters

index Index of the service

Returns: Is volume allowed [true or false]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ GetDefaultControlRandomizationInterval()

Time ns3::SatLowerLayerServiceConf::GetDefaultControlRandomizationInterval ( ) const

inline

Get configured default control randomization interval.

Returns: Default control randomization interval

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

References m_defaultControlRandomizationInterval.

◆ GetDynamicRatePersistence()

uint8_t ns3::SatLowerLayerServiceConf::GetDynamicRatePersistence ( ) const

inline

Get configured dynamic rate persistence.

Returns: Dynamic rate persistence

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

References m_dynamicRatePersistence.

◆ GetIndexAsDaServiceName()

std::string ns3::SatLowerLayerServiceConf::GetIndexAsDaServiceName ( uint8_t index )

staticprivate

Method to convert DA service index to service name.

Parameters

index index to convert as service name

Returns: service name

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

References GetNumberAsString().

Here is the call graph for this function:

◆ GetIndexAsRaServiceName()

std::string ns3::SatLowerLayerServiceConf::GetIndexAsRaServiceName ( uint8_t index )

staticprivate

Method to convert RA service index to service name.

Parameters

index index to convert as service name

Returns: service name

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

References GetNumberAsString().

Here is the call graph for this function:

◆ GetNumberAsString()

template<class T>

std::string ns3::SatLowerLayerServiceConf::GetNumberAsString ( T number )

inlinestaticprivate

Template method to convert number to string.

Parameters

number number to convert as string

Returns: number as string

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

Referenced by GetIndexAsDaServiceName(), and GetIndexAsRaServiceName().

Here is the caller graph for this function:

◆ GetRaAverageNormalizedOfferedLoadThreshold()

double ns3::SatLowerLayerServiceConf::GetRaAverageNormalizedOfferedLoadThreshold ( uint8_t index ) const

Get average normalized offeredLoad Threshold.

Parameters

index Index of the service

Returns: Average normalized offered load threshold

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

References m_maxRaServiceEntries, and m_raServiceEntries.

Referenced by ns3::SatBeamHelper::NotifyConstructionCompleted().

Here is the caller graph for this function:

◆ GetRaBackOffProbability()

uint16_t ns3::SatLowerLayerServiceConf::GetRaBackOffProbability ( uint8_t index ) const

Get back off probability.

Parameters

index Index of the service

Returns: Back off probability

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

References m_maxRaServiceEntries, and m_raServiceEntries.

Referenced by ns3::SatBeamHelper::NotifyConstructionCompleted().

Here is the caller graph for this function:

◆ GetRaBackOffTimeInMilliSeconds()

uint16_t ns3::SatLowerLayerServiceConf::GetRaBackOffTimeInMilliSeconds ( uint8_t index ) const

Get back off time in milliseconds.

Parameters

index Index of the service

Returns: Back off time

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

References m_maxRaServiceEntries, and m_raServiceEntries.

Referenced by ns3::SatBeamHelper::NotifyConstructionCompleted().

Here is the caller graph for this function:

◆ GetRaDefaultService()

uint8_t ns3::SatLowerLayerServiceConf::GetRaDefaultService ( ) const

inline

Get index of default RA service.

Returns: index of default RA service.

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

References m_raServiceIndexDefault.

◆ GetRaHighLoadBackOffProbability()

uint16_t ns3::SatLowerLayerServiceConf::GetRaHighLoadBackOffProbability ( uint8_t index ) const

Get high load back off probability.

Parameters

index Index of the service

Returns: High load back off probability

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

References m_maxRaServiceEntries, and m_raServiceEntries.

Referenced by ns3::SatBeamHelper::NotifyConstructionCompleted().

Here is the caller graph for this function:

◆ GetRaHighLoadBackOffTimeInMilliSeconds()

uint16_t ns3::SatLowerLayerServiceConf::GetRaHighLoadBackOffTimeInMilliSeconds ( uint8_t index ) const

Get high load back off time in milliseconds.

Parameters

index Index of the service

Returns: Back off time

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

References m_maxRaServiceEntries, and m_raServiceEntries.

Referenced by ns3::SatBeamHelper::NotifyConstructionCompleted().

Here is the caller graph for this function:

◆ GetRaIsCrdsaAllowed()

bool ns3::SatLowerLayerServiceConf::GetRaIsCrdsaAllowed ( uint8_t index ) const

Get CRDSA allowance.

Parameters

index Index of the service

Returns: Is CRDSA allowed

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ GetRaIsEssaAllowed()

bool ns3::SatLowerLayerServiceConf::GetRaIsEssaAllowed ( uint8_t index ) const

Get E-SSA allowance.

Parameters

index Index of the service

Returns: Is E-SSA allowed

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ GetRaIsSlottedAlohaAllowed()

bool ns3::SatLowerLayerServiceConf::GetRaIsSlottedAlohaAllowed ( uint8_t index ) const

Get Slotted Aloha allowance.

Parameters

index Index of the service

Returns: Is Slotted Aloha allowed

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ GetRaMaximumConsecutiveBlockAccessed()

uint8_t ns3::SatLowerLayerServiceConf::GetRaMaximumConsecutiveBlockAccessed ( uint8_t index ) const

Get maximum consecutive block accessed for a RA service.

Parameters

index Index of the service

Returns: Maximum consecutive block accessed

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ GetRaMaximumUniquePayloadPerBlock()

uint8_t ns3::SatLowerLayerServiceConf::GetRaMaximumUniquePayloadPerBlock ( uint8_t index ) const

Get maximum unique payload per block for a RA service.

Parameters

index Index of the service

Returns: Maximum unique payload per block

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ GetRaMinimumIdleBlock()

uint8_t ns3::SatLowerLayerServiceConf::GetRaMinimumIdleBlock ( uint8_t index ) const

Get minimum idle block for a RA service.

Parameters

index Index of the service

Returns: Minimum idle block

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ GetRaNumberOfInstances()

uint8_t ns3::SatLowerLayerServiceConf::GetRaNumberOfInstances ( uint8_t index ) const

Get number of instances.

Parameters

index Index of the service

Returns: Number of instances

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ GetRaServiceCount()

uint8_t ns3::SatLowerLayerServiceConf::GetRaServiceCount ( ) const

inline

Get count of configured RA services.

Returns: count of configured RA services.

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

References m_raServiceEntryCount.

◆ GetTypeId()

TypeId ns3::SatLowerLayerServiceConf::GetTypeId ( void )

static

methods derived from base classes

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

References m_daServiceEntryCount, m_defaultControlRandomizationInterval, m_dynamicRatePersistence, m_maxDaServiceEntries, m_maxRaServiceEntries, m_minDaServiceEntries, m_minRaServiceEntries, m_raServiceEntryCount, m_raServiceIndexDefault, and m_volumeBacklogPersistence.

◆ GetVolumeBacklogPersistence()

uint8_t ns3::SatLowerLayerServiceConf::GetVolumeBacklogPersistence ( ) const

inline

Get configured volume backlog persistence.

Returns: Volume backlog persistence

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

References m_volumeBacklogPersistence.

◆ SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [1/4]

ns3::SatLowerLayerServiceConf::SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE ( 0 )

private

◆ SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [2/4]

ns3::SatLowerLayerServiceConf::SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE ( 1 )

private

◆ SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [3/4]

ns3::SatLowerLayerServiceConf::SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE ( 2 )

private

◆ SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [4/4]

ns3::SatLowerLayerServiceConf::SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE ( 3 )

private

◆ SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [1/3]

ns3::SatLowerLayerServiceConf::SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE ( 0 )

private

◆ SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [2/3]

ns3::SatLowerLayerServiceConf::SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE ( 1 )

private

◆ SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [3/3]

ns3::SatLowerLayerServiceConf::SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE ( 2 )

private

◆ SetDaConstantAssignmentProvided()

void ns3::SatLowerLayerServiceConf::SetDaConstantAssignmentProvided	(	uint8_t	index,
		bool	constAssignmentProvided )

private

Set state, if constant assignment is provided for a DA service.

Parameters

index	Index of the service
constAssignmentProvided	Constant assignment provided state [true or false]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ SetDaConstantServiceRateStream()

void ns3::SatLowerLayerServiceConf::SetDaConstantServiceRateStream	(	uint8_t	index,
		Ptr< RandomVariableStream >	constantServiceRateStream )

private

Set constant service rate stream for a DA service.

Parameters

index	Index of the service
constantServiceRateStream	Constant service rate stream [KBps]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ SetDaMaximumBacklogInKbytes()

void ns3::SatLowerLayerServiceConf::SetDaMaximumBacklogInKbytes	(	uint8_t	index,
		uint16_t	maximumBacklogInKbytes )

private

Set maximum backlog size for a DA service.

Parameters

index	Index of the service
maximumBacklogInKbytes	Maximum backlog size [KBytes]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ SetDaMaximumServiceRateInKbps()

void ns3::SatLowerLayerServiceConf::SetDaMaximumServiceRateInKbps	(	uint8_t	index,
		uint16_t	maximumServiceRateKbps )

private

Set maximum service rate for a DA service.

Parameters

index	Index of the service
maximumServiceRateKbps	Maximum service rate [KBps]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ SetDaMinimumServiceRateInKbps()

void ns3::SatLowerLayerServiceConf::SetDaMinimumServiceRateInKbps	(	uint8_t	index,
		uint16_t	minimumServiceRateKbps )

private

Set minimum service rate for a DA service.

Parameters

index	Index of the service
minimumServiceRateKbps	Minimum service rate [KBps]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ SetDaRbdcAllowed()

void ns3::SatLowerLayerServiceConf::SetDaRbdcAllowed	(	uint8_t	index,
		bool	bdcAllowed )

private

Set state, if RBDC is allowed for a DA service.

Parameters

index	Index of the service
bdcAllowed	RBDC allowed state [true or false]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ SetDaVolumeAllowed()

void ns3::SatLowerLayerServiceConf::SetDaVolumeAllowed	(	uint8_t	index,
		bool	volumeAllowed )

private

Set state, if volume is allowed for a DA service.

Parameters

index	Index of the service
volumeAllowed	Volume allowed state [true or false]

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

References m_daServiceEntries, and m_maxDaServiceEntries.

◆ SetRaAverageNormalizedOfferedLoadThreshold()

void ns3::SatLowerLayerServiceConf::SetRaAverageNormalizedOfferedLoadThreshold	(	uint8_t	index,
		double	averageNormalizedOfferedLoadThreshold )

private

Set average normalized offeredLoad Threshold.

Parameters

index	Index of the service
Average	normalized offered load threshold

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaBackOffProbability()

void ns3::SatLowerLayerServiceConf::SetRaBackOffProbability	(	uint8_t	index,
		uint16_t	backOffProbability )

private

Set back off probability.

Parameters

index	Index of the service
backOffProbability	Back off probability

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaBackOffTimeInMilliSeconds()

void ns3::SatLowerLayerServiceConf::SetRaBackOffTimeInMilliSeconds	(	uint8_t	index,
		uint16_t	backOffTimeInMilliSeconds )

private

Set back off time in milliseconds.

Parameters

index	Index of the service
backOffTimeInMilliSeconds	Back off time

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaHighLoadBackOffProbability()

void ns3::SatLowerLayerServiceConf::SetRaHighLoadBackOffProbability	(	uint8_t	index,
		uint16_t	highLoadBackOffProbability )

private

Set high load back off probability.

Parameters

index	Index of the service
highLoadBackOffProbability	High load back off probability

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaHighLoadBackOffTimeInMilliSeconds()

void ns3::SatLowerLayerServiceConf::SetRaHighLoadBackOffTimeInMilliSeconds	(	uint8_t	index,
		uint16_t	backOffTimeInMilliSeconds )

private

Set high load back off time in milliseconds.

Parameters

index	Index of the service
backOffTimeInMilliSeconds	Back off time

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaIsCrdsaAllowed()

void ns3::SatLowerLayerServiceConf::SetRaIsCrdsaAllowed	(	uint8_t	index,
		bool	isCrdsaAllowed )

private

Set CRDSA allowance.

Parameters

index	Index of the service
isCrdsaAllowed	Is CRDSA allowed

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaIsEssaAllowed()

void ns3::SatLowerLayerServiceConf::SetRaIsEssaAllowed	(	uint8_t	index,
		bool	isEssaAllowed )

private

Set ESSA allowance.

Parameters

index	Index of the service
isEssaAllowed	Is ESSA allowed

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaIsSlottedAlohaAllowed()

void ns3::SatLowerLayerServiceConf::SetRaIsSlottedAlohaAllowed	(	uint8_t	index,
		bool	isSlottedAlohaAllowed )

private

Set Slotted Aloha allowance.

Parameters

index	Index of the service
isSlottedAlohaAllowed	Is Slotted Aloha allowed

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaMaximumConsecutiveBlockAccessed()

void ns3::SatLowerLayerServiceConf::SetRaMaximumConsecutiveBlockAccessed	(	uint8_t	index,
		uint8_t	maxConsecutiveBlockAccessed )

private

Set maximum consecutive block accessed for a RA service.

Parameters

index	Index of the service
maxConsecutiveBlockAccessed	Maximum consecutive block accessed

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaMaximumUniquePayloadPerBlock()

void ns3::SatLowerLayerServiceConf::SetRaMaximumUniquePayloadPerBlock	(	uint8_t	index,
		uint8_t	maxUniquePayloadPerBlock )

private

Set maximum unique payload per block for a RA service.

Parameters

index	Index of the service
maxUniquePayloadPerBlock	Maximum unique payload per block

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaMinimumIdleBlock()

void ns3::SatLowerLayerServiceConf::SetRaMinimumIdleBlock	(	uint8_t	index,
		uint8_t	minimumIdleBlock )

private

Set minimum idle block for a RA service.

Parameters

index	Index of the service
minimumIdleBlock	Minimum idle block

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

References m_maxRaServiceEntries, and m_raServiceEntries.

◆ SetRaNumberOfInstances()

void ns3::SatLowerLayerServiceConf::SetRaNumberOfInstances	(	uint8_t	index,
		uint8_t	numberOfInstances )

private

Set number of instances.

Parameters

index	Index of the service
numberOfInstances	Number of instances

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

References m_maxRaServiceEntries, and m_raServiceEntries.

Member Data Documentation

◆ m_daServiceEntries

SatLowerLayerServiceDaEntry ns3::SatLowerLayerServiceConf::m_daServiceEntries[m_maxDaServiceEntries]

private

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

Referenced by GetDaConstantAssignmentProvided(), GetDaConstantServiceRateInKbps(), GetDaConstantServiceRateStream(), GetDaMaximumBacklogInKbytes(), GetDaMaximumServiceRateInKbps(), GetDaMinimumServiceRateInKbps(), GetDaRbdcAllowed(), GetDaVolumeAllowed(), SetDaConstantAssignmentProvided(), SetDaConstantServiceRateStream(), SetDaMaximumBacklogInKbytes(), SetDaMaximumServiceRateInKbps(), SetDaMinimumServiceRateInKbps(), SetDaRbdcAllowed(), and SetDaVolumeAllowed().

◆ m_daServiceEntryCount

uint8_t ns3::SatLowerLayerServiceConf::m_daServiceEntryCount

private

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

Referenced by SatLowerLayerServiceConf(), GetDaServiceCount(), and GetTypeId().

◆ m_defaultControlRandomizationInterval

Time ns3::SatLowerLayerServiceConf::m_defaultControlRandomizationInterval

private

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

Referenced by SatLowerLayerServiceConf(), GetDefaultControlRandomizationInterval(), and GetTypeId().

◆ m_dynamicRatePersistence

uint8_t ns3::SatLowerLayerServiceConf::m_dynamicRatePersistence

private

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

Referenced by SatLowerLayerServiceConf(), GetDynamicRatePersistence(), and GetTypeId().

◆ m_maxDaServiceEntries

const uint8_t ns3::SatLowerLayerServiceConf::m_maxDaServiceEntries = 4

static

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

Referenced by SatLowerLayerServiceConf(), GetDaConstantAssignmentProvided(), GetDaConstantServiceRateInKbps(), GetDaConstantServiceRateStream(), GetDaMaximumBacklogInKbytes(), GetDaMaximumServiceRateInKbps(), GetDaMinimumServiceRateInKbps(), GetDaRbdcAllowed(), GetDaVolumeAllowed(), GetTypeId(), SetDaConstantAssignmentProvided(), SetDaConstantServiceRateStream(), SetDaMaximumBacklogInKbytes(), SetDaMaximumServiceRateInKbps(), SetDaMinimumServiceRateInKbps(), SetDaRbdcAllowed(), and SetDaVolumeAllowed().

◆ m_maxRaServiceEntries

const uint8_t ns3::SatLowerLayerServiceConf::m_maxRaServiceEntries = 3

static

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

Referenced by SatLowerLayerServiceConf(), GetRaAverageNormalizedOfferedLoadThreshold(), GetRaBackOffProbability(), GetRaBackOffTimeInMilliSeconds(), GetRaHighLoadBackOffProbability(), GetRaHighLoadBackOffTimeInMilliSeconds(), GetRaIsCrdsaAllowed(), GetRaIsEssaAllowed(), GetRaIsSlottedAlohaAllowed(), GetRaMaximumConsecutiveBlockAccessed(), GetRaMaximumUniquePayloadPerBlock(), GetRaMinimumIdleBlock(), GetRaNumberOfInstances(), GetTypeId(), SetRaAverageNormalizedOfferedLoadThreshold(), SetRaBackOffProbability(), SetRaBackOffTimeInMilliSeconds(), SetRaHighLoadBackOffProbability(), SetRaHighLoadBackOffTimeInMilliSeconds(), SetRaIsCrdsaAllowed(), SetRaIsEssaAllowed(), SetRaIsSlottedAlohaAllowed(), SetRaMaximumConsecutiveBlockAccessed(), SetRaMaximumUniquePayloadPerBlock(), SetRaMinimumIdleBlock(), and SetRaNumberOfInstances().

◆ m_minDaServiceEntries

const uint8_t ns3::SatLowerLayerServiceConf::m_minDaServiceEntries = 2

static

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

Referenced by SatLowerLayerServiceConf(), and GetTypeId().

◆ m_minRaServiceEntries

const uint8_t ns3::SatLowerLayerServiceConf::m_minRaServiceEntries = 1

static

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

Referenced by SatLowerLayerServiceConf(), and GetTypeId().

◆ m_raServiceEntries

SatLowerLayerServiceRaEntry ns3::SatLowerLayerServiceConf::m_raServiceEntries[m_maxRaServiceEntries]

private

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

Referenced by GetRaAverageNormalizedOfferedLoadThreshold(), GetRaBackOffProbability(), GetRaBackOffTimeInMilliSeconds(), GetRaHighLoadBackOffProbability(), GetRaHighLoadBackOffTimeInMilliSeconds(), GetRaIsCrdsaAllowed(), GetRaIsEssaAllowed(), GetRaIsSlottedAlohaAllowed(), GetRaMaximumConsecutiveBlockAccessed(), GetRaMaximumUniquePayloadPerBlock(), GetRaMinimumIdleBlock(), GetRaNumberOfInstances(), SetRaAverageNormalizedOfferedLoadThreshold(), SetRaBackOffProbability(), SetRaBackOffTimeInMilliSeconds(), SetRaHighLoadBackOffProbability(), SetRaHighLoadBackOffTimeInMilliSeconds(), SetRaIsCrdsaAllowed(), SetRaIsEssaAllowed(), SetRaIsSlottedAlohaAllowed(), SetRaMaximumConsecutiveBlockAccessed(), SetRaMaximumUniquePayloadPerBlock(), SetRaMinimumIdleBlock(), and SetRaNumberOfInstances().

◆ m_raServiceEntryCount

uint8_t ns3::SatLowerLayerServiceConf::m_raServiceEntryCount

private

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

Referenced by SatLowerLayerServiceConf(), GetRaServiceCount(), and GetTypeId().

◆ m_raServiceIndexDefault

uint8_t ns3::SatLowerLayerServiceConf::m_raServiceIndexDefault

private

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

Referenced by GetRaDefaultService(), and GetTypeId().

◆ m_volumeBacklogPersistence

uint8_t ns3::SatLowerLayerServiceConf::m_volumeBacklogPersistence

private

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

Referenced by SatLowerLayerServiceConf(), GetTypeId(), and GetVolumeBacklogPersistence().

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

/builds/sns3/satellite/satellite/model/satellite-lower-layer-service.h
/builds/sns3/satellite/satellite/model/satellite-lower-layer-service.cc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SatLowerLayerServiceConf()

◆ ~SatLowerLayerServiceConf()

Member Function Documentation

◆ GetDaConstantAssignmentProvided()

◆ GetDaConstantServiceRateInKbps()

◆ GetDaConstantServiceRateStream()

◆ GetDaMaximumBacklogInKbytes()

◆ GetDaMaximumServiceRateInKbps()

◆ GetDaMinimumServiceRateInKbps()

◆ GetDaRbdcAllowed()

◆ GetDaServiceCount()

◆ GetDaVolumeAllowed()

◆ GetDefaultControlRandomizationInterval()

◆ GetDynamicRatePersistence()

◆ GetIndexAsDaServiceName()

◆ GetIndexAsRaServiceName()

◆ GetNumberAsString()

◆ GetRaAverageNormalizedOfferedLoadThreshold()

◆ GetRaBackOffProbability()

◆ GetRaBackOffTimeInMilliSeconds()

◆ GetRaDefaultService()

◆ GetRaHighLoadBackOffProbability()

◆ GetRaHighLoadBackOffTimeInMilliSeconds()

◆ GetRaIsCrdsaAllowed()

◆ GetRaIsEssaAllowed()

◆ GetRaIsSlottedAlohaAllowed()

◆ GetRaMaximumConsecutiveBlockAccessed()

◆ GetRaMaximumUniquePayloadPerBlock()

◆ GetRaMinimumIdleBlock()

◆ GetRaNumberOfInstances()

◆ GetRaServiceCount()

◆ GetTypeId()

◆ GetVolumeBacklogPersistence()

◆ SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [1/4]

◆ SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [2/4]

◆ SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [3/4]

◆ SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [4/4]

◆ SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [1/3]

◆ SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [2/3]

◆ SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE() [3/3]

◆ SetDaConstantAssignmentProvided()

◆ SetDaConstantServiceRateStream()

◆ SetDaMaximumBacklogInKbytes()

◆ SetDaMaximumServiceRateInKbps()

◆ SetDaMinimumServiceRateInKbps()

◆ SetDaRbdcAllowed()

◆ SetDaVolumeAllowed()

◆ SetRaAverageNormalizedOfferedLoadThreshold()

◆ SetRaBackOffProbability()

◆ SetRaBackOffTimeInMilliSeconds()

◆ SetRaHighLoadBackOffProbability()

◆ SetRaHighLoadBackOffTimeInMilliSeconds()

◆ SetRaIsCrdsaAllowed()

◆ SetRaIsEssaAllowed()

◆ SetRaIsSlottedAlohaAllowed()

◆ SetRaMaximumConsecutiveBlockAccessed()

◆ SetRaMaximumUniquePayloadPerBlock()

◆ SetRaMinimumIdleBlock()

◆ SetRaNumberOfInstances()

Member Data Documentation

◆ m_daServiceEntries

◆ m_daServiceEntryCount

◆ m_defaultControlRandomizationInterval

◆ m_dynamicRatePersistence

◆ m_maxDaServiceEntries

◆ m_maxRaServiceEntries

◆ m_minDaServiceEntries

◆ m_minRaServiceEntries

◆ m_raServiceEntries

◆ m_raServiceEntryCount

◆ m_raServiceIndexDefault

◆ m_volumeBacklogPersistence