Class for random access configuration. More...

#include "satellite-random-access-container-conf.h"

Inheritance diagram for ns3::SatRandomAccessConf:

Collaboration diagram for ns3::SatRandomAccessConf:

Public Member Functions
	SatRandomAccessConf ()
	Constructor. More...

	SatRandomAccessConf (Ptr< SatLowerLayerServiceConf > llsConf, Ptr< SatSuperframeSeq > m_superframeSeq)
	Constructor. More...

virtual	~SatRandomAccessConf ()
	Destructor. More...

void	DoSlottedAlohaVariableSanityCheck ()
	Function for checking the Slotted ALOHA variable sanity. More...

Ptr< SatRandomAccessAllocationChannel >	GetAllocationChannelConfiguration (uint32_t allocationChannel)
	Function for returning the allocation channel specific RA configuration. More...

uint32_t	GetAllocationChannelConfigurationId (uint32_t allocationChannel)
	Function for retrieving the configuration ID of a given allocation channel. More...

uint32_t	GetCrdsaSignalingOverheadInBytes ()
	Function for getting the CRDSA signaling overhead in bytes. More...

uint32_t	GetNumOfAllocationChannelsConfigurations ()
	Function for getting the number of available allocation channels configurations. More...

uint32_t	GetSlottedAlohaControlRandomizationIntervalInMilliSeconds ()
	Function for getting the Slotted ALOHA control randomization interval. More...

uint32_t	GetSlottedAlohaSignalingOverheadInBytes ()
	Function for getting the Slotted ALOHA signaling overhead in bytes. More...

void	SetSlottedAlohaControlRandomizationIntervalInMilliSeconds (uint32_t controlRandomizationIntervalInMilliSeconds)
	Function for setting the Slotted ALOHA control randomization interval. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	NS-3 type id function. More...

Private Attributes
std::map< uint32_t, Ptr< SatRandomAccessAllocationChannel > >	m_allocationChannelConf
	Map containing the allocation channel configurations. More...

uint32_t	m_allocationChannelCount
	Number of available allocation channels. More...

std::vector< uint32_t >	m_configurationIdPerAllocationChannel
	Mapping between an allocation channel and its associated configuration index. More...

uint32_t	m_crdsaSignalingOverheadInBytes
	Defines the size of the CRDSA signaling overhead in bytes. More...

uint32_t	m_slottedAlohaControlRandomizationIntervalInMilliSeconds
	Slotted ALOHA control randomization interval in milliseconds. More...

uint32_t	m_slottedAlohaSignalingOverheadInBytes
	Defines the size of the Slotted ALOHA signaling overhead in bytes. More...

Detailed Description

Class for random access configuration.

This class holds the non-allocation channel specific random access configuration in addition to the configuration objects specific for each allocation channel.

Definition at line 49 of file satellite-random-access-container-conf.h.

Constructor & Destructor Documentation

◆ SatRandomAccessConf() [1/2]

ns3::SatRandomAccessConf::SatRandomAccessConf ( )

Constructor.

Definition at line 62 of file satellite-random-access-container-conf.cc.

◆ SatRandomAccessConf() [2/2]

ns3::SatRandomAccessConf::SatRandomAccessConf	(	Ptr< SatLowerLayerServiceConf >	llsConf,
		Ptr< SatSuperframeSeq >	m_superframeSeq
	)

Constructor.

this assumes that the slot IDs for each allocation channel start at 0

TODO Get rid of the hard coded 0 in GetSuperframeConf

this assumes that the slot IDs for each allocation channel start at 0

Definition at line 72 of file satellite-random-access-container-conf.cc.

References DoSlottedAlohaVariableSanityCheck(), m_allocationChannelConf, m_allocationChannelCount, m_configurationIdPerAllocationChannel, and m_slottedAlohaControlRandomizationIntervalInMilliSeconds.

Here is the call graph for this function:

