SatFwdLinkScheduler schedules BB frames for forward link. More...

#include "satellite-fwd-link-scheduler.h"

Inheritance diagram for ns3::SatFwdLinkScheduler:

Collaboration diagram for ns3::SatFwdLinkScheduler:

Public Types
typedef Callback< void, std::vector< Ptr< SatSchedulingObject > > & >	SchedContextCallback
	Callback to get scheduling contexts from upper layer.
enum	ScheduleSortingCriteria_t { NO_SORT , BUFFERING_DELAY_SORT , BUFFERING_LOAD_SORT , RANDOM_SORT , PRIORITY_SORT }
	Types for sorting algorithm used by forward link scheduler. More...
typedef Callback< bool, Ptr< SatControlMessage >, const Address & >	SendControlMsgCallback
	Callback to notify upper layer about Tx opportunity.
typedef Callback< Ptr< Packet >, uint32_t, Mac48Address, uint8_t, uint32_t &, uint32_t & >	TxOpportunityCallback
	Callback to notify upper layer about Tx opportunity.

Public Member Functions
	SatFwdLinkScheduler ()
	Construct a SatFwdLinkScheduler.
	SatFwdLinkScheduler (Ptr< SatBbFrameConf > conf, Mac48Address address, double carrierBandwidthInHz)
	Actual constructor of a SatFwdLinkScheduler.
	~SatFwdLinkScheduler ()
	Destroy a SatFwdLinkScheduler.
virtual void	ClearAllPackets ()
	Remove all packets being treated.
void	CnoInfoUpdated (Mac48Address utAddress, double cnoEstimate)
	Called when UT's C/N0 estimation is updated.
Time	GetDefaultFrameDuration () const
	Return the BB frame duration of the default frame format, i.e.
virtual std::pair< Ptr< SatBbFrame >, const Time >	GetNextFrame ()
	Get next frame to be transmitted.
virtual void	NotifyConstructionCompleted () override
	Notifier called once the ObjectBase is fully constructed.
bool	SendControlMsg (Ptr< SatControlMessage > message, const Address &dest) const
	Method te send a control message to a destination.
void	SetDummyFrameSendingEnabled (bool dummyFrameSendingEnabled)
	Set the value of m_dummyFrameSendingEnabled.
void	SetSchedContextCallback (SatFwdLinkScheduler::SchedContextCallback cb)
	Method to set Tx opportunity callback.
void	SetSendControlMsgCallback (SatFwdLinkScheduler::SendControlMsgCallback cb)
	Method to set the control message sender callback.
void	SetTxOpportunityCallback (SatFwdLinkScheduler::TxOpportunityCallback cb)
	Method to set Tx opportunity callback.

Static Public Member Functions
static bool	CompareSoFlowId (Ptr< SatSchedulingObject > obj1, Ptr< SatSchedulingObject > obj2)
	Compares to scheduling objects priorities.
static bool	CompareSoPriorityHol (Ptr< SatSchedulingObject > obj1, Ptr< SatSchedulingObject > obj2)
	Compares to scheduling objects priorities and HOL.
static bool	CompareSoPriorityLoad (Ptr< SatSchedulingObject > obj1, Ptr< SatSchedulingObject > obj2)
	Compares to scheduling objects priorities and load.
static TypeId	GetTypeId (void)
	Get the type ID.

Protected Types
typedef std::map< Mac48Address, Ptr< SatCnoEstimator > >	CnoEstimatorMap_t

Protected Member Functions
	SatFwdLinkScheduler (const SatFwdLinkScheduler &)
bool	CnoMatchWithFrame (double cno, Ptr< SatBbFrame > frame) const
	Check if given estimated C/N0 match with given frame.
Ptr< SatCnoEstimator >	CreateCnoEstimator ()
	Create estimator for the UT according to set attributes.
void	DoDispose (void)
	Do dispose actions.
double	GetSchedulingObjectCno (Ptr< SatSchedulingObject > ob)
void	GetSchedulingObjects (std::vector< Ptr< SatSchedulingObject > > &output)
	Gets scheduling object in sorted order according to configured sorting criteria.
