Searching...

No Matches

Assign entire symbols in a proportional fair fashion. More...

#include "nr-mac-scheduler-tdma-pf.h"

Inheritance diagram for ns3::NrMacSchedulerTdmaPF:

Collaboration diagram for ns3::NrMacSchedulerTdmaPF:

Public Member Functions
	NrMacSchedulerTdmaPF ()
	NrMacSchedulerTdmaPF constructor.

	~NrMacSchedulerTdmaPF () override
	~NrMacSchedulerTdmaPF deconstructor

double	GetFairnessIndex () const
	Get the value of attribute "FairnessIndex".

double	GetTimeWindow () const
	Get the attribute "LastAvgTPutWeight".

void	SetFairnessIndex (double v)
	Set the value of attribute "FairnessIndex".

void	SetTimeWindow (double v)
	Set the attribute "LastAvgTPutWeight".

Public Member Functions inherited from ns3::NrMacSchedulerTdmaRR
	NrMacSchedulerTdmaRR ()
	NrMacSchedulerTdmaRR constructor.

	~NrMacSchedulerTdmaRR () override
	~NrMacSchedulerTdmaRR deconstructor

Public Member Functions inherited from ns3::NrMacSchedulerTdma
	NrMacSchedulerTdma ()
	NrMacSchedulerTdma constructor.

	~NrMacSchedulerTdma () override
	NrMacSchedulerTdma deconstructor.

Public Member Functions inherited from ns3::NrMacSchedulerNs3
	NrMacSchedulerNs3 ()
	NrMacSchedulerNs3 default constructor.

	NrMacSchedulerNs3 (const NrMacSchedulerNs3 &other)=delete
	NrMacSchedulerNs3 copy constructor (deleted)

	~NrMacSchedulerNs3 () override
	NrMacSchedulerNs3 deconstructor.

int64_t	AssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.

void	DoCschedCellConfigReq (const NrMacCschedSapProvider::CschedCellConfigReqParameters &params) override
	Cell configuration.

void	DoCschedLcConfigReq (const NrMacCschedSapProvider::CschedLcConfigReqParameters &params) override
	Configure a logical channel for a UE.

void	DoCschedLcReleaseReq (const NrMacCschedSapProvider::CschedLcReleaseReqParameters &params) override
	Release a LC.

void	DoCschedUeConfigReq (const NrMacCschedSapProvider::CschedUeConfigReqParameters &params) override
	Register an UE.

void	DoCschedUeReleaseReq (const NrMacCschedSapProvider::CschedUeReleaseReqParameters &params) override
	Release an UE.

void	DoSchedDlCqiInfoReq (const NrMacSchedSapProvider::SchedDlCqiInfoReqParameters &params) override
	Received a DL CQI message.

void	DoSchedDlRachInfoReq (const NrMacSchedSapProvider::SchedDlRachInfoReqParameters &params) override
	RACH information.

void	DoSchedDlRlcBufferReq (const NrMacSchedSapProvider::SchedDlRlcBufferReqParameters &params) override
	RLC informs of DL data.

void	DoSchedDlTriggerReq (const NrMacSchedSapProvider::SchedDlTriggerReqParameters &params) override
	Decide how to fill the frequency/time of a DL slot.

void	DoSchedSetMcs (uint32_t mcs) override
	Set a fixed MCS.

void	DoSchedUlCqiInfoReq (const NrMacSchedSapProvider::SchedUlCqiInfoReqParameters &params) override
	Received a UL CQI message.

void	DoSchedUlMacCtrlInfoReq (const NrMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params) override
	Evaluate different types of control messages (only BSR for the moment)

void	DoSchedUlSrInfoReq (const NrMacSchedSapProvider::SchedUlSrInfoReqParameters &params) override
	Save the SR list into m_srList.

void	DoSchedUlTriggerReq (const NrMacSchedSapProvider::SchedUlTriggerReqParameters &params) override
	Decide how to fill the frequency/time of a UL slot.

void	EnableHarqReTx (bool enableFlag)
	Enable HARQ ReTx function.

Time	GetCqiTimerThreshold () const
	Get the CqiTimerThreshold.