◆ ~SatRandomAccessConf()

ns3::SatRandomAccessConf::~SatRandomAccessConf ( )

virtual

Destructor.

Definition at line 154 of file satellite-random-access-container-conf.cc.

Member Function Documentation

◆ DoSlottedAlohaVariableSanityCheck()

void ns3::SatRandomAccessConf::DoSlottedAlohaVariableSanityCheck ( )

Function for checking the Slotted ALOHA variable sanity.

Definition at line 177 of file satellite-random-access-container-conf.cc.

References m_slottedAlohaControlRandomizationIntervalInMilliSeconds.

Referenced by SatRandomAccessConf().

Here is the caller graph for this function:

◆ GetAllocationChannelConfiguration()

Ptr< SatRandomAccessAllocationChannel > ns3::SatRandomAccessConf::GetAllocationChannelConfiguration ( uint32_t allocationChannel )

Function for returning the allocation channel specific RA configuration.

Parameters

allocationChannel allocation channel ID

Returns: allocation channel configuration

Definition at line 160 of file satellite-random-access-container-conf.cc.

References m_allocationChannelConf.

◆ GetAllocationChannelConfigurationId()

uint32_t ns3::SatRandomAccessConf::GetAllocationChannelConfigurationId ( uint32_t allocationChannel )

Function for retrieving the configuration ID of a given allocation channel.

Parameters

allocationChannel allocation channel ID

Returns: allocation channel configuration ID

Definition at line 191 of file satellite-random-access-container-conf.cc.

References m_configurationIdPerAllocationChannel.

◆ GetCrdsaSignalingOverheadInBytes()

uint32_t ns3::SatRandomAccessConf::GetCrdsaSignalingOverheadInBytes ( )

inline

Function for getting the CRDSA signaling overhead in bytes.

Returns: CRDSA signaling overhead in bytes

Definition at line 123 of file satellite-random-access-container-conf.h.

References m_crdsaSignalingOverheadInBytes.

◆ GetNumOfAllocationChannelsConfigurations()

uint32_t ns3::SatRandomAccessConf::GetNumOfAllocationChannelsConfigurations ( )

inline

Function for getting the number of available allocation channels configurations.

Returns: number of allocation channels configurations

Definition at line 107 of file satellite-random-access-container-conf.h.

References m_allocationChannelCount.

◆ GetSlottedAlohaControlRandomizationIntervalInMilliSeconds()

uint32_t ns3::SatRandomAccessConf::GetSlottedAlohaControlRandomizationIntervalInMilliSeconds ( )

inline

Function for getting the Slotted ALOHA control randomization interval.

Returns: control randomization interval

Definition at line 86 of file satellite-random-access-container-conf.h.

References m_slottedAlohaControlRandomizationIntervalInMilliSeconds.

◆ GetSlottedAlohaSignalingOverheadInBytes()

uint32_t ns3::SatRandomAccessConf::GetSlottedAlohaSignalingOverheadInBytes ( )

inline

Function for getting the Slotted ALOHA signaling overhead in bytes.

Returns: Slotted ALOHA signaling overhead in bytes

Definition at line 132 of file satellite-random-access-container-conf.h.

References m_slottedAlohaSignalingOverheadInBytes.

◆ GetTypeId()

TypeId ns3::SatRandomAccessConf::GetTypeId ( void )

static

NS-3 type id function.

Returns: type id

Definition at line 41 of file satellite-random-access-container-conf.cc.

References m_crdsaSignalingOverheadInBytes, and m_slottedAlohaSignalingOverheadInBytes.

◆ SetSlottedAlohaControlRandomizationIntervalInMilliSeconds()

void ns3::SatRandomAccessConf::SetSlottedAlohaControlRandomizationIntervalInMilliSeconds ( uint32_t controlRandomizationIntervalInMilliSeconds )

inline

Function for setting the Slotted ALOHA control randomization interval.

Parameters