SatFwdLinkScheduler &	operator= (const SatFwdLinkScheduler &)
void	PeriodicTimerExpired ()
	Handles periodic timer timeouts.
virtual void	ScheduleBbFrames ()=0
	Schedule BB Frames.
virtual void	SendAndClearSymbolsSentStat ()=0
	Send stats and reset all the symbols sent count for each slice to zero.
void	SortSchedulingObjects (std::vector< Ptr< SatSchedulingObject > > &so)
	Sorts given scheduling objects according to configured sorting criteria.

Protected Attributes
ScheduleSortingCriteria_t	m_additionalSortCriteria
	Additional sorting criteria for scheduling objects received from LLC.
Ptr< SatBbFrameConf >	m_bbFrameConf
	Configured BB Frame conf.
double	m_carrierBandwidthInHz
	Carrier bandwidth in hertz where scheduler is associated to.
Time	m_cnoEstimationWindow
	Time window for C/N0 estimation.
CnoEstimatorMap_t	m_cnoEstimatorContainer
	C/N0 estimator per UT.
SatCnoEstimator::EstimationMode_t	m_cnoEstimatorMode
	Mode used for C/N0 estimator.
bool	m_dummyFrameSendingEnabled
	Flag indicating if Dummy Frames are sent or not.
Mac48Address	m_macAddress
	MAC address of the this instance (node).
Time	m_periodicInterval
	The interval for periodic scheduling timer.
Ptr< UniformRandomVariable >	m_random
	Random variable used in FWD link scheduling.
SatFwdLinkScheduler::SchedContextCallback	m_schedContextCallback
	The scheduling context getter callback.
TracedCallback< uint8_t, double >	m_schedulingSymbolRateTrace
	Traced callback for symbol rate, with flowId, requested Modcod info.
SatFwdLinkScheduler::SendControlMsgCallback	m_sendControlMsgCallback
	The control message sender callback.
SatFwdLinkScheduler::TxOpportunityCallback	m_txOpportunityCallback
	Callback to notify the txOpportunity to upper layer Returns a packet Attributes: payload in bytes.

Detailed Description

SatFwdLinkScheduler schedules BB frames for forward link.

In every GW MAC is assigned own instance of the SatFwdLinkScheduler. To handle BB frames and maintain queues for the them, it utilizes BB frame container given as attribute.

SatFwdLinkScheduler communicated through callback functions to request scheduling objects and notifying TX opportunities.

   GW MAC requests frames from scheduler through method GetNextFrame.

Definition at line 68 of file satellite-fwd-link-scheduler.h.

Member Typedef Documentation

◆ CnoEstimatorMap_t

typedef std::map<Mac48Address, Ptr<SatCnoEstimator> > ns3::SatFwdLinkScheduler::CnoEstimatorMap_t

protected

Definition at line 243 of file satellite-fwd-link-scheduler.h.

◆ SchedContextCallback

typedef Callback<void, std::vector<Ptr<SatSchedulingObject> >&> ns3::SatFwdLinkScheduler::SchedContextCallback

Callback to get scheduling contexts from upper layer.

Parameters

vector of scheduling contexts

Definition at line 166 of file satellite-fwd-link-scheduler.h.

◆ SendControlMsgCallback

typedef Callback<bool, Ptr<SatControlMessage>, const Address&> ns3::SatFwdLinkScheduler::SendControlMsgCallback

Callback to notify upper layer about Tx opportunity.

Parameters

Ptr<SatControlMessage>	The control message to send.
Address&	the destination MAC address.

Returns: True

Definition at line 186 of file satellite-fwd-link-scheduler.h.

◆ TxOpportunityCallback

typedef Callback<Ptr<Packet>, uint32_t, Mac48Address, uint8_t, uint32_t&, uint32_t&> ns3::SatFwdLinkScheduler::TxOpportunityCallback

Callback to notify upper layer about Tx opportunity.

Parameters

Mac48Address	address
uint32_t	payload size in bytes
uint8_t	Flow identifier
uint32_t&	Bytes left
uint32_t&	Next min TxO

Returns: packet Packet to be transmitted to PHY

Definition at line 178 of file satellite-fwd-link-scheduler.h.

Member Enumeration Documentation