Ptr< const NrAmc >	GetDlAmc () const
	Get the AMC for DL.

uint8_t	GetDlCtrlSyms () const override
	Retrieve the number of DL ctrl symbols configured in the scheduler.

std::vector< uint8_t >	GetDlNotchedRbgMask () const
	Get the notched (blank) RBGs Mask for the DL.

int8_t	GetMaxDlMcs () const
	Get the maximum DL MCS index.

uint8_t	GetSrsCtrlSyms () const
	Get the configured value for the SRS symbols.

uint8_t	GetStartMcsDl () const
	Get the DL MCS starting value.

uint8_t	GetStartMcsUl () const
	Get the DL MCS starting value.

Ptr< const NrAmc >	GetUlAmc () const
	Get the AMC for UL.

uint8_t	GetUlCtrlSyms () const override
	Retrieve the number of UL ctrl symbols configured in the scheduler.

std::vector< uint8_t >	GetUlNotchedRbgMask () const
	Get the notched (blank) RBGs Mask for the UL.

void	InstallDlAmc (const Ptr< NrAmc > &dlAmc)
	Install the AMC for the DL part.

void	InstallUlAmc (const Ptr< NrAmc > &ulAmc)
	Install the AMC for the DL part.

bool	IsDlMcsFixed () const
	Check if the MCS in DL is fixed.

bool	IsHarqReTxEnable () const
	Is HARQ ReTx enable function.

bool	IsSrsInFSlots () const
	Check if the F slots are allowed for SRS transmission.

bool	IsSrsInUlSlots () const
	Check if the UL slots are allowed for SRS transmission.

bool	IsUlMcsFixed () const
	Check if the MCS in UL is fixed.

void	SetCqiTimerThreshold (const Time &v)
	Set the CqiTimerThreshold.

void	SetDlCtrlSyms (uint8_t v)
	Set the number of DL ctrl symbols.

void	SetDlNotchedRbgMask (const std::vector< uint8_t > &dlNotchedRbgsMask)
	Set the notched (blank) RBGs Mask for the DL.

void	SetFixedDlMcs (bool v)
	Set if the MCS in DL is fixed (in case, it will take the starting value)

void	SetFixedUlMcs (bool v)
	Set if the MCS in UL is fixed (in case, it will take the starting value)

void	SetLcSched (const TypeId &type)
	Set LC Scheduler Algorithm model type.

void	SetMaxDlMcs (int8_t v)
	Set the maximum index for the DL MCS.

void	SetRachUlGrantMcs (uint8_t v)
	Sets the default RACH UL grant MCS.

void	SetSrsCtrlSyms (uint8_t v)
	Set the number of UL SRS symbols.

void	SetSrsInFSlots (bool v)
	Set if the F slots are allowed for SRS transmission.

void	SetSrsInUlSlots (bool v)
	Set if the UL slots are allowed for SRS transmission (if True, UL and F slots may carry SRS, if False, SRS are transmitted only in F slots)

void	SetStartMcsDl (uint8_t v)
	Set the starting value for the DL MCS.

void	SetStartMcsUl (uint8_t v)
	Set the starting value for the UL MCS.

void	SetUlCtrlSyms (uint8_t v)
	Set the number of UL ctrl symbols.

void	SetUlNotchedRbgMask (const std::vector< uint8_t > &ulNotchedRbgsMask)
	Set the notched (blank) RBGs Mask for the UL.

Public Member Functions inherited from ns3::NrMacScheduler
	NrMacScheduler ()
	NrMacScheduler constructor.

	~NrMacScheduler () override
	NrMacScheduler deconstructor.

NrMacCschedSapProvider *	GetMacCschedSapProvider ()
	Get the MacCschedSapProvider pointer.

NrMacSchedSapProvider *	GetMacSchedSapProvider ()
	Get the MacSchedSapProvider pointer.

void	SetMacCschedSapUser (NrMacCschedSapUser *sap)
	SetMacCschedSapUser.

void	SetMacSchedSapUser (NrMacSchedSapUser *sap)
	Set the MacSchedSapUser pointer.

