Loading...
Searching...
No Matches
ns3::SatBeamScheduler::SatUtInfo Class Reference

UT information helper class for SatBeamScheduler. More...

Inheritance diagram for ns3::SatBeamScheduler::SatUtInfo:
Collaboration diagram for ns3::SatBeamScheduler::SatUtInfo:

Public Member Functions

 SatUtInfo (Ptr< SatDamaEntry > damaEntry, Ptr< SatCnoEstimator > cnoEstimator, Time controlSlotOffset, bool controlSlotsEnabled)
 Construct SatUtInfo.
void AddCnoSample (double sample)
 Add C/N0 sample to UT info's estimator.
void AddCrMsg (Ptr< SatCrMessage > crMsg)
 Add CR message to UT info to be used when capacity request is calculated next time (method UpdateDamaEntryFromCrs is called).
void ClearCrMsgs ()
 Remove all CR messages from UT info to reset capacity requests in case of handover.
double GetCnoEstimation ()
 Get estimated C/N0 value based on added samples.
Ptr< SatDamaEntry > GetDamaEntry ()
 Get damaEntry of the UT info.
bool IsControlSlotGenerationTime () const
 Check if time is expired to send control slot.
void SetControlSlotGenerationTime (Time offset)
 Set time for next time slot generation for this UT.
void UpdateDamaEntryFromCrs ()
 Update DamaEntry with information of the received CR messages.

Private Types

typedef std::vector< Ptr< SatCrMessage > > CrMsgContainer_t
 Container to store received CR messages.

Private Attributes

Ptr< SatCnoEstimator > m_cnoEstimator
 Estimator for the C/N0.
Time m_controlSlotGenerationTime
 Time to send next control time slot.
bool m_controlSlotsEnabled
 Flag to indicated if control time slots generation is enabled.
CrMsgContainer_t m_crContainer
 Received CRs since last update round (call of the method UpdateDamaEntryFromCrs).
Ptr< SatDamaEntry > m_damaEntry
 DamaEntry of this UT info.

Detailed Description

UT information helper class for SatBeamScheduler.

Stores capacity request and C/N0 estimation information of the UT.

Definition at line 352 of file satellite-beam-scheduler.h.

Member Typedef Documentation

◆ CrMsgContainer_t

typedef std::vector<Ptr<SatCrMessage> > ns3::SatBeamScheduler::SatUtInfo::CrMsgContainer_t
private

Container to store received CR messages.

Definition at line 427 of file satellite-beam-scheduler.h.

Constructor & Destructor Documentation

◆ SatUtInfo()

ns3::SatBeamScheduler::SatUtInfo::SatUtInfo ( Ptr< SatDamaEntry > damaEntry,
Ptr< SatCnoEstimator > cnoEstimator,
Time controlSlotOffset,
bool controlSlotsEnabled )

Construct SatUtInfo.

Parameters
damaEntryDamaEntry for created UT info.
cnoEstimatorC/N0 estimator for the UT info.
controlSlotOffsetOffset of the current moment to generate control slot.
controlSlotsEnabledFlag to tell if control slots generation is enabled according to controlSlotOffset

Definition at line 58 of file satellite-beam-scheduler.cc.

References m_cnoEstimator, m_controlSlotsEnabled, m_damaEntry, and SetControlSlotGenerationTime().

Here is the call graph for this function:

Member Function Documentation

◆ AddCnoSample()

void ns3::SatBeamScheduler::SatUtInfo::AddCnoSample ( double sample)

Add C/N0 sample to UT info's estimator.

Parameters
sampleC/N0 sample value to add.

Definition at line 141 of file satellite-beam-scheduler.cc.

References m_cnoEstimator.

◆ AddCrMsg()

void ns3::SatBeamScheduler::SatUtInfo::AddCrMsg ( Ptr< SatCrMessage > crMsg)

Add CR message to UT info to be used when capacity request is calculated next time (method UpdateDamaEntryFromCrs is called).

Parameters
crMsg

