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. More...

	~SatLowerLayerServiceConf ()
	Destructor for SatLowerLayerServiceConf. More...

bool	GetDaConstantAssignmentProvided (uint8_t index) const
	Get state, if constant assignment is provided for a DA service. More...

uint16_t	GetDaConstantServiceRateInKbps (uint8_t index) const
	Get constant service rate for a DA service. More...

Ptr< RandomVariableStream >	GetDaConstantServiceRateStream (uint8_t index) const
	Get constant service rate stream for a DA service. More...

uint16_t	GetDaMaximumBacklogInKbytes (uint8_t index) const
	Get maximum backlog size for a DA service. More...

uint16_t	GetDaMaximumServiceRateInKbps (uint8_t index) const
	Get maximum service rate for a DA service. More...

uint16_t	GetDaMinimumServiceRateInKbps (uint8_t index) const
	Get minimum service rate for a DA service. More...

bool	GetDaRbdcAllowed (uint8_t index) const
	Get state, if RBDC is allowed for a DA service. More...

uint8_t	GetDaServiceCount () const
	Get count of configured DA services. More...

bool	GetDaVolumeAllowed (uint8_t index) const
	Get state, if volume is allowed for a DA service. More...

Time	GetDefaultControlRandomizationInterval () const
	Get configured default control randomization interval. More...

uint8_t	GetDynamicRatePersistence () const
	Get configured dynamic rate persistence. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the type ID of instance. More...

double	GetRaAverageNormalizedOfferedLoadThreshold (uint8_t index) const
	Get average normalized offeredLoad Threshold. More...

uint16_t	GetRaBackOffProbability (uint8_t index) const
	Get back off probability. More...

uint16_t	GetRaBackOffTimeInMilliSeconds (uint8_t index) const
	Get back off time in milliseconds. More...

uint8_t	GetRaDefaultService () const
	Get index of default RA service. More...

uint16_t	GetRaHighLoadBackOffProbability (uint8_t index) const
	Get high load back off probability. More...

uint16_t	GetRaHighLoadBackOffTimeInMilliSeconds (uint8_t index) const
	Get high load back off time in milliseconds. More...

bool	GetRaIsCrdsaAllowed (uint8_t index) const
	Get CRDSA allowance. More...

bool	GetRaIsEssaAllowed (uint8_t index) const
	Get E-SSA allowance. More...

bool	GetRaIsSlottedAlohaAllowed (uint8_t index) const
	Get Slotted Aloha allowance. More...

uint8_t	GetRaMaximumConsecutiveBlockAccessed (uint8_t index) const
	Get maximum consecutive block accessed for a RA service. More...

uint8_t	GetRaMaximumUniquePayloadPerBlock (uint8_t index) const
	Get maximum unique payload per block for a RA service. More...

uint8_t	GetRaMinimumIdleBlock (uint8_t index) const
	Get minimum idle block for a RA service. More...

uint8_t	GetRaNumberOfInstances (uint8_t index) const
	Get number of instances. More...

uint8_t	GetRaServiceCount () const
	Get count of configured RA services. More...

uint8_t	GetVolumeBacklogPersistence () const
	Get configured volume backlog persistence. More...

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

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. More...

void	SetDaConstantServiceRateStream (uint8_t index, Ptr< RandomVariableStream > constantServiceRateStream)
	Set constant service rate stream for a DA service. More...

void	SetDaMaximumBacklogInKbytes (uint8_t index, uint16_t maximumBacklogInKbytes)
	Set maximum backlog size for a DA service. More...

void	SetDaMaximumServiceRateInKbps (uint8_t index, uint16_t maximumServiceRateKbps)
	Set maximum service rate for a DA service. More...

void	SetDaMinimumServiceRateInKbps (uint8_t index, uint16_t minimumServiceRateKbps)
	Set minimum service rate for a DA service. More...