Static Public Member Functions
static TypeId	GetTypeId ()
	GetTypeId.

Static Public Member Functions inherited from ns3::NrMacSchedulerTdmaRR
static TypeId	GetTypeId ()
	GetTypeId.

Static Public Member Functions inherited from ns3::NrMacSchedulerTdma
static TypeId	GetTypeId ()
	GetTypeId.

Static Public Member Functions inherited from ns3::NrMacSchedulerNs3
static TypeId	GetTypeId ()
	GetTypeId.

Static Public Member Functions inherited from ns3::NrMacScheduler
static TypeId	GetTypeId ()
	Get the type id.

Protected Member Functions
void	AssignedDlResources (const UePtrAndBufferReq &ue, const FTResources &assigned, const FTResources &totAssigned) const override
	Update DL metrics by calling NrMacSchedulerUeInfoPF::UpdatePFDlMetric.

void	AssignedUlResources (const UePtrAndBufferReq &ue, const FTResources &assigned, const FTResources &totAssigned) const override
	Update UL metrics by calling NrMacSchedulerUeInfoPF::UpdatePFUlMetric.

void	BeforeDlSched (const UePtrAndBufferReq &ue, const FTResources &assignableInIteration) const override
	Calculate the potential throughput for the DL based on the available resources.

void	BeforeUlSched (const UePtrAndBufferReq &ue, const FTResources &assignableInIteration) const override
	Calculate the potential throughput for the UL based on the available resources.

std::shared_ptr< NrMacSchedulerUeInfo >	CreateUeRepresentation (const NrMacCschedSapProvider::CschedUeConfigReqParameters &params) const override
	Create an UE representation of the type NrMacSchedulerUeInfoPF.

std::function< bool(const NrMacSchedulerNs3::UePtrAndBufferReq &lhs, const NrMacSchedulerNs3::UePtrAndBufferReq &rhs)>	GetUeCompareDlFn () const override
	Return the comparison function to sort DL UE according to the scheduler policy.

std::function< bool(const NrMacSchedulerNs3::UePtrAndBufferReq &lhs, const NrMacSchedulerNs3::UePtrAndBufferReq &rhs)>	GetUeCompareUlFn () const override
	Return the comparison function to sort UL UE according to the scheduler policy.

void	NotAssignedDlResources (const UePtrAndBufferReq &ue, const FTResources &notAssigned, const FTResources &totAssigned) const override
	Update DL metrics by calling NrMacSchedulerUeInfoPF::UpdatePFDlMetric.

void	NotAssignedUlResources (const UePtrAndBufferReq &ue, const FTResources &notAssigned, const FTResources &totAssigned) const override
	Update UL metrics by calling NrMacSchedulerUeInfoPF::UpdatePFUlMetric.

Protected Member Functions inherited from ns3::NrMacSchedulerTdmaRR
void	AssignedDlResources (const UePtrAndBufferReq &ue, const FTResources &assigned, const FTResources &totAssigned) const override
	Update the UE representation after a symbol (DL) has been assigned to it.

void	AssignedUlResources (const UePtrAndBufferReq &ue, const FTResources &assigned, const FTResources &totAssigned) const override
	Update the UE representation after a symbol (DL) has been assigned to it.

void	BeforeDlSched (const UePtrAndBufferReq &ue, const FTResources &assignableInIteration) const override
	Prepare UE for the DL scheduling.

void	BeforeUlSched (const UePtrAndBufferReq &ue, const FTResources &assignableInIteration) const override
	Prepare UE for the UL scheduling.

std::shared_ptr< NrMacSchedulerUeInfo >	CreateUeRepresentation (const NrMacCschedSapProvider::CschedUeConfigReqParameters &params) const override
	Create an UE representation of the type NrMacSchedulerUeInfoRR.

std::function< bool(const NrMacSchedulerNs3::UePtrAndBufferReq &lhs, const NrMacSchedulerNs3::UePtrAndBufferReq &rhs)>	GetUeCompareDlFn () const override
	Return the comparison function to sort DL UE according to the scheduler policy.

std::function< bool(const NrMacSchedulerNs3::UePtrAndBufferReq &lhs, const NrMacSchedulerNs3::UePtrAndBufferReq &rhs)>	GetUeCompareUlFn () const override
	Return the comparison function to sort UL UE according to the scheduler policy.

void	NotAssignedDlResources (const UePtrAndBufferReq &ue, const FTResources &notAssigned, const FTResources &totalAssigned) const override
	Update the UE representation after a symbol (DL) has been assigned to other UE.

void	NotAssignedUlResources (const UePtrAndBufferReq &ue, const FTResources &notAssigned, const FTResources &totalAssigned) const override
	Update the UE representation after a symbol (UL) has been assigned to other UE.

Protected Member Functions inherited from ns3::NrMacSchedulerTdma
BeamSymbolMap	AssignDLRBG (uint32_t symAvail, const ActiveUeMap &activeDl) const override
	Assign the available DL RBG to the UEs.

BeamSymbolMap	AssignULRBG (uint32_t symAvail, const ActiveUeMap &activeUl) const override
	Assign the available UL RBG to the UEs.

void	ChangeDlBeam (PointInFTPlane *spoint, uint32_t symOfBeam) const override
	Not doing anything, moving forward the spoint is done by CreateDci.

void	ChangeUlBeam (PointInFTPlane *spoint, uint32_t symOfBeam) const override
	Not doing anything, moving forward the spoint is done by CreateDci.

std::shared_ptr< DciInfoElementTdma >	CreateDlDci (PointInFTPlane *spoint, const std::shared_ptr< NrMacSchedulerUeInfo > &ueInfo, uint32_t maxSym) const override
	Create a DL DCI starting from spoint and spanning maxSym symbols.

std::shared_ptr< DciInfoElementTdma >	CreateUlDci (PointInFTPlane *spoint, const std::shared_ptr< NrMacSchedulerUeInfo > &ueInfo, uint32_t maxSym) const override
	Create a UL DCI starting from spoint and spanning maxSym symbols.

uint8_t	GetTpc () const override
	Returns TPC command.

Protected Member Functions inherited from ns3::NrMacSchedulerNs3
virtual LCPtr	CreateLC (const nr::LogicalChannelConfigListElement_s &config) const
	Create a logical channel starting from a configuration.

virtual LCGPtr	CreateLCG (const nr::LogicalChannelConfigListElement_s &config) const
	Create a logical channel group starting from a configuration.

uint16_t	GetBandwidthInRbg () const

uint16_t	GetBwpId () const
	Get the bwp id of this MAC.

uint16_t	GetCellId () const
	Get the cell id of this MAC.

uint64_t	GetNumRbPerRbg () const
	Private function that is used to get the number of resource blocks per resource block group and also to check whether this value is configured.

virtual uint8_t	ScheduleDlHarq (NrMacSchedulerNs3::PointInFTPlane startingPoint, uint8_t symAvail, const ActiveHarqMap &activeDlHarq, const std::unordered_map< uint16_t, UePtr > &ueMap, std::vector< DlHarqInfo > dlHarqToRetransmit, const std::vector< DlHarqInfo > &dlHarqFeedback, SlotAllocInfo *slotAlloc) const
	Giving the input, append to slotAlloc the allocations for the DL HARQ retransmissions.

virtual uint8_t	ScheduleUlHarq (NrMacSchedulerNs3::PointInFTPlane startingPoint, uint8_t symAvail, const std::unordered_map< uint16_t, UePtr > &ueMap, std::vector< UlHarqInfo > ulHarqToRetransmit, const std::vector< UlHarqInfo > &ulHarqFeedback, SlotAllocInfo *slotAlloc) const
	Giving the input, append to slotAlloc the allocations for the DL HARQ retransmissions.

virtual void	SortDlHarq (ActiveHarqMap *activeDlHarq) const
	Sort the DL HARQ retransmission.

virtual void	SortUlHarq (ActiveHarqMap *activeUlHarq) const
	Sort the UL HARQ retransmission.

Additional Inherited Members
Public Types inherited from ns3::NrMacSchedulerNs3
typedef std::unordered_map< BeamId, HarqVectorIteratorList, BeamIdHash >	ActiveHarqMap
	Map between a beamID and the HARQ of that beam.

typedef std::unordered_map< BeamId, std::vector< UePtrAndBufferReq >, BeamIdHash >	ActiveUeMap
	Map between a BeamId and a vector of UE (the UE are in that beam)

typedef std::unordered_map< BeamId, uint32_t, BeamIdHash >	BeamSymbolMap
	Map between a BeamId and the symbol assigned to that beam.

typedef PointInFTPlane	FTResources
	Represent an amount of RBG/symbols that can be, or is, assigned.

using	HarqVectorIterator = NrMacHarqVector::iterator

using	HarqVectorIteratorList = std::vector< HarqVectorIterator >

typedef std::pair< UePtr, uint32_t >	UePtrAndBufferReq
	Pair between a pointer to NrMacSchedulerUeInfo and its buffer occupancy.

Protected Attributes inherited from ns3::NrMacSchedulerNs3
Ptr< NrAmc >	m_dlAmc
	AMC pointer.

Ptr< NrAmc >	m_ulAmc
	AMC pointer.

Protected Attributes inherited from ns3::NrMacScheduler
NrMacCschedSapProvider *	m_macCschedSapProvider {nullptr}
	SAP Provider.

NrMacCschedSapUser *	m_macCschedSapUser {nullptr}
	SAP User.

NrMacSchedSapProvider *	m_macSchedSapProvider {nullptr}
	SAP Provider.

NrMacSchedSapUser *	m_macSchedSapUser {nullptr}
	SAP user.

Detailed Description

Assign entire symbols in a proportional fair fashion.

Sort the UE by their current throughput. Details in the class NrMacSchedulerUeInfoPF.

Config Paths

ns3::NrMacSchedulerTdmaPF is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerNs3/$ns3::NrMacSchedulerTdma/$ns3::NrMacSchedulerTdmaRR/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerNs3/$ns3::NrMacSchedulerTdma/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerNs3/$ns3::NrMacSchedulerTdmaRR/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerNs3/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerTdma/$ns3::NrMacSchedulerTdmaRR/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerTdma/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerTdmaRR/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrNetDevice/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerNs3/$ns3::NrMacSchedulerTdma/$ns3::NrMacSchedulerTdmaRR/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrNetDevice/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerNs3/$ns3::NrMacSchedulerTdma/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrNetDevice/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerNs3/$ns3::NrMacSchedulerTdmaRR/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrNetDevice/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerNs3/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrNetDevice/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerTdma/$ns3::NrMacSchedulerTdmaRR/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrNetDevice/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerTdma/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrNetDevice/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerTdmaRR/$ns3::NrMacSchedulerTdmaPF
/NodeList/[i]/DeviceList/[i]/$ns3::NrNetDevice/$ns3::NrGnbNetDevice/BandwidthPartMap/[i]/MacScheduler/$ns3::NrMacSchedulerTdmaPF

Attributes

