wlanRateControl Class

Implement rate control algorithm

Since R2026a

Description

Use the wlanRateControl base class to implement a rate control algorithm in a subclass.

The wlanRateControl class is a handle class.

Class Attributes

Abstract

true

For information on class attributes, see Class Attributes.

Properties

Protected Properties

CustomContextTemplate — Custom contextual information template for each receiver

structure

Custom contextual information template for each receiver, specified as a structure. The value of this property specifies the information that each receiver must maintain. The system uses this value as the default for the CustomContext field in each structure of the STAContext property. An inheriting subclass must define this property in its implementation.

Attributes:

GetAccess	protected
SetAccess	protected
Abstract	true

Data Types:

STAContext — Algorithm-specific contextual information for each STA

array of structures

Algorithm-specific contextual information for each STA, specified as an array of structures. Each structure contains these fields:

• ReceiverID — Receiver node ID

• CustomContext — Custom context that holds per-receiver information.

The node assigns the default values for this property. For each receiver that communicates with the node, the node adds an additional structure to this property. In each structure, the ReceiverID field contains the actual receiver ID, and the CustomContext field contains the default value defined by the CustomContextTemplate abstract property.

Note that an inheriting subclass can modify and use CustomContext for each receiver in its implementation.

Attributes:

GetAccess	protected
SetAccess	protected
Abstract	false

Data Types:

Methods

Public Methods

deviceConfigurationValue	Retrieve specified device configuration
deviceConfigurationType	Return device configuration type
bssConfigurationValue	Retrieve basic rate set value of specified BSS configuration
maxMCS	Return highest MCS index selectable for specified receiver
maxNumSpaceTimeStreams	Return maximum number of space-time streams selectable for specified receiver
mapReceiverToSTAContext	Return index of STA context property for specified receiver

Specialized Public Methods

selectRateParameters	Select rate parameters for frame transmission
processTransmissionStatus	Use frame transmission status to carry out post-transmission operations

More About

How to Use wlanRateControl Base Class

To create a custom rate control algorithm using the wlanRateControl base class, follow these steps.

1. Implement the custom rate control subclass:

   • Inherit from the wlanRateControl base class. The class definition must have this format, where customRateControlAlgorithm is the name of your custom rate control subclass.

     classdef customRateControlAlgorithm < wlanRateControl
         ...
     end

   • Implement the CustomContextTemplate property to define custom contextual information for each receiver. The CustomContext field in each structure of the STAContext property contains the value defined by the CustomContextTemplate property.

   • Override the selectRateParameters and processTransmissionStatus methods.

   Save the class definition in a .m file.

2. In a simulation script, create an object of the customRateControlAlgorithm subclass. Specify this custom rate control object to the RateControl property of the wlanLinkConfig or wlanDeviceConfig object and implement it into a WLAN node.

Version History

Introduced in R2026a