void	SetDaRbdcAllowed (uint8_t index, bool bdcAllowed)
	Set state, if RBDC is allowed for a DA service. More...

void	SetDaVolumeAllowed (uint8_t index, bool volumeAllowed)
	Set state, if volume is allowed for a DA service. More...

void	SetRaAverageNormalizedOfferedLoadThreshold (uint8_t index, double averageNormalizedOfferedLoadThreshold)
	Set average normalized offeredLoad Threshold. More...

void	SetRaBackOffProbability (uint8_t index, uint16_t backOffProbability)
	Set back off probability. More...

void	SetRaBackOffTimeInMilliSeconds (uint8_t index, uint16_t backOffTimeInMilliSeconds)
	Set back off time in milliseconds. More...

void	SetRaHighLoadBackOffProbability (uint8_t index, uint16_t highLoadBackOffProbability)
	Set high load back off probability. More...

void	SetRaHighLoadBackOffTimeInMilliSeconds (uint8_t index, uint16_t backOffTimeInMilliSeconds)
	Set high load back off time in milliseconds. More...

void	SetRaIsCrdsaAllowed (uint8_t index, bool isCrdsaAllowed)
	Set CRDSA allowance. More...

void	SetRaIsEssaAllowed (uint8_t index, bool isEssaAllowed)
	Set ESSA allowance. More...

void	SetRaIsSlottedAlohaAllowed (uint8_t index, bool isSlottedAlohaAllowed)
	Set Slotted Aloha allowance. More...

void	SetRaMaximumConsecutiveBlockAccessed (uint8_t index, uint8_t maxConsecutiveBlockAccessed)
	Set maximum consecutive block accessed for a RA service. More...

void	SetRaMaximumUniquePayloadPerBlock (uint8_t index, uint8_t maxUniquePayloadPerBlock)
	Set maximum unique payload per block for a RA service. More...

void	SetRaMinimumIdleBlock (uint8_t index, uint8_t minimumIdleBlock)
	Set minimum idle block for a RA service. More...

void	SetRaNumberOfInstances (uint8_t index, uint8_t numberOfInstances)
	Set number of instances. More...

Static Private Member Functions
static std::string	GetIndexAsDaServiceName (uint8_t index)
	Method to convert DA service index to service name. More...

static std::string	GetIndexAsRaServiceName (uint8_t index)
	Method to convert RA service index to service name. More...

template<class T >
static std::string	GetNumberAsString (T number)
	Template method to convert number to string. More...

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_maxDaServiceEntries, m_maxRaServiceEntries, m_minDaServiceEntries, and m_minRaServiceEntries.

◆ ~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 417 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceDaEntry::GetConstantAssignmentProvided(), m_daServiceEntries, and m_maxDaServiceEntries.

Here is the call graph for this function:

◆ 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 496 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceDaEntry::GetConstantServiceRateInKbps(), m_daServiceEntries, and m_maxDaServiceEntries.

Here is the call graph for this function:

◆ 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 509 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceDaEntry::GetConstantServiceRateStream(), m_daServiceEntries, and m_maxDaServiceEntries.

Here is the call graph for this function:

◆ 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 591 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceDaEntry::GetMaximumBacklogInKbytes(), m_daServiceEntries, and m_maxDaServiceEntries.

Here is the call graph for this function:

◆ 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 537 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceDaEntry::GetMaximumServiceRateInKbps(), m_daServiceEntries, and m_maxDaServiceEntries.

Here is the call graph for this function:

◆ 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 564 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceDaEntry::GetMinimumServiceRateInKbps(), m_daServiceEntries, and m_maxDaServiceEntries.

Here is the call graph for this function:

◆ 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 444 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceDaEntry::GetRbdcAllowed(), m_daServiceEntries, and m_maxDaServiceEntries.

Here is the call graph for this function:

◆ GetDaServiceCount()

uint8_t ns3::SatLowerLayerServiceConf::GetDaServiceCount ( ) const

inline

