selectRateParameters

Class: wlanRateControl

Select rate parameters for frame transmission

Since R2026a

expand all in page

Syntax

rateParameters = selectRateParameters(rateControl,transmissionContext)

Description

rateParameters = selectRateParameters(rateControl,transmissionContext) selects the rate parameters to use to transmit the frame.

Note

selectRateParameters is an abstract method. The wireless local area network (WLAN) node uses the rate parameters returned in the output to transmit medium access control (MAC) frames in the simulation. When selecting the rate parameters to include in the output structure, you can take into account both the transmission context provided as input and any custom context maintained in the rate control object.

Input Arguments

expand all

Rate control object, specified as an object of a subclass of the wlanRateControl class.

Frame and transmission context information for the rate control selection, specified as a structure containing these fields:

  • FrameType — Type of frame for which the system invokes the rate control algorithm, specified as "QoS Data" or "RTS".

  • ReceiverNodeID — Node ID of the receiver, specified as a positive integer.

  • IsRetry — Logical flag indicating if the frame is a retransmission. The value is true if the frame is retransmitted.

  • TransmissionFormat — Physical (PHY) layer format used for transmission, specified as "Non-HT", "HT-Mixed", "VHT", "HE-SU", "HE-EXT-SU", "HE-MU", "HE-TB", or "EHT-SU". For RTS frames, the PHY format is "Non-HT".

  • ChannelBandwidth — Channel bandwidth used for transmission, specified as 20e6, 40e6, 80e6, 160e6, or 320e6. Units are in Hz.

  • CurrentTime — Current simulation time, specified as a scalar. Units are in seconds.

Output Arguments

expand all

Rate information used by the node to transmit a frame, returned as a structure containing these fields:

  • MCS — A nonnegative integer representing the modulation and coding scheme (MCS) index used for frame transmission to the station identified in the transmissionContext. This value must be in the range from 0 to the value returned by the maxMCS method.

  • NumSpaceTimeStreams — A positive integer representing the number of space-time streams used for frame transmission to the station identified in the transmissionContext. This value must be in the range from 1 to the value returned by the maxNumSpaceTimeStreams method.

Attributes

Abstracttrue
Accesspublic

To learn about attributes of methods, see Method Attributes.

Version History

Introduced in R2026a

See Also

Classes

Functions