#include "satellite-dama-entry.h"

Inheritance diagram for ns3::SatDamaEntry:

Collaboration diagram for ns3::SatDamaEntry:

Public Member Functions
	SatDamaEntry ()
	Default construct a SatDamaEntry. More...

	SatDamaEntry (Ptr< SatLowerLayerServiceConf > llsConf)
	Actual construct a SatDamaEntry. More...

	~SatDamaEntry ()
	Destroy a SatDamaEntry. More...

void	DecrementDynamicRatePersistence ()
	Decrement dynamic rate persistence. More...

void	DecrementVolumeBacklogPersistence ()
	Decrement volume backlog persistence. More...

uint32_t	GetCraBasedBytes (Time duration) const
	Get CRA based bytes with given duration. More...

uint16_t	GetCraInKbps (uint8_t index) const
	Get configured value of the CRA. More...

uint32_t	GetMinRateBasedBytes (Time duration) const
	Get minimum rate based bytes with given duration. More...

uint16_t	GetMinRbdcInKbps (uint8_t index) const
	Get configured value of the minimum RBDC. More...

uint32_t	GetRbdcBasedBytes (Time duration) const
	Get RBDC based bytes with given duration. More...

uint16_t	GetRbdcInKbps (uint8_t index) const
	Get current value of the RBDC requested. More...

uint8_t	GetRcCount () const
	Get number of RCs in the SatDamaEntry. More...

uint32_t	GetVbdcBasedBytes () const
	Get VBDC based bytes. More...

uint32_t	GetVbdcInBytes (uint8_t index) const
	Get current value of the VBDC requested. More...

void	ResetDynamicRatePersistence ()
	Reset dynamic rate persistence to the value given in lower layer service configuration. More...

void	ResetVolumeBacklogPersistence ()
	Reset volume backlog persistence to the value given in lower layer service configuration. More...

void	SetVbdcInBytes (uint8_t index, uint32_t volumeInBytes)
	Set VBDC request of the RC. More...

void	UpdateRbdcInKbps (uint8_t index, uint16_t rateInKbps)
	Update RBDC request of a RC. More...

void	UpdateVbdcInBytes (uint8_t index, uint32_t volumeInBytes)
	Update VBDC request of the RC. More...

Private Attributes
uint8_t	m_dynamicRatePersistence

std::vector< uint16_t >	m_dynamicRateRequestedInKbps

Ptr< SatLowerLayerServiceConf >	m_llsConf

uint8_t	m_volumeBacklogPersistence

std::vector< uint32_t >	m_volumeBacklogRequestedInBytes

Detailed Description

class for module SatDamaEntry.

This SatDamaEntry class holds information of a satellite DAMA entry. It's is created and used by NCC.

Definition at line 41 of file satellite-dama-entry.h.

Constructor & Destructor Documentation

◆ SatDamaEntry() [1/2]

ns3::SatDamaEntry::SatDamaEntry ( )

Default construct a SatDamaEntry.

This version of the constructor shall not used.

Definition at line 33 of file satellite-dama-entry.cc.

◆ SatDamaEntry() [2/2]

ns3::SatDamaEntry::SatDamaEntry ( Ptr< SatLowerLayerServiceConf > llsConf )

Actual construct a SatDamaEntry.

Definition at line 41 of file satellite-dama-entry.cc.

References m_dynamicRateRequestedInKbps, m_llsConf, and m_volumeBacklogRequestedInBytes.

◆ ~SatDamaEntry()

ns3::SatDamaEntry::~SatDamaEntry ( )

Destroy a SatDamaEntry.

This is the destructor for the SatDamaEntry.

Definition at line 52 of file satellite-dama-entry.cc.

Member Function Documentation

◆ DecrementDynamicRatePersistence()

void ns3::SatDamaEntry::DecrementDynamicRatePersistence ( )

Decrement dynamic rate persistence.

Definition at line 289 of file satellite-dama-entry.cc.

References m_dynamicRatePersistence, and m_dynamicRateRequestedInKbps.

◆ DecrementVolumeBacklogPersistence()

void ns3::SatDamaEntry::DecrementVolumeBacklogPersistence ( )

Decrement volume backlog persistence.

Definition at line 313 of file satellite-dama-entry.cc.

References m_volumeBacklogPersistence, and m_volumeBacklogRequestedInBytes.

◆ GetCraBasedBytes()

uint32_t ns3::SatDamaEntry::GetCraBasedBytes ( Time duration ) const

Get CRA based bytes with given duration.

Parameters

duration Duration of the transmission

