BB Frame container class. More...

#include "satellite-bbframe-container.h"

Inheritance diagram for ns3::SatBbFrameContainer:

Collaboration diagram for ns3::SatBbFrameContainer:

Public Member Functions
	SatBbFrameContainer ()
	Default constructor for SatBbFrameContainer not supported. More...

	SatBbFrameContainer (std::vector< SatEnums::SatModcod_t > &modcodsInUse, Ptr< SatBbFrameConf > conf)
	Actual constructor for SatBbFrameContainer. More...

virtual	~SatBbFrameContainer ()
	Destructor. More...

void	AddData (uint32_t priorityClass, SatEnums::SatModcod_t modcod, Ptr< Packet > data)
	Add data according to given priority class and MODCOD to container. More...

void	ClearAllFrames ()
	Remove all frames in containers. More...

uint32_t	GetBytesLeftInTailFrame (uint32_t priorityClass, SatEnums::SatModcod_t modcod)
	Get bytes left in last frame of the queue with the given priority class and MODCOD. More...

uint32_t	GetFrameSymbols (SatEnums::SatModcod_t modcod)
	Get the total number of symbols, incuding headers, when creating a new BBFrame. More...

uint32_t	GetMaxFramePayloadInBytes (uint32_t priorityClass, SatEnums::SatModcod_t modcod)
	Get maximum payload bytes of a frame with the given priority class and MODCOD. More...

uint32_t	GetMaxSymbolRate ()
	Set the maximum symbol rate of this container, used for time-slicing. More...

SatEnums::SatModcod_t	GetModcod (uint32_t priorityClass, double cno)
	Get maximum MODCOD with the given priority class and C/N0. More...

Ptr< SatBbFrame >	GetNextFrame ()
	Get next frame from container to transmit. More...

Time	GetTotalDuration () const
	Get total transmission duration of the frames in container. More...

bool	IsEmpty (uint32_t priorityClass, SatEnums::SatModcod_t modcod)
	Indicates if the container for a ModCod and priority is empty (no BBFrame). More...

void	MergeBbFrames (double carrierBandwidthInHz)

void	SetMaxSymbolRate (uint32_t maxSymbolRate)
	Set the maximum symbol rate of this container, used for time-slicing. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Types
typedef std::map< SatEnums::SatModcod_t, std::deque< Ptr< SatBbFrame > > >	FrameContainer_t

Private Member Functions
void	CreateFrameToTail (uint32_t priorityClass, SatEnums::SatModcod_t modcod)
	Create short or normal frame according to MODCOD and member #m_bbFrameUsageMode. More...

Private Attributes
Ptr< SatBbFrameConf >	m_bbFrameConf

TracedCallback< Ptr< SatBbFrame >, Ptr< SatBbFrame > >	m_bbFrameMergeTrace
	Trace for merged BB frames. More...

FrameContainer_t	m_container

std::deque< Ptr< SatBbFrame > >	m_ctrlContainer

SatEnums::SatBbFrameType_t	m_defaultBbFrameType

uint32_t	m_maxSymbolRate

Time	m_totalDuration

Detailed Description

BB Frame container class.

Holds information of BB Frames for forward link scheduling.

SatBbFrameContainer implements own queues (container) for every used MODCODs. These MODCOD queues are used for non control packets (priority class different than 0).

For control messages (priority class 0) is used only one queue with most robust MODCOD.

Definition at line 50 of file satellite-bbframe-container.h.

Member Typedef Documentation

◆ FrameContainer_t

typedef std::map<SatEnums::SatModcod_t, std::deque<Ptr<SatBbFrame> > > ns3::SatBbFrameContainer::FrameContainer_t

private

Definition at line 161 of file satellite-bbframe-container.h.

Constructor & Destructor Documentation

◆ SatBbFrameContainer() [1/2]

ns3::SatBbFrameContainer::SatBbFrameContainer ( )

Default constructor for SatBbFrameContainer not supported.

Definition at line 42 of file satellite-bbframe-container.cc.

◆ SatBbFrameContainer() [2/2]

ns3::SatBbFrameContainer::SatBbFrameContainer	(	std::vector< SatEnums::SatModcod_t > &	modcodsInUse,
		Ptr< SatBbFrameConf >	conf
	)

Actual constructor for SatBbFrameContainer.

Parameters

modcodsInUse	MODCODs in use.
conf	Pointer to BB Frame configuration.

Definition at line 50 of file satellite-bbframe-container.cc.

References m_bbFrameConf, m_container, m_defaultBbFrameType, ns3::SatEnums::NORMAL_FRAME, ns3::SatEnums::SHORT_FRAME, and ns3::SatEnums::SHORT_FRAMES.

◆ ~SatBbFrameContainer()

ns3::SatBbFrameContainer::~SatBbFrameContainer ( )

virtual

Destructor.

Definition at line 79 of file satellite-bbframe-container.cc.

References m_container.

Member Function Documentation

◆ AddData()

void ns3::SatBbFrameContainer::AddData	(	uint32_t	priorityClass,
		SatEnums::SatModcod_t	modcod,
		Ptr< Packet >	data
	)

Add data according to given priority class and MODCOD to container.

Parameters

priorityClass	Priority class of the data (packet) to be added
modcod	MODCOD of the data (packet) to be added. MODCOD is ignored when priorityClass is 0.
data	Data (packet) to be added to container

Definition at line 191 of file satellite-bbframe-container.cc.

References CreateFrameToTail(), GetBytesLeftInTailFrame(), m_bbFrameConf, m_container, m_ctrlContainer, m_defaultBbFrameType, m_totalDuration, ns3::SatEnums::SHORT_AND_NORMAL_FRAMES, and ns3::SatEnums::SHORT_FRAME.

Here is the call graph for this function: