helper class for Satellite Beam Scheduler. More...

#include "satellite-superframe-allocator.h"

Inheritance diagram for ns3::SatSuperframeAllocator:

Collaboration diagram for ns3::SatSuperframeAllocator:

Public Member Functions
	SatSuperframeAllocator (Ptr< SatSuperframeConf > superFrameConf)
	Construct SatSuperframeAllocator. More...

virtual	~SatSuperframeAllocator ()
	Destruct SatSuperframeAllocator. More...

virtual void	GenerateTimeSlots (SatFrameAllocator::TbtpMsgContainer_t &tbtpContainer, uint32_t maxSizeInBytes, SatFrameAllocator::UtAllocInfoContainer_t &utAllocContainer, TracedCallback< uint32_t > waveformTrace, TracedCallback< uint32_t, uint32_t > utLoadTrace, TracedCallback< uint32_t, double > loadTrace)=0
	Generate time slots in TBTP(s) for the UT/RC. More...

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

Time	GetSuperframeDuration () const
	Get super frame duration. More...

virtual void	PreAllocateSymbols (SatFrameAllocator::SatFrameAllocContainer_t &allocReqs)=0
	Preallocate symbols for given to UTs in superframe. More...

virtual void	ReleaseMinimumRate (uint32_t minimumRateBytes, bool controlSlotsEnabled)=0
	Release minimum rate from the allocator. More...

virtual void	ReserveMinimumRate (uint32_t minimumRateBytes, bool controlSlotsEnabled)=0
	Reserve minimum rate from the allocator. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	derived from object More...

Protected Attributes
Ptr< SatSuperframeConf >	m_superframeConf

Detailed Description

helper class for Satellite Beam Scheduler.

SatSuperframeAllocator class is used by SatBeamScheduler to maintain information of the pre-allocated symbols per Capacity Category (CC) in frame. It also knows physical constrains of the frames.

SatSuperframeAllocator is created and used by SatBeamScheduler.

Definition at line 46 of file satellite-superframe-allocator.h.

Constructor & Destructor Documentation

◆ SatSuperframeAllocator()

ns3::SatSuperframeAllocator::SatSuperframeAllocator ( Ptr< SatSuperframeConf > superFrameConf )

Construct SatSuperframeAllocator.

Parameters

superFrameConf Super frame configuration

Definition at line 49 of file satellite-superframe-allocator.cc.

◆ ~SatSuperframeAllocator()

ns3::SatSuperframeAllocator::~SatSuperframeAllocator ( )

virtual

Destruct SatSuperframeAllocator.

Definition at line 55 of file satellite-superframe-allocator.cc.

Member Function Documentation

◆ GenerateTimeSlots()

virtual void ns3::SatSuperframeAllocator::GenerateTimeSlots	(	SatFrameAllocator::TbtpMsgContainer_t &	tbtpContainer,
		uint32_t	maxSizeInBytes,
		SatFrameAllocator::UtAllocInfoContainer_t &	utAllocContainer,
		TracedCallback< uint32_t >	waveformTrace,
		TracedCallback< uint32_t, uint32_t >	utLoadTrace,
		TracedCallback< uint32_t, double >	loadTrace
	)

pure virtual

Generate time slots in TBTP(s) for the UT/RC.

Parameters

tbtpContainer	TBTP message container to add/fill TBTPs.
maxSizeInBytes	Maximum size for a TBTP message.
utAllocContainer	Reference to UT allocation container to fill in info of the allocation
waveformTrace	Wave form trace callback
utLoadTrace	UT load per the frame trace callback
loadTrace	Load per the frame trace callback