◆ ScheduleSortingCriteria_t

enum ns3::SatFwdLinkScheduler::ScheduleSortingCriteria_t

Types for sorting algorithm used by forward link scheduler.

Enumerator
NO_SORT	NO_SORT.
BUFFERING_DELAY_SORT	BUFFERING_DELAY_SORT.
BUFFERING_LOAD_SORT	BUFFERING_LOAD_SORT.
RANDOM_SORT	RANDOM_SORT.
PRIORITY_SORT	PRIORITY_SORT.

Definition at line 74 of file satellite-fwd-link-scheduler.h.

Constructor & Destructor Documentation

◆ SatFwdLinkScheduler() [1/3]

ns3::SatFwdLinkScheduler::SatFwdLinkScheduler ( )

Construct a SatFwdLinkScheduler.

This the default constructor for the SatFwdLinkScheduler is not supported.

Definition at line 164 of file satellite-fwd-link-scheduler.cc.

References SatFwdLinkScheduler(), m_additionalSortCriteria, m_carrierBandwidthInHz, m_cnoEstimatorMode, and NO_SORT.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SatFwdLinkScheduler() [2/3]

ns3::SatFwdLinkScheduler::SatFwdLinkScheduler	(	Ptr< SatBbFrameConf >	conf,
		Mac48Address	address,
		double	carrierBandwidthInHz )

Actual constructor of a SatFwdLinkScheduler.

Parameters

conf	BB Frame configuration
address	MAC address
carrierBandwidthInHz	Carrier bandwidth where scheduler is associated to [Hz].

Definition at line 173 of file satellite-fwd-link-scheduler.cc.

References SatFwdLinkScheduler(), m_additionalSortCriteria, m_bbFrameConf, m_carrierBandwidthInHz, m_cnoEstimatorMode, m_macAddress, m_random, and NO_SORT.

Here is the call graph for this function:

◆ ~SatFwdLinkScheduler()

ns3::SatFwdLinkScheduler::~SatFwdLinkScheduler ( )

Destroy a SatFwdLinkScheduler.

This is the destructor for the SatFwdLinkScheduler.

Definition at line 198 of file satellite-fwd-link-scheduler.cc.

◆ SatFwdLinkScheduler() [3/3]

ns3::SatFwdLinkScheduler::SatFwdLinkScheduler ( const SatFwdLinkScheduler & )

protected

References SatFwdLinkScheduler().

Here is the call graph for this function:

Member Function Documentation

◆ ClearAllPackets()

void ns3::SatFwdLinkScheduler::ClearAllPackets ( )

virtual

Remove all packets being treated.

Reimplemented in ns3::SatFwdLinkSchedulerDefault, and ns3::SatFwdLinkSchedulerTimeSlicing.

Definition at line 291 of file satellite-fwd-link-scheduler.cc.

◆ CnoInfoUpdated()

void ns3::SatFwdLinkScheduler::CnoInfoUpdated	(	Mac48Address	utAddress,
		double	cnoEstimate )

Called when UT's C/N0 estimation is updated.

Parameters

utAddress	Address of the UT updated C/N0 info.
cnoEstimate	Value of the estimated C/N0.

Definition at line 252 of file satellite-fwd-link-scheduler.cc.

References CreateCnoEstimator(), and m_cnoEstimatorContainer.

Here is the call graph for this function:

◆ CnoMatchWithFrame()

bool ns3::SatFwdLinkScheduler::CnoMatchWithFrame	(	double	cno,
		Ptr< SatBbFrame >	frame ) const

protected

Check if given estimated C/N0 match with given frame.

Parameters

cno	Estimated C/N0 value.
frame	Frame to match

Returns: True if C/N0 match with frame false otherwise.

Definition at line 353 of file satellite-fwd-link-scheduler.cc.

References m_bbFrameConf.

◆ CompareSoFlowId()

bool ns3::SatFwdLinkScheduler::CompareSoFlowId	(	Ptr< SatSchedulingObject >	obj1,
		Ptr< SatSchedulingObject >	obj2 )

static

Compares to scheduling objects priorities.

Parameters

obj1	First object to compare
obj2	Second object to compare

