ns3::SatFrameAllocator::SatFrameAllocInfo Class Reference

SatFrameAllocInfo is used to hold a frame's allocation info in symbols. More...

Collaboration diagram for ns3::SatFrameAllocator::SatFrameAllocInfo:

Public Member Functions
	SatFrameAllocInfo ()
	Construct empty SatFrameAllocInfo. More...
	SatFrameAllocInfo (SatFrameAllocReqItemContainer_t &req, Ptr< SatWaveform > trcWaveForm, bool ctrlSlotPresent, double ctrlSlotLength)
	Construct SatFrameAllocInfo from SatFrameAllocReqItem items. More...
	SatFrameAllocInfo (uint8_t countOfRcs)
	Construct empty SatFrameAllocInfo with given number of RCs. More...
double	GetTotalSymbols ()
	Get total symbols of the item. More...
SatFrameAllocInfoItem	UpdateTotalCounts ()
	Update total count of SatFrameAllocInfo from RCs. More...

Public Attributes
SatFrameAllocInfoItemContainer_t	m_allocInfoPerRc
	Information for the RCs. More...
double	m_craSymbols
bool	m_ctrlSlotPresent
double	m_minRbdcSymbols
double	m_rbdcSymbols
double	m_vbdcSymbols

Detailed Description

SatFrameAllocInfo is used to hold a frame's allocation info in symbols.

It is used for both requested and actual allocations.

Definition at line 337 of file satellite-frame-allocator.h.

Constructor & Destructor Documentation

SatFrameAllocInfo() [1/3]

ns3::SatFrameAllocator::SatFrameAllocInfo::SatFrameAllocInfo

(

)

Construct empty SatFrameAllocInfo.

Definition at line 39 of file satellite-frame-allocator.cc.

SatFrameAllocInfo() [2/3]

ns3::SatFrameAllocator::SatFrameAllocInfo::SatFrameAllocInfo

(

uint8_t

countOfRcs

)

Construct empty SatFrameAllocInfo with given number of RCs.

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

References m_allocInfoPerRc.

SatFrameAllocInfo() [3/3]

ns3::SatFrameAllocator::SatFrameAllocInfo::SatFrameAllocInfo	(	SatFrameAllocReqItemContainer_t &	req,
		Ptr< SatWaveform >	trcWaveForm,
		bool	ctrlSlotPresent,
		double	ctrlSlotLength
	)

Construct SatFrameAllocInfo from SatFrameAllocReqItem items.

Parameters

req	Reference to container having SatFrameAllocReqItem items.
waveForm	Waveform to use in allocation for TRC slots.
ctrlSlotLength	Slot length in symbols for control slots.

Definition at line 61 of file satellite-frame-allocator.cc.

References m_allocInfoPerRc, ns3::SatFrameAllocator::SatFrameAllocInfoItem::m_craSymbols, m_craSymbols, m_ctrlSlotPresent, ns3::SatFrameAllocator::SatFrameAllocInfoItem::m_minRbdcSymbols, m_minRbdcSymbols, ns3::SatFrameAllocator::SatFrameAllocInfoItem::m_rbdcSymbols, m_rbdcSymbols, ns3::SatFrameAllocator::SatFrameAllocInfoItem::m_vbdcSymbols, and m_vbdcSymbols.

Member Function Documentation

GetTotalSymbols()

double ns3::SatFrameAllocator::SatFrameAllocInfo::GetTotalSymbols

(

)

Get total symbols of the item.

Returns

Definition at line 135 of file satellite-frame-allocator.cc.

UpdateTotalCounts()

SatFrameAllocator::SatFrameAllocInfoItem ns3::SatFrameAllocator::SatFrameAllocInfo::UpdateTotalCounts

(

)

Update total count of SatFrameAllocInfo from RCs.

Returns

SatFrameAllocInfoItem holding information of the total request per category.

Definition at line 103 of file satellite-frame-allocator.cc.

References ns3::SatFrameAllocator::SatFrameAllocInfoItem::m_craSymbols, ns3::SatFrameAllocator::SatFrameAllocInfoItem::m_minRbdcSymbols, ns3::SatFrameAllocator::SatFrameAllocInfoItem::m_rbdcSymbols, and ns3::SatFrameAllocator::SatFrameAllocInfoItem::m_vbdcSymbols.

Member Data Documentation

m_allocInfoPerRc

SatFrameAllocInfoItemContainer_t ns3::SatFrameAllocator::SatFrameAllocInfo::m_allocInfoPerRc

Information for the RCs.

Definition at line 349 of file satellite-frame-allocator.h.

Referenced by SatFrameAllocInfo(), and ns3::SatFrameAllocator::UpdateAndStoreAllocReq().

m_craSymbols

double ns3::SatFrameAllocator::SatFrameAllocInfo::m_craSymbols

Definition at line 341 of file satellite-frame-allocator.h.

Referenced by SatFrameAllocInfo(), ns3::SatFrameAllocator::Allocate(), and ns3::SatFrameAllocator::UpdateAndStoreAllocReq().

m_ctrlSlotPresent

bool ns3::SatFrameAllocator::SatFrameAllocInfo::m_ctrlSlotPresent

Definition at line 340 of file satellite-frame-allocator.h.

Referenced by SatFrameAllocInfo().

m_minRbdcSymbols

double ns3::SatFrameAllocator::SatFrameAllocInfo::m_minRbdcSymbols

Definition at line 342 of file satellite-frame-allocator.h.

Referenced by SatFrameAllocInfo(), ns3::SatFrameAllocator::Allocate(), and ns3::SatFrameAllocator::UpdateAndStoreAllocReq().

m_rbdcSymbols

double ns3::SatFrameAllocator::SatFrameAllocInfo::m_rbdcSymbols

Definition at line 343 of file satellite-frame-allocator.h.

Referenced by SatFrameAllocInfo(), ns3::SatFrameAllocator::Allocate(), and ns3::SatFrameAllocator::UpdateAndStoreAllocReq().

m_vbdcSymbols

double ns3::SatFrameAllocator::SatFrameAllocInfo::m_vbdcSymbols

Definition at line 344 of file satellite-frame-allocator.h.

Referenced by SatFrameAllocInfo(), ns3::SatFrameAllocator::Allocate(), and ns3::SatFrameAllocator::UpdateAndStoreAllocReq().

---

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

• /builds/sns3/satellite/satellite/model/satellite-frame-allocator.h
• /builds/sns3/satellite/satellite/model/satellite-frame-allocator.cc