Returns: Rate based bytes with given duration.

Definition at line 66 of file satellite-dama-entry.cc.

References ns3::SatConstVariables::BITS_IN_KBIT, ns3::SatConstVariables::BITS_PER_BYTE, and m_llsConf.

◆ GetCraInKbps()

uint16_t ns3::SatDamaEntry::GetCraInKbps ( uint8_t index ) const

Get configured value of the CRA.

Parameters

index Index of RC, which CRA is requested.

Returns: Configured value of the CRA requested [kBps].

Definition at line 150 of file satellite-dama-entry.cc.

References m_llsConf.

Referenced by GetMinRbdcInKbps(), and UpdateRbdcInKbps().

Here is the caller graph for this function:

◆ GetMinRateBasedBytes()

uint32_t ns3::SatDamaEntry::GetMinRateBasedBytes ( Time duration ) const

Get minimum rate based bytes with given duration.

When

Parameters

duration Duration of the transmission

Returns: Rate based bytes with given duration.

Definition at line 86 of file satellite-dama-entry.cc.

References ns3::SatConstVariables::BITS_IN_KBIT, ns3::SatConstVariables::BITS_PER_BYTE, and m_llsConf.

◆ GetMinRbdcInKbps()

uint16_t ns3::SatDamaEntry::GetMinRbdcInKbps ( uint8_t index ) const

Get configured value of the minimum RBDC.

Parameters

index Index of RC, which minimum RBDC is requested.

Returns: Configured value of the minimum RBDC requested [kBps].

Definition at line 169 of file satellite-dama-entry.cc.

References GetCraInKbps(), m_dynamicRatePersistence, and m_llsConf.

Referenced by UpdateRbdcInKbps().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRbdcBasedBytes()

uint32_t ns3::SatDamaEntry::GetRbdcBasedBytes ( Time duration ) const

Get RBDC based bytes with given duration.

Parameters

duration Duration of the transmission

Returns: Rate based bytes with given duration.

Definition at line 118 of file satellite-dama-entry.cc.

References ns3::SatConstVariables::BITS_IN_KBIT, ns3::SatConstVariables::BITS_PER_BYTE, and m_dynamicRateRequestedInKbps.

◆ GetRbdcInKbps()

uint16_t ns3::SatDamaEntry::GetRbdcInKbps ( uint8_t index ) const

Get current value of the RBDC requested.

Parameters

index Index of RC, which dynamic rate is requested.

Returns: Current value of the RBDC requested [kBps].

Definition at line 190 of file satellite-dama-entry.cc.

References m_dynamicRateRequestedInKbps.

◆ GetRcCount()

uint8_t ns3::SatDamaEntry::GetRcCount ( ) const

Get number of RCs in the SatDamaEntry.

Returns: Number of RCs in the SatDamaEntry.

Definition at line 58 of file satellite-dama-entry.cc.

References m_llsConf.

◆ GetVbdcBasedBytes()

uint32_t ns3::SatDamaEntry::GetVbdcBasedBytes ( ) const

Get VBDC based bytes.

Returns: Volume based bytes with given duration.

Definition at line 135 of file satellite-dama-entry.cc.

References m_volumeBacklogRequestedInBytes.

◆ GetVbdcInBytes()

uint32_t ns3::SatDamaEntry::GetVbdcInBytes ( uint8_t index ) const

Get current value of the VBDC requested.

Parameters

index Index of RC, which volume backlog is requested.

Returns: Current value of the VBDC requested in bytes.

Definition at line 230 of file satellite-dama-entry.cc.

References m_volumeBacklogRequestedInBytes.

◆ ResetDynamicRatePersistence()

void ns3::SatDamaEntry::ResetDynamicRatePersistence ( )

Reset dynamic rate persistence to the value given in lower layer service configuration.

Definition at line 281 of file satellite-dama-entry.cc.

References m_dynamicRatePersistence, and m_llsConf.

◆ ResetVolumeBacklogPersistence()

void ns3::SatDamaEntry::ResetVolumeBacklogPersistence ( )

Reset volume backlog persistence to the value given in lower layer service configuration.

Definition at line 305 of file satellite-dama-entry.cc.

References m_llsConf, and m_volumeBacklogPersistence.

◆ SetVbdcInBytes()

void ns3::SatDamaEntry::SetVbdcInBytes	(	uint8_t	index,
		uint32_t	volumeInBytes
	)

Set VBDC request of the RC.

Parameters

index	Index of RC, which VBDC is updated.
volumeInBytes	VBDC value [bytes] to set

Definition at line 258 of file satellite-dama-entry.cc.

References ns3::SatConstVariables::BYTES_IN_KBYTE, m_llsConf, and m_volumeBacklogRequestedInBytes.

Referenced by UpdateVbdcInBytes().

Here is the caller graph for this function:

◆ UpdateRbdcInKbps()

void ns3::SatDamaEntry::UpdateRbdcInKbps	(	uint8_t	index,
		uint16_t	rateInKbps
	)

Update RBDC request of a RC.

Parameters

index	Index of RC, which dynamic rate is updated.
rateInKbps	RBDC [kBps] for update

Definition at line 203 of file satellite-dama-entry.cc.

References GetCraInKbps(), GetMinRbdcInKbps(), m_dynamicRateRequestedInKbps, and m_llsConf.

Here is the call graph for this function:

◆ UpdateVbdcInBytes()

void ns3::SatDamaEntry::UpdateVbdcInBytes	(	uint8_t	index,
		uint32_t	volumeInBytes
	)

Update VBDC request of the RC.

Parameters

index	Index of RC, which VBDC is updated.
volumeInBytes	VBDC value [bytes] for update

Definition at line 243 of file satellite-dama-entry.cc.

References m_llsConf, m_volumeBacklogRequestedInBytes, and SetVbdcInBytes().

Here is the call graph for this function:

Member Data Documentation

◆ m_dynamicRatePersistence

uint8_t ns3::SatDamaEntry::m_dynamicRatePersistence

private

Definition at line 182 of file satellite-dama-entry.h.

Referenced by DecrementDynamicRatePersistence(), GetMinRbdcInKbps(), and ResetDynamicRatePersistence().

◆ m_dynamicRateRequestedInKbps

std::vector<uint16_t> ns3::SatDamaEntry::m_dynamicRateRequestedInKbps

private

Definition at line 185 of file satellite-dama-entry.h.

Referenced by SatDamaEntry(), DecrementDynamicRatePersistence(), GetRbdcBasedBytes(), GetRbdcInKbps(), and UpdateRbdcInKbps().

◆ m_llsConf

Ptr<SatLowerLayerServiceConf> ns3::SatDamaEntry::m_llsConf

private

Definition at line 184 of file satellite-dama-entry.h.

Referenced by SatDamaEntry(), GetCraBasedBytes(), GetCraInKbps(), GetMinRateBasedBytes(), GetMinRbdcInKbps(), GetRcCount(), ResetDynamicRatePersistence(), ResetVolumeBacklogPersistence(), SetVbdcInBytes(), UpdateRbdcInKbps(), and UpdateVbdcInBytes().

◆ m_volumeBacklogPersistence

uint8_t ns3::SatDamaEntry::m_volumeBacklogPersistence

private

Definition at line 183 of file satellite-dama-entry.h.

Referenced by DecrementVolumeBacklogPersistence(), and ResetVolumeBacklogPersistence().

◆ m_volumeBacklogRequestedInBytes

std::vector<uint32_t> ns3::SatDamaEntry::m_volumeBacklogRequestedInBytes

private

Definition at line 186 of file satellite-dama-entry.h.

Referenced by SatDamaEntry(), DecrementVolumeBacklogPersistence(), GetVbdcBasedBytes(), GetVbdcInBytes(), SetVbdcInBytes(), and UpdateVbdcInBytes().

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

/builds/sns3/satellite/satellite/model/satellite-dama-entry.h
/builds/sns3/satellite/satellite/model/satellite-dama-entry.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SatDamaEntry() [1/2]

◆ SatDamaEntry() [2/2]

◆ ~SatDamaEntry()

Member Function Documentation

◆ DecrementDynamicRatePersistence()

◆ DecrementVolumeBacklogPersistence()

◆ GetCraBasedBytes()

◆ GetCraInKbps()

◆ GetMinRateBasedBytes()

◆ GetMinRbdcInKbps()

◆ GetRbdcBasedBytes()

◆ GetRbdcInKbps()

◆ GetRcCount()

◆ GetVbdcBasedBytes()

◆ GetVbdcInBytes()

◆ ResetDynamicRatePersistence()

◆ ResetVolumeBacklogPersistence()

◆ SetVbdcInBytes()

◆ UpdateRbdcInKbps()

◆ UpdateVbdcInBytes()

Member Data Documentation

◆ m_dynamicRatePersistence

◆ m_dynamicRateRequestedInKbps

◆ m_llsConf

◆ m_volumeBacklogPersistence

◆ m_volumeBacklogRequestedInBytes