Returns: true if first object priority is considered to be higher that second object, false otherwise

Definition at line 73 of file satellite-fwd-link-scheduler.cc.

Referenced by CompareSoPriorityHol(), CompareSoPriorityLoad(), and SortSchedulingObjects().

Here is the caller graph for this function:

◆ CompareSoPriorityHol()

bool ns3::SatFwdLinkScheduler::CompareSoPriorityHol	(	Ptr< SatSchedulingObject >	obj1,
		Ptr< SatSchedulingObject >	obj2 )

static

Compares to scheduling objects priorities and HOL.

Parameters

obj1	First object to compare
obj2	Second object to compare

Returns: true if first object priority is considered to be higher that second object or if priorities are same first object HOL is considered to be higher, false otherwise

Definition at line 93 of file satellite-fwd-link-scheduler.cc.

References CompareSoFlowId().

Referenced by SortSchedulingObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CompareSoPriorityLoad()

bool ns3::SatFwdLinkScheduler::CompareSoPriorityLoad	(	Ptr< SatSchedulingObject >	obj1,
		Ptr< SatSchedulingObject >	obj2 )

static

Compares to scheduling objects priorities and load.

Parameters

obj1	First object to compare
obj2	Second object to compare

Returns: true if first object priority is considered to be higher that second object or if priorities are same first object load is considered to be higher, false otherwise

Definition at line 79 of file satellite-fwd-link-scheduler.cc.

References CompareSoFlowId().

Referenced by SortSchedulingObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateCnoEstimator()

Ptr< SatCnoEstimator > ns3::SatFwdLinkScheduler::CreateCnoEstimator ( )

protected

Create estimator for the UT according to set attributes.

Returns: pointer to created estimator

Definition at line 387 of file satellite-fwd-link-scheduler.cc.

References ns3::SatCnoEstimator::AVERAGE, ns3::SatCnoEstimator::LAST, m_cnoEstimationWindow, m_cnoEstimatorMode, and ns3::SatCnoEstimator::MINIMUM.

Referenced by CnoInfoUpdated().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::SatFwdLinkScheduler::DoDispose ( void )

protected

Do dispose actions.

Definition at line 204 of file satellite-fwd-link-scheduler.cc.

References m_cnoEstimatorContainer, m_schedContextCallback, m_sendControlMsgCallback, and m_txOpportunityCallback.

Referenced by ns3::SatFwdLinkSchedulerDefault::DoDispose(), ns3::SatFwdLinkSchedulerTimeSlicing::DoDispose(), and ns3::SatScpcScheduler::DoDispose().

Here is the caller graph for this function:

◆ GetDefaultFrameDuration()

Time ns3::SatFwdLinkScheduler::GetDefaultFrameDuration ( ) const

Return the BB frame duration of the default frame format, i.e.

default MODCOD and NORMAL frame type. This is used by the GW MAC to schedule next txop events if it is disabled.

Returns: Default frame duration in Time

Definition at line 276 of file satellite-fwd-link-scheduler.cc.

References m_bbFrameConf, and ns3::SatEnums::NORMAL_FRAME.

◆ GetNextFrame()

std::pair< Ptr< SatBbFrame >, const Time > ns3::SatFwdLinkScheduler::GetNextFrame ( )

virtual

Get next frame to be transmitted.

Returns: Pointer to frame

Reimplemented in ns3::SatFwdLinkSchedulerDefault, ns3::SatFwdLinkSchedulerTimeSlicing, and ns3::SatScpcScheduler.

Definition at line 242 of file satellite-fwd-link-scheduler.cc.

References m_bbFrameConf.

◆ GetSchedulingObjectCno()

double ns3::SatFwdLinkScheduler::GetSchedulingObjectCno ( Ptr< SatSchedulingObject > ob )

protected

Parameters

Scheduling object

Returns: C/N0 estimated for object. NAN, if estimate is not available.

Definition at line 370 of file satellite-fwd-link-scheduler.cc.

References m_cnoEstimatorContainer.

Referenced by ns3::SatFwdLinkSchedulerDefault::ScheduleBbFrames(), ns3::SatFwdLinkSchedulerTimeSlicing::ScheduleBbFrames(), and ns3::SatScpcScheduler::ScheduleBbFrames().