Get count of configured DA services.

Returns: count of configured DA services.

Definition at line 546 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 470 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceDaEntry::GetVolumeAllowed(), m_daServiceEntries, and m_maxDaServiceEntries.

Here is the call graph for this function:

◆ GetDefaultControlRandomizationInterval()

Time ns3::SatLowerLayerServiceConf::GetDefaultControlRandomizationInterval ( ) const

inline

Get configured default control randomization interval.

Returns: Default control randomization interval

Definition at line 576 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 556 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.

◆ 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.

◆ GetInstanceTypeId()

TypeId ns3::SatLowerLayerServiceConf::GetInstanceTypeId ( void ) const

virtual

Get the type ID of instance.

Returns: the object TypeId

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

References GetTypeId().

Here is the call graph for this function:

◆ GetNumberAsString()

template<class T >

static 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 767 of file satellite-lower-layer-service.h.

◆ 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 831 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetAverageNormalizedOfferedLoadThreshold(), m_maxRaServiceEntries, and m_raServiceEntries.

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

Here is the call graph for this function:

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 752 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetBackOffProbability(), m_maxRaServiceEntries, and m_raServiceEntries.

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

Here is the call graph for this function:

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 698 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetBackOffTimeInMilliSeconds(), m_maxRaServiceEntries, and m_raServiceEntries.

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

Here is the call graph for this function:

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 586 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 778 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetHighLoadBackOffProbability(), m_maxRaServiceEntries, and m_raServiceEntries.

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

Here is the call graph for this function:

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 725 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetHighLoadBackOffTimeInMilliSeconds(), m_maxRaServiceEntries, and m_raServiceEntries.

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

Here is the call graph for this function:

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 886 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetIsCrdsaAllowed(), m_maxRaServiceEntries, and m_raServiceEntries.

Here is the call graph for this function:

◆ 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 912 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetIsEssaAllowed(), m_maxRaServiceEntries, and m_raServiceEntries.

Here is the call graph for this function:

◆ 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 860 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetIsSlottedAlohaAllowed(), m_maxRaServiceEntries, and m_raServiceEntries.

Here is the call graph for this function:

◆ 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 645 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetMaximumConsecutiveBlockAccessed(), m_maxRaServiceEntries, and m_raServiceEntries.

Here is the call graph for this function:

◆ 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 618 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetMaximumUniquePayloadPerBlock(), m_maxRaServiceEntries, and m_raServiceEntries.

Here is the call graph for this function:

◆ 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 672 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetMinimumIdleBlock(), m_maxRaServiceEntries, and m_raServiceEntries.

Here is the call graph for this function:

◆ 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 805 of file satellite-lower-layer-service.cc.

References ns3::SatLowerLayerServiceRaEntry::GetNumberOfInstances(), m_maxRaServiceEntries, and m_raServiceEntries.

Here is the call graph for this function:

◆ GetRaServiceCount()

uint8_t ns3::SatLowerLayerServiceConf::GetRaServiceCount ( ) const

inline

Get count of configured RA services.

Returns: count of configured RA services.

Definition at line 536 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, m_volumeBacklogPersistence, and SAT_ADD_DA_SERVICE_ATTRIBUTES.

Referenced by GetInstanceTypeId().

Here is the caller graph for this function:

◆ GetVolumeBacklogPersistence()

uint8_t ns3::SatLowerLayerServiceConf::GetVolumeBacklogPersistence ( ) const

inline

Get configured volume backlog persistence.

Returns: Volume backlog persistence

Definition at line 566 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 430 of file satellite-lower-layer-service.cc.

References m_daServiceEntries, m_maxDaServiceEntries, and ns3::SatLowerLayerServiceDaEntry::SetConstantAssignmentProvided().

Here is the call graph for this function:

◆ 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 522 of file satellite-lower-layer-service.cc.

References m_daServiceEntries, m_maxDaServiceEntries, and ns3::SatLowerLayerServiceDaEntry::SetConstantServiceRateStream().