FairnessIndex: Value (between 0 and 1) that defines the PF metric (1 is the traditional 3GPP PF, 0 is RR in throughput
- Set with class: ns3::DoubleValue
- Underlying type: double 0:1
- Initial value: 1
- Flags: construct write read
LastAvgTPutWeight: Weight of the last average throughput in the average throughput calculation
- Set with class: ns3::DoubleValue
- Underlying type: double 0:1.79769e+308
- Initial value: 99
- Flags: construct write read

Attributes defined in parent class ns3::NrMacSchedulerNs3

CqiTimerThreshold: The time while a CQI is valid
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +1e+09ns
- Flags: construct write read
FixedMcsDl: Fix MCS to value set in StartingMcsDl
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
FixedMcsUl: Fix MCS to value set in StartingMcsUl
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
StartingMcsDl: Starting MCS for DL
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: construct write read
StartingMcsUl: Starting MCS for UL
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: construct write read
DlCtrlSymbols: Number of symbols allocated for DL CTRL
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 1
- Flags: construct write read
UlCtrlSymbols: Number of symbols allocated for UL CTRL
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 1
- Flags: construct write read
SrsSymbols: Number of symbols allocated for UL SRS
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 1
- Flags: construct write read
EnableSrsInUlSlots: Denotes whether the SRSs will be transmitted only in F slotsor both in F and UL slots. If False, SRS is transmitted onlyin F slots, if True in both (F/UL)
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
EnableSrsInFSlots: Denotes whether the SRSs will be transmitted in F slotsIf true, it can be transmitted in F slots, otherwise it cannot.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
DlAmc: The DL AMC of this scheduler
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::NrAmc>
- Initial value: 0
- Flags: construct write read
UlAmc: The UL AMC of this scheduler
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::NrAmc>
- Initial value: 0
- Flags: construct write read
MaxDlMcs: Maximum MCS index for DL
- Set with class: ns3::IntegerValue
- Underlying type: int8_t -1:30
- Initial value: -1
- Flags: construct write read
EnableHarqReTx: If true, it would set the max HARQ ReTx to 3; otherwise it set it to 0
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
SchedLcAlgorithmType: Type of the scheduling algorithm that assigns bytes to the different LCs.
- Set with class: ns3::TypeIdValue
- Underlying type: TypeId
- Initial value: ns3::NrMacSchedulerLcRR
- Flags: construct write
RachUlGrantMcs: The MCS of the RACH UL grant, must be [0..15] (default 0)
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: construct write

No TraceSources are defined for this type.
Size of this type is 632 bytes (on a 64-bit architecture).

Definition at line 18 of file nr-mac-scheduler-tdma-pf.h.

Constructor & Destructor Documentation

◆ NrMacSchedulerTdmaPF()

ns3::NrMacSchedulerTdmaPF::NrMacSchedulerTdmaPF ( )

NrMacSchedulerTdmaPF constructor.

Definition at line 44 of file nr-mac-scheduler-tdma-pf.cc.

◆ ~NrMacSchedulerTdmaPF()

ns3::NrMacSchedulerTdmaPF::~NrMacSchedulerTdmaPF ( )

inlineoverride

~NrMacSchedulerTdmaPF deconstructor

Definition at line 34 of file nr-mac-scheduler-tdma-pf.h.

Member Function Documentation

◆ AssignedDlResources()

void ns3::NrMacSchedulerTdmaPF::AssignedDlResources	(	const UePtrAndBufferReq &	ue,
		const FTResources &	assigned,
		const FTResources &	totAssigned
	)		const

overrideprotectedvirtual

Update DL metrics by calling NrMacSchedulerUeInfoPF::UpdatePFDlMetric.

Parameters

ue	UE to update
assigned	the amount of resources assigned
totAssigned	the total amount of resources assigned in the slot

The DL metrics (current Throughput and average Throughput) will be updated by calling the NrMacSchedulerUeInfoPF::UpdateDlPFMetric, which in turn will call NrMacSchedulerUeInfo::UpdateDlMetric in order to get the tbSize based on the resources assigned to the user. This will help the sorting function to sort the UEs for resource allocation.

Implements ns3::NrMacSchedulerTdma.

Definition at line 105 of file nr-mac-scheduler-tdma-pf.cc.

References ns3::NrMacSchedulerNs3::m_dlAmc.

◆ AssignedUlResources()

void ns3::NrMacSchedulerTdmaPF::AssignedUlResources	(	const UePtrAndBufferReq &	ue,
		const FTResources &	assigned,
		const FTResources &	totAssigned
	)		const

overrideprotectedvirtual

Update UL metrics by calling NrMacSchedulerUeInfoPF::UpdatePFUlMetric.

Parameters

ue	UE to update
assigned	the amount of resources assigned
totAssigned	the total amount of resources assigned in the slot

The UL metrics (current Throughput and average Throughput) will be updated by calling the NrMacSchedulerUeInfoPF::UpdateUlPFMetric, which in turn will call NrMacSchedulerUeInfo::UpdateUlMetric in order to get the tbSize based on the resources assigned to the user. This will help the sorting function to sort the UEs for resource allocation.

Implements ns3::NrMacSchedulerTdma.

Definition at line 126 of file nr-mac-scheduler-tdma-pf.cc.

References ns3::NrMacSchedulerNs3::m_ulAmc.

◆ BeforeDlSched()

void ns3::NrMacSchedulerTdmaPF::BeforeDlSched	(	const UePtrAndBufferReq &	ue,
		const FTResources &	assignableInIteration
	)		const

overrideprotectedvirtual

Calculate the potential throughput for the DL based on the available resources.

Parameters

ue	UE to which a symbol has been assigned
assignableInIteration	the minimum amount of resources to be assigned

Calculates the the potential throughput by calling NrMacSchedulerUeInfoPF::CalculatePotentialTPutDl.

Implements ns3::NrMacSchedulerTdma.

Definition at line 147 of file nr-mac-scheduler-tdma-pf.cc.

References ns3::NrMacSchedulerNs3::m_dlAmc.

◆ BeforeUlSched()

void ns3::NrMacSchedulerTdmaPF::BeforeUlSched	(	const UePtrAndBufferReq &	ue,
		const FTResources &	assignableInIteration
	)		const

overrideprotectedvirtual

Calculate the potential throughput for the UL based on the available resources.

Parameters

ue	UE to which a symbol has been assigned
assignableInIteration	the minimum amount of resources to be assigned

Calculates the the potential throughput by calling NrMacSchedulerUeInfoPF::CalculatePotentialTPutUl.

Implements ns3::NrMacSchedulerTdma.

Definition at line 156 of file nr-mac-scheduler-tdma-pf.cc.

References ns3::NrMacSchedulerNs3::m_ulAmc.

◆ CreateUeRepresentation()

std::shared_ptr< NrMacSchedulerUeInfo > ns3::NrMacSchedulerTdmaPF::CreateUeRepresentation ( const NrMacCschedSapProvider::CschedUeConfigReqParameters & params ) const

overrideprotectedvirtual

Create an UE representation of the type NrMacSchedulerUeInfoPF.

Parameters

params parameters

Returns: NrMacSchedulerUeInfoRR instance

Implements ns3::NrMacSchedulerNs3.

Definition at line 79 of file nr-mac-scheduler-tdma-pf.cc.

References ns3::NrMacSchedulerNs3::GetNumRbPerRbg(), and ns3::NrMacCschedSapProvider::CschedUeConfigReqParameters::m_beamId.

Here is the call graph for this function:

◆ GetFairnessIndex()

double ns3::NrMacSchedulerTdmaPF::GetFairnessIndex ( ) const

Get the value of attribute "FairnessIndex".

Returns

Definition at line 58 of file nr-mac-scheduler-tdma-pf.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTimeWindow()

double ns3::NrMacSchedulerTdmaPF::GetTimeWindow ( ) const

Get the attribute "LastAvgTPutWeight".

Returns: the value of the attribute

Definition at line 72 of file nr-mac-scheduler-tdma-pf.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::NrMacSchedulerTdmaPF::GetTypeId ( )

static

GetTypeId.

Returns: The TypeId of the class

Definition at line 21 of file nr-mac-scheduler-tdma-pf.cc.

References GetFairnessIndex(), GetTimeWindow(), SetFairnessIndex(), and SetTimeWindow().

Here is the call graph for this function:

◆ GetUeCompareDlFn()

std::function< bool(const NrMacSchedulerNs3::UePtrAndBufferReq &lhs, const NrMacSchedulerNs3::UePtrAndBufferReq &rhs)> ns3::NrMacSchedulerTdmaPF::GetUeCompareDlFn ( ) const

overrideprotectedvirtual

Return the comparison function to sort DL UE according to the scheduler policy.

Returns: a pointer to NrMacSchedulerUeInfoPF::CompareUeWeightsDl

Implements ns3::NrMacSchedulerTdma.

Definition at line 92 of file nr-mac-scheduler-tdma-pf.cc.

References ns3::NrMacSchedulerUeInfoPF::CompareUeWeightsDl().

Here is the call graph for this function:

◆ GetUeCompareUlFn()

std::function< bool(const NrMacSchedulerNs3::UePtrAndBufferReq &lhs, const NrMacSchedulerNs3::UePtrAndBufferReq &rhs)> ns3::NrMacSchedulerTdmaPF::GetUeCompareUlFn ( ) const

overrideprotectedvirtual

Return the comparison function to sort UL UE according to the scheduler policy.

Returns: a pointer to NrMacSchedulerUeInfoPF::CompareUeWeightsUl

Implements ns3::NrMacSchedulerTdma.

Definition at line 99 of file nr-mac-scheduler-tdma-pf.cc.

References ns3::NrMacSchedulerUeInfoPF::CompareUeWeightsUl().

Here is the call graph for this function:

◆ NotAssignedDlResources()

void ns3::NrMacSchedulerTdmaPF::NotAssignedDlResources	(	const UePtrAndBufferReq &	ue,
		const FTResources &	notAssigned,
		const FTResources &	totAssigned
	)		const

overrideprotectedvirtual

Update DL metrics by calling NrMacSchedulerUeInfoPF::UpdatePFDlMetric.

Parameters

ue	UE to update (ue that didn't get any resources)
notAssigned	the amount of resources not assigned
totAssigned	the total amount of resources assigned in the slot

Even if the UE did not get any resource assigned, change its current throughput over the total number of symbols assigned.

The DL metrics (current Throughput and average Throughput) will be updated by calling the NrMacSchedulerUeInfoPF::UpdateDlPFMetric, which in turn will call NrMacSchedulerUeInfo::UpdateDlMetric in order to get the tbSize based on the resources assigned to the user. Since no resources have been assigned, the tbSize will be zero. This will help the sorting function to sort the UEs for resource allocation.

Implements ns3::NrMacSchedulerTdma.

Definition at line 115 of file nr-mac-scheduler-tdma-pf.cc.

References ns3::NrMacSchedulerNs3::m_dlAmc.

◆ NotAssignedUlResources()

void ns3::NrMacSchedulerTdmaPF::NotAssignedUlResources	(	const UePtrAndBufferReq &	ue,
		const FTResources &	notAssigned,
		const FTResources &	totAssigned
	)		const

overrideprotectedvirtual

Update UL metrics by calling NrMacSchedulerUeInfoPF::UpdatePFUlMetric.

Parameters

ue	UE to update (ue that didn't get any resources)
notAssigned	the amount of resources not assigned
totAssigned	the total amount of resources assigned in the slot

Even if the UE did not get any resource assigned, change its current throughput over the total number of symbols assigned.

The UL metrics (current Throughput and average Throughput) will be updated by calling the NrMacSchedulerUeInfoPF::UpdateUlPFMetric, which in turn will call NrMacSchedulerUeInfo::UpdateUlMetric in order to get the tbSize based on the resources assigned to the user. Since no resources have been assigned, the tbSize will be zero. This will help the sorting function to sort the UEs for resource allocation.

Implements ns3::NrMacSchedulerTdma.

Definition at line 136 of file nr-mac-scheduler-tdma-pf.cc.

References ns3::NrMacSchedulerNs3::m_ulAmc.

◆ SetFairnessIndex()

void ns3::NrMacSchedulerTdmaPF::SetFairnessIndex ( double v )

Set the value of attribute "FairnessIndex".

Parameters

Definition at line 51 of file nr-mac-scheduler-tdma-pf.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetTimeWindow()

void ns3::NrMacSchedulerTdmaPF::SetTimeWindow ( double v )

Set the attribute "LastAvgTPutWeight".

Parameters

v	the value to save

Definition at line 65 of file nr-mac-scheduler-tdma-pf.cc.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::NrMacSchedulerNs3

Constructor & Destructor Documentation

◆ NrMacSchedulerTdmaPF()

◆ ~NrMacSchedulerTdmaPF()

Member Function Documentation

◆ AssignedDlResources()

◆ AssignedUlResources()

◆ BeforeDlSched()

◆ BeforeUlSched()

◆ CreateUeRepresentation()

◆ GetFairnessIndex()

◆ GetTimeWindow()

◆ GetTypeId()

◆ GetUeCompareDlFn()

◆ GetUeCompareUlFn()

◆ NotAssignedDlResources()

◆ NotAssignedUlResources()

◆ SetFairnessIndex()

◆ SetTimeWindow()