Here is the caller graph for this function:

◆ GetSchedulingObjects()

void ns3::SatFwdLinkScheduler::GetSchedulingObjects ( std::vector< Ptr< SatSchedulingObject > > & output )

protected

Gets scheduling object in sorted order according to configured sorting criteria.

Parameters

output reference to a vector which will be filled with pointers to the scheduling objects available for scheduling.

Definition at line 310 of file satellite-fwd-link-scheduler.cc.

◆ GetTypeId()

TypeId ns3::SatFwdLinkScheduler::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 107 of file satellite-fwd-link-scheduler.cc.

References ns3::SatCnoEstimator::AVERAGE, BUFFERING_DELAY_SORT, BUFFERING_LOAD_SORT, ns3::SatCnoEstimator::LAST, m_additionalSortCriteria, m_bbFrameConf, m_cnoEstimationWindow, m_cnoEstimatorMode, m_dummyFrameSendingEnabled, m_periodicInterval, m_schedulingSymbolRateTrace, ns3::SatCnoEstimator::MINIMUM, and NO_SORT.

◆ NotifyConstructionCompleted()

void ns3::SatFwdLinkScheduler::NotifyConstructionCompleted ( )

overridevirtual

Notifier called once the ObjectBase is fully constructed.

This method is invoked once all member attributes have been initialized. Subclasses can override this method to be notified of this event but if they do this, they must chain up to their parent's NotifyConstructionCompleted method.

Reimplemented in ns3::SatFwdLinkSchedulerDefault, ns3::SatFwdLinkSchedulerTimeSlicing, and ns3::SatScpcScheduler.

Definition at line 189 of file satellite-fwd-link-scheduler.cc.

References m_periodicInterval, and PeriodicTimerExpired().

Referenced by ns3::SatFwdLinkSchedulerDefault::NotifyConstructionCompleted(), ns3::SatFwdLinkSchedulerTimeSlicing::NotifyConstructionCompleted(), and ns3::SatScpcScheduler::NotifyConstructionCompleted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

SatFwdLinkScheduler & ns3::SatFwdLinkScheduler::operator= ( const SatFwdLinkScheduler & )

protected

References SatFwdLinkScheduler().

Here is the call graph for this function:

◆ PeriodicTimerExpired()

void ns3::SatFwdLinkScheduler::PeriodicTimerExpired ( )

protected

Handles periodic timer timeouts.

Definition at line 299 of file satellite-fwd-link-scheduler.cc.

References m_periodicInterval, PeriodicTimerExpired(), ScheduleBbFrames(), and SendAndClearSymbolsSentStat().

Referenced by NotifyConstructionCompleted(), and PeriodicTimerExpired().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScheduleBbFrames()

virtual void ns3::SatFwdLinkScheduler::ScheduleBbFrames ( )

protectedpure virtual

Schedule BB Frames.

Implemented in ns3::SatFwdLinkSchedulerDefault, ns3::SatFwdLinkSchedulerTimeSlicing, and ns3::SatScpcScheduler.

Referenced by PeriodicTimerExpired().

Here is the caller graph for this function:

◆ SendAndClearSymbolsSentStat()

virtual void ns3::SatFwdLinkScheduler::SendAndClearSymbolsSentStat ( )

protectedpure virtual

Send stats and reset all the symbols sent count for each slice to zero.

Implemented in ns3::SatFwdLinkSchedulerDefault, ns3::SatFwdLinkSchedulerTimeSlicing, and ns3::SatScpcScheduler.

Referenced by PeriodicTimerExpired().

Here is the caller graph for this function:

◆ SendControlMsg()

bool ns3::SatFwdLinkScheduler::SendControlMsg	(	Ptr< SatControlMessage >	message,
		const Address &	dest ) const

Method te send a control message to a destination.

Parameters

message	The control message to send
dest	The destination mac address

Definition at line 235 of file satellite-fwd-link-scheduler.cc.

References m_sendControlMsgCallback.

◆ SetDummyFrameSendingEnabled()

void ns3::SatFwdLinkScheduler::SetDummyFrameSendingEnabled ( bool dummyFrameSendingEnabled )

Set the value of m_dummyFrameSendingEnabled.

Definition at line 285 of file satellite-fwd-link-scheduler.cc.

References m_dummyFrameSendingEnabled.

◆ SetSchedContextCallback()

void ns3::SatFwdLinkScheduler::SetSchedContextCallback ( SatFwdLinkScheduler::SchedContextCallback cb )

Method to set Tx opportunity callback.

Parameters

cb	callback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Definition at line 214 of file satellite-fwd-link-scheduler.cc.

References m_schedContextCallback.

◆ SetSendControlMsgCallback()

void ns3::SatFwdLinkScheduler::SetSendControlMsgCallback ( SatFwdLinkScheduler::SendControlMsgCallback cb )

Method to set the control message sender callback.

Parameters

cb	callback to invoke whenever a control packet has to be sent.

Definition at line 228 of file satellite-fwd-link-scheduler.cc.

References m_sendControlMsgCallback.

◆ SetTxOpportunityCallback()

void ns3::SatFwdLinkScheduler::SetTxOpportunityCallback ( SatFwdLinkScheduler::TxOpportunityCallback cb )

Method to set Tx opportunity callback.

Parameters

cb	callback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Definition at line 221 of file satellite-fwd-link-scheduler.cc.

References m_txOpportunityCallback.

◆ SortSchedulingObjects()

void ns3::SatFwdLinkScheduler::SortSchedulingObjects ( std::vector< Ptr< SatSchedulingObject > > & so )

protected

Sorts given scheduling objects according to configured sorting criteria.

Parameters

so	Scheduling objects to sort.

Definition at line 316 of file satellite-fwd-link-scheduler.cc.

References BUFFERING_DELAY_SORT, BUFFERING_LOAD_SORT, CompareSoFlowId(), CompareSoPriorityHol(), CompareSoPriorityLoad(), m_additionalSortCriteria, and NO_SORT.

Referenced by ns3::SatFwdLinkSchedulerDefault::GetSchedulingObjects(), ns3::SatFwdLinkSchedulerTimeSlicing::GetSchedulingObjects(), and ns3::SatScpcScheduler::GetSchedulingObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_additionalSortCriteria

ScheduleSortingCriteria_t ns3::SatFwdLinkScheduler::m_additionalSortCriteria

protected

Additional sorting criteria for scheduling objects received from LLC.

Definition at line 335 of file satellite-fwd-link-scheduler.h.

Referenced by SatFwdLinkScheduler(), SatFwdLinkScheduler(), GetTypeId(), and SortSchedulingObjects().

◆ m_bbFrameConf

Ptr<SatBbFrameConf> ns3::SatFwdLinkScheduler::m_bbFrameConf

protected

Configured BB Frame conf.

Definition at line 330 of file satellite-fwd-link-scheduler.h.

Referenced by SatFwdLinkScheduler(), CnoMatchWithFrame(), GetDefaultFrameDuration(), GetNextFrame(), ns3::SatFwdLinkSchedulerDefault::GetNextFrame(), ns3::SatFwdLinkSchedulerTimeSlicing::GetNextFrame(), ns3::SatScpcScheduler::GetNextFrame(), GetTypeId(), ns3::SatFwdLinkSchedulerDefault::NotifyConstructionCompleted(), ns3::SatFwdLinkSchedulerTimeSlicing::NotifyConstructionCompleted(), ns3::SatScpcScheduler::NotifyConstructionCompleted(), ns3::SatFwdLinkSchedulerDefault::ScheduleBbFrames(), ns3::SatFwdLinkSchedulerTimeSlicing::ScheduleBbFrames(), and ns3::SatScpcScheduler::ScheduleBbFrames().

◆ m_carrierBandwidthInHz

double ns3::SatFwdLinkScheduler::m_carrierBandwidthInHz

protected

Carrier bandwidth in hertz where scheduler is associated to.

Definition at line 372 of file satellite-fwd-link-scheduler.h.