Here is the call graph for this function:

◆ 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 604 of file satellite-lower-layer-service.cc.

References m_daServiceEntries, m_maxDaServiceEntries, and ns3::SatLowerLayerServiceDaEntry::SetMaximumBacklogInKbytes().

Here is the call graph for this function:

◆ 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 550 of file satellite-lower-layer-service.cc.

References m_daServiceEntries, m_maxDaServiceEntries, and ns3::SatLowerLayerServiceDaEntry::SetMaximumServiceRateInKbps().

Here is the call graph for this function:

◆ 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 577 of file satellite-lower-layer-service.cc.

References m_daServiceEntries, m_maxDaServiceEntries, and ns3::SatLowerLayerServiceDaEntry::SetMinimumServiceRateInKbps().

Here is the call graph for this function:

◆ 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 457 of file satellite-lower-layer-service.cc.

References m_daServiceEntries, m_maxDaServiceEntries, and ns3::SatLowerLayerServiceDaEntry::SetRbdcAllowed().

Here is the call graph for this function:

◆ 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 483 of file satellite-lower-layer-service.cc.

References m_daServiceEntries, m_maxDaServiceEntries, and ns3::SatLowerLayerServiceDaEntry::SetVolumeAllowed().

Here is the call graph for this function:

◆ 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 844 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetAverageNormalizedOfferedLoadThreshold().

Here is the call graph for this function:

◆ 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 765 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetBackOffProbability().

Here is the call graph for this function:

◆ 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 711 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetBackOffTimeInMilliSeconds().

Here is the call graph for this function:

◆ 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 791 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetHighLoadBackOffProbability().

Here is the call graph for this function:

◆ 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 738 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetHighLoadBackOffTimeInMilliSeconds().

Here is the call graph for this function:

◆ 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 899 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetIsCrdsaAllowed().

Here is the call graph for this function:

◆ 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 925 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetIsEssaAllowed().

Here is the call graph for this function:

◆ 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 873 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetIsSlottedAlohaAllowed().

Here is the call graph for this function:

◆ 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 658 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetMaximumConsecutiveBlockAccessed().

Here is the call graph for this function:

◆ 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 631 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetMaximumUniquePayloadPerBlock().

Here is the call graph for this function:

◆ 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 685 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetMinimumIdleBlock().

Here is the call graph for this function:

◆ 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 818 of file satellite-lower-layer-service.cc.

References m_maxRaServiceEntries, m_raServiceEntries, and ns3::SatLowerLayerServiceRaEntry::SetNumberOfInstances().

Here is the call graph for this function:

Member Data Documentation

◆ m_daServiceEntries

SatLowerLayerServiceDaEntry ns3::SatLowerLayerServiceConf::m_daServiceEntries[m_maxDaServiceEntries]

private

Definition at line 756 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 755 of file satellite-lower-layer-service.h.

Referenced by GetDaServiceCount(), and GetTypeId().

◆ m_defaultControlRandomizationInterval

Time ns3::SatLowerLayerServiceConf::m_defaultControlRandomizationInterval

private

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

Referenced by GetDefaultControlRandomizationInterval(), and GetTypeId().

◆ m_dynamicRatePersistence

uint8_t ns3::SatLowerLayerServiceConf::m_dynamicRatePersistence

private

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

Referenced by 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 759 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 758 of file satellite-lower-layer-service.h.

Referenced by GetRaServiceCount(), and GetTypeId().

◆ m_raServiceIndexDefault

uint8_t ns3::SatLowerLayerServiceConf::m_raServiceIndexDefault

private

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

Referenced by GetRaDefaultService(), and GetTypeId().

◆ m_volumeBacklogPersistence

uint8_t ns3::SatLowerLayerServiceConf::m_volumeBacklogPersistence

private

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

Referenced by 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()

◆ GetInstanceTypeId()

◆ 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