Definition at line 149 of file satellite-beam-scheduler.cc.

References m_crContainer.

◆ ClearCrMsgs()

void ns3::SatBeamScheduler::SatUtInfo::ClearCrMsgs ( )

Remove all CR messages from UT info to reset capacity requests in case of handover.

Definition at line 157 of file satellite-beam-scheduler.cc.

References m_crContainer.

◆ GetCnoEstimation()

double ns3::SatBeamScheduler::SatUtInfo::GetCnoEstimation ( )

Get estimated C/N0 value based on added samples.

Returns
C/N0 estimation.

Definition at line 133 of file satellite-beam-scheduler.cc.

References m_cnoEstimator.

◆ GetDamaEntry()

Ptr< SatDamaEntry > ns3::SatBeamScheduler::SatUtInfo::GetDamaEntry ( )

Get damaEntry of the UT info.

Returns
Pointer to DamEntry of the UT info.

Definition at line 72 of file satellite-beam-scheduler.cc.

References m_damaEntry.

◆ IsControlSlotGenerationTime()

bool ns3::SatBeamScheduler::SatUtInfo::IsControlSlotGenerationTime ( ) const

Check if time is expired to send control slot.

Returns
Status of control slot generation time.

Definition at line 165 of file satellite-beam-scheduler.cc.

References m_controlSlotGenerationTime, and m_controlSlotsEnabled.

◆ SetControlSlotGenerationTime()

void ns3::SatBeamScheduler::SatUtInfo::SetControlSlotGenerationTime ( Time offset)

Set time for next time slot generation for this UT.

Parameters
offsetOffset of the current moment to generate control slot.

Definition at line 180 of file satellite-beam-scheduler.cc.

References m_controlSlotGenerationTime.

Referenced by SatUtInfo().

Here is the caller graph for this function:

◆ UpdateDamaEntryFromCrs()

void ns3::SatBeamScheduler::SatUtInfo::UpdateDamaEntryFromCrs ( )

Update DamaEntry with information of the received CR messages.

Definition at line 80 of file satellite-beam-scheduler.cc.

References ns3::SatEnums::DA_AVBDC, ns3::SatEnums::DA_RBDC, ns3::SatEnums::DA_VBDC, m_crContainer, and m_damaEntry.

Member Data Documentation

◆ m_cnoEstimator

Ptr<SatCnoEstimator> ns3::SatBeamScheduler::SatUtInfo::m_cnoEstimator
private

Estimator for the C/N0.

Definition at line 437 of file satellite-beam-scheduler.h.

Referenced by SatUtInfo(), AddCnoSample(), and GetCnoEstimation().

◆ m_controlSlotGenerationTime

Time ns3::SatBeamScheduler::SatUtInfo::m_controlSlotGenerationTime
private

Time to send next control time slot.

Definition at line 447 of file satellite-beam-scheduler.h.

Referenced by IsControlSlotGenerationTime(), and SetControlSlotGenerationTime().

◆ m_controlSlotsEnabled

bool ns3::SatBeamScheduler::SatUtInfo::m_controlSlotsEnabled
private

Flag to indicated if control time slots generation is enabled.

Definition at line 452 of file satellite-beam-scheduler.h.

Referenced by SatUtInfo(), and IsControlSlotGenerationTime().

◆ m_crContainer

CrMsgContainer_t ns3::SatBeamScheduler::SatUtInfo::m_crContainer
private

Received CRs since last update round (call of the method UpdateDamaEntryFromCrs).

Definition at line 442 of file satellite-beam-scheduler.h.

Referenced by AddCrMsg(), ClearCrMsgs(), and UpdateDamaEntryFromCrs().

◆ m_damaEntry

Ptr<SatDamaEntry> ns3::SatBeamScheduler::SatUtInfo::m_damaEntry
private

DamaEntry of this UT info.

Definition at line 432 of file satellite-beam-scheduler.h.

Referenced by SatUtInfo(), GetDamaEntry(), and UpdateDamaEntryFromCrs().

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