Referenced by SatFwdLinkScheduler(), SatFwdLinkScheduler(), ns3::SatFwdLinkSchedulerDefault::GetNextFrame(), ns3::SatFwdLinkSchedulerTimeSlicing::GetNextFrame(), ns3::SatScpcScheduler::GetNextFrame(), ns3::SatFwdLinkSchedulerTimeSlicing::GetSymbols(), ns3::SatFwdLinkSchedulerTimeSlicing::NotifyConstructionCompleted(), ns3::SatFwdLinkSchedulerDefault::ScheduleBbFrames(), ns3::SatFwdLinkSchedulerTimeSlicing::ScheduleBbFrames(), and ns3::SatScpcScheduler::ScheduleBbFrames().

◆ m_cnoEstimationWindow

Time ns3::SatFwdLinkScheduler::m_cnoEstimationWindow

protected

Time window for C/N0 estimation.

Definition at line 367 of file satellite-fwd-link-scheduler.h.

Referenced by CreateCnoEstimator(), and GetTypeId().

◆ m_cnoEstimatorContainer

CnoEstimatorMap_t ns3::SatFwdLinkScheduler::m_cnoEstimatorContainer

protected

C/N0 estimator per UT.

Definition at line 357 of file satellite-fwd-link-scheduler.h.

Referenced by CnoInfoUpdated(), DoDispose(), and GetSchedulingObjectCno().

◆ m_cnoEstimatorMode

SatCnoEstimator::EstimationMode_t ns3::SatFwdLinkScheduler::m_cnoEstimatorMode

protected

Mode used for C/N0 estimator.

Definition at line 362 of file satellite-fwd-link-scheduler.h.

Referenced by SatFwdLinkScheduler(), SatFwdLinkScheduler(), CreateCnoEstimator(), and GetTypeId().

◆ m_dummyFrameSendingEnabled

bool ns3::SatFwdLinkScheduler::m_dummyFrameSendingEnabled

protected

Flag indicating if Dummy Frames are sent or not.

false means that only transmission time is simulated without sending.

Definition at line 314 of file satellite-fwd-link-scheduler.h.

Referenced by ns3::SatFwdLinkSchedulerDefault::GetNextFrame(), ns3::SatFwdLinkSchedulerTimeSlicing::GetNextFrame(), ns3::SatScpcScheduler::GetNextFrame(), GetTypeId(), and SetDummyFrameSendingEnabled().

◆ m_macAddress

Mac48Address ns3::SatFwdLinkScheduler::m_macAddress

protected

MAC address of the this instance (node).

Definition at line 308 of file satellite-fwd-link-scheduler.h.

Referenced by SatFwdLinkScheduler(), ns3::SatFwdLinkSchedulerDefault::GetNextFrame(), ns3::SatFwdLinkSchedulerTimeSlicing::GetNextFrame(), and ns3::SatScpcScheduler::GetNextFrame().

◆ m_periodicInterval

Time ns3::SatFwdLinkScheduler::m_periodicInterval

protected

The interval for periodic scheduling timer.

Timer is evaluated by scheduling calls to PeriodicTimerExpired.

Definition at line 325 of file satellite-fwd-link-scheduler.h.

Referenced by ns3::SatFwdLinkSchedulerTimeSlicing::CanOpenBbFrame(), ns3::SatFwdLinkSchedulerTimeSlicing::GetNextFrame(), ns3::SatFwdLinkSchedulerTimeSlicing::GetSchedulingObjects(), GetTypeId(), NotifyConstructionCompleted(), ns3::SatFwdLinkSchedulerTimeSlicing::NotifyConstructionCompleted(), PeriodicTimerExpired(), and ns3::SatFwdLinkSchedulerTimeSlicing::ScheduleBbFrames().

◆ m_random

Ptr<UniformRandomVariable> ns3::SatFwdLinkScheduler::m_random

protected

Random variable used in FWD link scheduling.

Definition at line 319 of file satellite-fwd-link-scheduler.h.

Referenced by SatFwdLinkScheduler().

◆ m_schedContextCallback

SatFwdLinkScheduler::SchedContextCallback ns3::SatFwdLinkScheduler::m_schedContextCallback

protected

The scheduling context getter callback.

Definition at line 347 of file satellite-fwd-link-scheduler.h.

