5G-LENA nr-v3.1-69-g2dd513a7
The 5G/NR module for the ns-3 simulator
Loading...
Searching...
No Matches
ns3::NrMacSchedulerOfdma Class Reference

The base for all the OFDMA schedulers. More...

#include "nr-mac-scheduler-ofdma.h"

+ Inheritance diagram for ns3::NrMacSchedulerOfdma:
+ Collaboration diagram for ns3::NrMacSchedulerOfdma:

Public Member Functions

 NrMacSchedulerOfdma ()
 NrMacSchedulerOfdma constructor.
 
 ~NrMacSchedulerOfdma () override
 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 NrAmcGetDlAmc () 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 NrAmcGetUlAmc () 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.
 
NrMacCschedSapProviderGetMacCschedSapProvider ()
 Get the MacCschedSapProvider pointer.
 
NrMacSchedSapProviderGetMacSchedSapProvider ()
 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::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

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 UL RBG to the active UE, and return the distribution of symbols per beam.
 
void ChangeDlBeam (PointInFTPlane *spoint, uint32_t symOfBeam) const override
 Advance the starting point by the number of symbols specified, resetting the RB count to 0.
 
void ChangeUlBeam (PointInFTPlane *spoint, uint32_t symOfBeam) const override
 Perform a custom operation on the starting point each time all the UE of an UL beam have been scheduled.
 
std::shared_ptr< DciInfoElementTdmaCreateDlDci (PointInFTPlane *spoint, const std::shared_ptr< NrMacSchedulerUeInfo > &ueInfo, uint32_t maxSym) const override
 Create the DL DCI in OFDMA mode.
 
std::shared_ptr< DciInfoElementTdmaCreateUlDci (PointInFTPlane *spoint, const std::shared_ptr< NrMacSchedulerUeInfo > &ueInfo, uint32_t maxSym) const override
 Create a DCI for the specified UE for UL data.
 
NrMacSchedulerOfdma::BeamSymbolMap GetSymPerBeam (uint32_t symAvail, const ActiveUeMap &activeDl) const
 Calculate the number of symbols to assign to each beam.
 
uint8_t GetTpc () const override
 Returns TPC command.
 
- 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.
 
virtual void AssignedDlResources (const UePtrAndBufferReq &ue, const FTResources &assigned, const FTResources &totalAssigned) const =0
 Update the UE representation after a symbol (DL) has been assigned to it.
 
virtual void AssignedUlResources (const UePtrAndBufferReq &ue, const FTResources &assigned, const FTResources &totalAssigned) const =0
 Update the UE representation after a symbol (DL) has been assigned to it.
 
BeamSymbolMap AssignULRBG (uint32_t symAvail, const ActiveUeMap &activeUl) const override
 Assign the available UL RBG to the UEs.
 
virtual void BeforeDlSched (const UePtrAndBufferReq &ue, const FTResources &assignableInIteration) const =0
 Prepare UE for the DL scheduling.
 
virtual void BeforeUlSched (const UePtrAndBufferReq &ue, const FTResources &assignableInIteration) const =0
 Prepare UE for the UL scheduling.
 
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< DciInfoElementTdmaCreateDlDci (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< DciInfoElementTdmaCreateUlDci (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.
 
virtual std::function< bool(const NrMacSchedulerNs3::UePtrAndBufferReq &lhs, const NrMacSchedulerNs3::UePtrAndBufferReq &rhs)> GetUeCompareDlFn () const =0
 Provide the comparison function to order the UE when scheduling DL.
 
virtual std::function< bool(const NrMacSchedulerNs3::UePtrAndBufferReq &lhs, const NrMacSchedulerNs3::UePtrAndBufferReq &rhs)> GetUeCompareUlFn () const =0
 Provide the comparison function to order the UE when scheduling UL.
 
virtual void NotAssignedDlResources (const UePtrAndBufferReq &ue, const FTResources &notAssigned, const FTResources &totalAssigned) const =0
 Update the UE representation after a symbol (DL) has been assigned to other UE.
 
virtual void NotAssignedUlResources (const UePtrAndBufferReq &ue, const FTResources &notAssigned, const FTResources &totalAssigned) const =0
 Update the UE representation after a symbol (UL) has been assigned to other UE.
 
- 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.
 
virtual std::shared_ptr< NrMacSchedulerUeInfoCreateUeRepresentation (const NrMacCschedSapProvider::CschedUeConfigReqParameters &params) const =0
 Create an UE representation for the scheduler.
 
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, BeamIdHashActiveHarqMap
 Map between a beamID and the HARQ of that beam.
 
typedef std::unordered_map< BeamId, std::vector< UePtrAndBufferReq >, BeamIdHashActiveUeMap
 Map between a BeamId and a vector of UE (the UE are in that beam)
 
typedef std::unordered_map< BeamId, uint32_t, BeamIdHashBeamSymbolMap
 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< NrAmcm_dlAmc
 AMC pointer.
 
Ptr< NrAmcm_ulAmc
 AMC pointer.
 
- Protected Attributes inherited from ns3::NrMacScheduler
NrMacCschedSapProviderm_macCschedSapProvider {nullptr}
 SAP Provider.
 
NrMacCschedSapUserm_macCschedSapUser {nullptr}
 SAP User.
 
NrMacSchedSapProviderm_macSchedSapProvider {nullptr}
 SAP Provider.
 
NrMacSchedSapUserm_macSchedSapUser {nullptr}
 SAP user.
 

Detailed Description

The base for all the OFDMA schedulers.

An example of OFDMA-based scheduling is the following:

(f)
^
|=|======|=======|=|
|C| U  E | U  E  |C|
|T|  1   |  3    |T|
| |======|=======| |
|R| U  E | U  E  |R|
|L|  2   |   4   |L|
|----------------------------> (t)

The UEs are scheduled by prioritizing the assignment of frequencies: the entire available spectrum is divided among UEs of the same beam, by a number of symbols which is pre-computed and depends on the total byte to transmit of each beam.

The OFDMA scheduling is only done in downlink. In uplink, the division in time is used, and therefore the class is based on top of NrMacSchedulerTdma.

The implementation details to construct a slot like the one showed before are in the functions AssignDLRBG() and AssignULRBG(). The choice of the UEs to be scheduled is, however, demanded to the subclasses.

The DCI is created by CreateDlDci() or CreateUlDci(), which call CreateDci() to perform the "hard" work.

See also
NrMacSchedulerOfdmaRR
NrMacSchedulerOfdmaPF
NrMacSchedulerOfdmaMR

Config Paths

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

No Attributes are defined for this type.

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

TraceSources

  • SymPerBeam: Number of assigned symbol per beam. Gets called every time an assignment is made
    Callback signature: ns3::TracedValueCallback::Uint32

Size of this type is 648 bytes (on a 64-bit architecture).

Definition at line 50 of file nr-mac-scheduler-ofdma.h.

Constructor & Destructor Documentation

◆ NrMacSchedulerOfdma()

ns3::NrMacSchedulerOfdma::NrMacSchedulerOfdma ( )

NrMacSchedulerOfdma constructor.

Definition at line 36 of file nr-mac-scheduler-ofdma.cc.

◆ ~NrMacSchedulerOfdma()

ns3::NrMacSchedulerOfdma::~NrMacSchedulerOfdma ( )
inlineoverride

Deconstructor.

Definition at line 67 of file nr-mac-scheduler-ofdma.h.

Member Function Documentation

◆ AssignDLRBG()

NrMacSchedulerNs3::BeamSymbolMap ns3::NrMacSchedulerOfdma::AssignDLRBG ( uint32_t  symAvail,
const ActiveUeMap activeDl 
) const
overrideprotectedvirtual

Assign the available DL RBG to the UEs.

Parameters
symAvailAvailable symbols
activeDlMap of active UE and their beams
Returns
a map between beams and the symbol they need

The algorithm redistributes the frequencies to all the UEs inside a beam. The pre-requisite is to calculate the symbols for each beam, done with the function GetSymPerBeam(). The pseudocode is the following (please note that sym_of_beam is a value returned by the GetSymPerBeam() function):

while frequencies > 0:
   sort (ueVector);
   ueVector.first().m_dlRBG += 1 * sym_of_beam;
   frequencies--;
   UpdateUeDlMetric (ueVector.first());

To sort the UEs, the method uses the function returned by GetUeCompareDlFn(). Two fairness helper are hard-coded in the method: the first one is avoid to assign resources to UEs that already have their buffer requirement covered, and the other one is avoid to assign symbols when all the UEs have their requirements covered.

Implements ns3::NrMacSchedulerNs3.

Definition at line 149 of file nr-mac-scheduler-ofdma.cc.

References ns3::NrMacSchedulerTdma::AssignedDlResources(), ns3::NrMacSchedulerTdma::BeforeDlSched(), ns3::NrMacSchedulerNs3::GetBandwidthInRbg(), ns3::NrMacSchedulerNs3::GetDlNotchedRbgMask(), GetSymPerBeam(), ns3::NrMacSchedulerTdma::GetUeCompareDlFn(), ns3::NrMacSchedulerNs3::PointInFTPlane::m_rbg, ns3::NrMacSchedulerNs3::PointInFTPlane::m_sym, and ns3::NrMacSchedulerTdma::NotAssignedDlResources().

+ Here is the call graph for this function:

◆ AssignULRBG()

NrMacSchedulerNs3::BeamSymbolMap ns3::NrMacSchedulerOfdma::AssignULRBG ( uint32_t  symAvail,
const ActiveUeMap activeUl 
) const
overrideprotectedvirtual

Assign the UL RBG to the active UE, and return the distribution of symbols per beam.

Parameters
symAvailavailable symbols for UL
activeUlMap of Beam and active UE per beam
Returns
a map of symbols dedicated to each beam

The function should assign RBG to each UE, modifying the value m_ulRBG for each UE in the activeUl map. In doing so, it has to calculate the number of symbols assigned to each UE, and return it to the caller.

The creation of DCI will be performed by calling CreateDlDci with the appropriate input parameters.

Implements ns3::NrMacSchedulerNs3.

Definition at line 241 of file nr-mac-scheduler-ofdma.cc.

References ns3::NrMacSchedulerTdma::AssignedUlResources(), ns3::NrMacSchedulerTdma::BeforeUlSched(), ns3::NrMacSchedulerNs3::GetBandwidthInRbg(), GetSymPerBeam(), ns3::NrMacSchedulerTdma::GetUeCompareUlFn(), ns3::NrMacSchedulerNs3::GetUlNotchedRbgMask(), ns3::NrMacSchedulerNs3::PointInFTPlane::m_rbg, ns3::NrMacSchedulerNs3::PointInFTPlane::m_sym, and ns3::NrMacSchedulerTdma::NotAssignedUlResources().

+ Here is the call graph for this function:

◆ ChangeDlBeam()

void ns3::NrMacSchedulerOfdma::ChangeDlBeam ( PointInFTPlane spoint,
uint32_t  symOfBeam 
) const
overrideprotectedvirtual

Advance the starting point by the number of symbols specified, resetting the RB count to 0.

Parameters
spointStarting point
symOfBeamNumber of symbols for the beam

Implements ns3::NrMacSchedulerNs3.

Definition at line 531 of file nr-mac-scheduler-ofdma.cc.

References ns3::NrMacSchedulerNs3::PointInFTPlane::m_rbg, and ns3::NrMacSchedulerNs3::PointInFTPlane::m_sym.

◆ ChangeUlBeam()

void ns3::NrMacSchedulerOfdma::ChangeUlBeam ( PointInFTPlane spoint,
uint32_t  symOfBeam 
) const
overrideprotectedvirtual

Perform a custom operation on the starting point each time all the UE of an UL beam have been scheduled.

Parameters
spointstarting point for the next beam to modify
symOfBeamnumber the symbol used for the beam

Implements ns3::NrMacSchedulerNs3.

Definition at line 538 of file nr-mac-scheduler-ofdma.cc.

References ns3::NrMacSchedulerNs3::PointInFTPlane::m_rbg, and ns3::NrMacSchedulerNs3::PointInFTPlane::m_sym.

◆ CreateDlDci()

std::shared_ptr< DciInfoElementTdma > ns3::NrMacSchedulerOfdma::CreateDlDci ( NrMacSchedulerNs3::PointInFTPlane spoint,
const std::shared_ptr< NrMacSchedulerUeInfo > &  ueInfo,
uint32_t  maxSym 
) const
overrideprotectedvirtual

Create the DL DCI in OFDMA mode.

Parameters
spointStarting point
ueInfoUE representation
maxSymMaximum symbols to use
Returns
a pointer to the newly created instance

The function calculates the TBS and then call CreateDci().

Implements ns3::NrMacSchedulerNs3.

Definition at line 342 of file nr-mac-scheduler-ofdma.cc.

References ns3::DciInfoElementTdma::DATA, ns3::DciInfoElementTdma::DL, ns3::NrMacSchedulerNs3::GetBandwidthInRbg(), ns3::NrMacSchedulerNs3::GetBwpId(), ns3::NrMacSchedulerNs3::GetDlNotchedRbgMask(), ns3::NrMacSchedulerNs3::GetNumRbPerRbg(), GetTpc(), ns3::NrMacSchedulerNs3::m_dlAmc, ns3::NrMacSchedulerNs3::PointInFTPlane::m_rbg, and ns3::NrMacSchedulerNs3::PointInFTPlane::m_sym.

+ Here is the call graph for this function:

◆ CreateUlDci()

std::shared_ptr< DciInfoElementTdma > ns3::NrMacSchedulerOfdma::CreateUlDci ( PointInFTPlane spoint,
const std::shared_ptr< NrMacSchedulerUeInfo > &  ueInfo,
uint32_t  maxSym 
) const
overrideprotectedvirtual

Create a DCI for the specified UE for UL data.

Parameters
spointStarting point
ueInfoUE specified
maxSymmaximum amount of symbols that can be assigned
Returns
a pointer to the DciInfoElementTdma

The function should create a block in the 2D frequency-time plane in which the specified UE will receive the UL data.

Implements ns3::NrMacSchedulerNs3.

Definition at line 437 of file nr-mac-scheduler-ofdma.cc.

References ns3::DciInfoElementTdma::DATA, ns3::NrMacSchedulerNs3::GetBandwidthInRbg(), ns3::NrMacSchedulerNs3::GetBwpId(), ns3::NrMacSchedulerNs3::GetNumRbPerRbg(), GetTpc(), ns3::NrMacSchedulerNs3::GetUlNotchedRbgMask(), ns3::NrMacSchedulerNs3::PointInFTPlane::m_rbg, ns3::NrMacSchedulerNs3::PointInFTPlane::m_sym, ns3::NrMacSchedulerNs3::m_ulAmc, and ns3::DciInfoElementTdma::UL.

+ Here is the call graph for this function:

◆ GetSymPerBeam()

NrMacSchedulerOfdma::BeamSymbolMap ns3::NrMacSchedulerOfdma::GetSymPerBeam ( uint32_t  symAvail,
const ActiveUeMap activeDl 
) const
protected

Calculate the number of symbols to assign to each beam.

Parameters
symAvailNumber of available symbols
activeDlMap of active DL UE and their beam

Each beam has a different requirement in terms of byte that should be transmitted with that beam. That requirement depends on the number of UE that are inside such beam, and how many bytes they have to transmit.

For the beam $ b $, the number of assigned symbols is the following:

$ sym_{b} = BufSize(b) * \frac{symAvail}{BufSizeTotal} $

Definition at line 56 of file nr-mac-scheduler-ofdma.cc.

Referenced by AssignDLRBG(), and AssignULRBG().

+ Here is the caller graph for this function:

◆ GetTpc()

uint8_t ns3::NrMacSchedulerOfdma::GetTpc ( ) const
overrideprotectedvirtual

Returns TPC command.

Implements ns3::NrMacSchedulerNs3.

Definition at line 545 of file nr-mac-scheduler-ofdma.cc.

Referenced by CreateDlDci(), and CreateUlDci().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::NrMacSchedulerOfdma::GetTypeId ( )
static

GetTypeId.

Returns
The TypeId of the class

Definition at line 23 of file nr-mac-scheduler-ofdma.cc.


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