controlRandomizationIntervalInMilliSeconds control randomization interval in milliseconds

Definition at line 96 of file satellite-random-access-container-conf.h.

References m_slottedAlohaControlRandomizationIntervalInMilliSeconds.

Member Data Documentation

◆ m_allocationChannelConf

std::map<uint32_t, Ptr<SatRandomAccessAllocationChannel> > ns3::SatRandomAccessConf::m_allocationChannelConf

private

Map containing the allocation channel configurations.

Definition at line 146 of file satellite-random-access-container-conf.h.

Referenced by SatRandomAccessConf(), and GetAllocationChannelConfiguration().

◆ m_allocationChannelCount

uint32_t ns3::SatRandomAccessConf::m_allocationChannelCount

private

Number of available allocation channels.

Definition at line 162 of file satellite-random-access-container-conf.h.

Referenced by SatRandomAccessConf(), and GetNumOfAllocationChannelsConfigurations().

◆ m_configurationIdPerAllocationChannel

std::vector<uint32_t> ns3::SatRandomAccessConf::m_configurationIdPerAllocationChannel

private

Mapping between an allocation channel and its associated configuration index.

Definition at line 151 of file satellite-random-access-container-conf.h.

Referenced by SatRandomAccessConf(), and GetAllocationChannelConfigurationId().

◆ m_crdsaSignalingOverheadInBytes

uint32_t ns3::SatRandomAccessConf::m_crdsaSignalingOverheadInBytes

private

Defines the size of the CRDSA signaling overhead in bytes.

Definition at line 167 of file satellite-random-access-container-conf.h.

Referenced by GetCrdsaSignalingOverheadInBytes(), and GetTypeId().

◆ m_slottedAlohaControlRandomizationIntervalInMilliSeconds

uint32_t ns3::SatRandomAccessConf::m_slottedAlohaControlRandomizationIntervalInMilliSeconds

private

Slotted ALOHA control randomization interval in milliseconds.

Definition at line 157 of file satellite-random-access-container-conf.h.

Referenced by SatRandomAccessConf(), DoSlottedAlohaVariableSanityCheck(), GetSlottedAlohaControlRandomizationIntervalInMilliSeconds(), and SetSlottedAlohaControlRandomizationIntervalInMilliSeconds().

◆ m_slottedAlohaSignalingOverheadInBytes

uint32_t ns3::SatRandomAccessConf::m_slottedAlohaSignalingOverheadInBytes

private

Defines the size of the Slotted ALOHA signaling overhead in bytes.

Definition at line 172 of file satellite-random-access-container-conf.h.

Referenced by GetSlottedAlohaSignalingOverheadInBytes(), and GetTypeId().

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

/builds/sns3/satellite/satellite/model/satellite-random-access-container-conf.h
/builds/sns3/satellite/satellite/model/satellite-random-access-container-conf.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SatRandomAccessConf() [1/2]

◆ SatRandomAccessConf() [2/2]

◆ ~SatRandomAccessConf()

Member Function Documentation

◆ DoSlottedAlohaVariableSanityCheck()

◆ GetAllocationChannelConfiguration()

◆ GetAllocationChannelConfigurationId()

◆ GetCrdsaSignalingOverheadInBytes()

◆ GetNumOfAllocationChannelsConfigurations()

◆ GetSlottedAlohaControlRandomizationIntervalInMilliSeconds()

◆ GetSlottedAlohaSignalingOverheadInBytes()

◆ GetTypeId()

◆ SetSlottedAlohaControlRandomizationIntervalInMilliSeconds()

Member Data Documentation

◆ m_allocationChannelConf

◆ m_allocationChannelCount

◆ m_configurationIdPerAllocationChannel

◆ m_crdsaSignalingOverheadInBytes

◆ m_slottedAlohaControlRandomizationIntervalInMilliSeconds

◆ m_slottedAlohaSignalingOverheadInBytes