Referenced by DoDispose(), ns3::SatFwdLinkSchedulerDefault::GetSchedulingObjects(), ns3::SatFwdLinkSchedulerTimeSlicing::GetSchedulingObjects(), ns3::SatScpcScheduler::GetSchedulingObjects(), and SetSchedContextCallback().

◆ m_schedulingSymbolRateTrace

TracedCallback<uint8_t, double> ns3::SatFwdLinkScheduler::m_schedulingSymbolRateTrace

protected

Traced callback for symbol rate, with flowId, requested Modcod info.

Definition at line 377 of file satellite-fwd-link-scheduler.h.

Referenced by GetTypeId(), ns3::SatFwdLinkSchedulerDefault::SendAndClearSymbolsSentStat(), ns3::SatFwdLinkSchedulerTimeSlicing::SendAndClearSymbolsSentStat(), and ns3::SatScpcScheduler::SendAndClearSymbolsSentStat().

◆ m_sendControlMsgCallback

SatFwdLinkScheduler::SendControlMsgCallback ns3::SatFwdLinkScheduler::m_sendControlMsgCallback

protected

The control message sender callback.

Definition at line 352 of file satellite-fwd-link-scheduler.h.

Referenced by DoDispose(), SendControlMsg(), ns3::SatFwdLinkSchedulerTimeSlicing::SendTimeSliceSubscription(), and SetSendControlMsgCallback().

◆ m_txOpportunityCallback

SatFwdLinkScheduler::TxOpportunityCallback ns3::SatFwdLinkScheduler::m_txOpportunityCallback

protected

Callback to notify the txOpportunity to upper layer Returns a packet Attributes: payload in bytes.

Definition at line 342 of file satellite-fwd-link-scheduler.h.

Referenced by DoDispose(), ns3::SatFwdLinkSchedulerDefault::ScheduleBbFrames(), ns3::SatFwdLinkSchedulerTimeSlicing::ScheduleBbFrames(), ns3::SatScpcScheduler::ScheduleBbFrames(), and SetTxOpportunityCallback().

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

/builds/sns3/satellite/satellite/model/satellite-fwd-link-scheduler.h
/builds/sns3/satellite/satellite/model/satellite-fwd-link-scheduler.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CnoEstimatorMap_t

◆ SchedContextCallback

◆ SendControlMsgCallback

◆ TxOpportunityCallback

Member Enumeration Documentation

◆ ScheduleSortingCriteria_t

Constructor & Destructor Documentation

◆ SatFwdLinkScheduler() [1/3]

◆ SatFwdLinkScheduler() [2/3]

◆ ~SatFwdLinkScheduler()

◆ SatFwdLinkScheduler() [3/3]

Member Function Documentation

◆ ClearAllPackets()

◆ CnoInfoUpdated()

◆ CnoMatchWithFrame()

◆ CompareSoFlowId()

◆ CompareSoPriorityHol()

◆ CompareSoPriorityLoad()

◆ CreateCnoEstimator()

◆ DoDispose()

◆ GetDefaultFrameDuration()

◆ GetNextFrame()

◆ GetSchedulingObjectCno()

◆ GetSchedulingObjects()

◆ GetTypeId()

◆ NotifyConstructionCompleted()

◆ operator=()

◆ PeriodicTimerExpired()

◆ ScheduleBbFrames()

◆ SendAndClearSymbolsSentStat()

◆ SendControlMsg()

◆ SetDummyFrameSendingEnabled()

◆ SetSchedContextCallback()

◆ SetSendControlMsgCallback()

◆ SetTxOpportunityCallback()

◆ SortSchedulingObjects()

Member Data Documentation

◆ m_additionalSortCriteria

◆ m_bbFrameConf

◆ m_carrierBandwidthInHz

◆ m_cnoEstimationWindow

◆ m_cnoEstimatorContainer

◆ m_cnoEstimatorMode

◆ m_dummyFrameSendingEnabled

◆ m_macAddress

◆ m_periodicInterval

◆ m_random

◆ m_schedContextCallback

◆ m_schedulingSymbolRateTrace

◆ m_sendControlMsgCallback

◆ m_txOpportunityCallback