ruInfo
Return HE format resource unit allocation information
Syntax
Description
Examples
Get RU Allocation Information for HE Configuration Objects
Use the ruInfo
function to get the resource unit information of single user and multi-user HE configuration objects.
Get Single User RU Allocation Information
Create a single user HE configuration object. Get and display the RU allocation information for the configured object.
hesu = wlanHESUConfig; ru = ruInfo(hesu)
ru = struct with fields:
NumUsers: 1
NumRUs: 1
RUIndices: 1
RUSizes: 242
NumUsersPerRU: 1
NumSpaceTimeStreamsPerRU: 1
PowerBoostFactorPerRU: 1
RUNumbers: 1
Get Multiuser RU Allocation Information
Create a multiuser HE configuration object with the allocation index set to 5, which configures the object with seven users. Get and display the RU allocation information for the configured object.
hemu = wlanHEMUConfig(5); ru = ruInfo(hemu)
ru = struct with fields:
NumUsers: 7
NumRUs: 7
RUIndices: [1 2 2 5 6 7 4]
RUSizes: [26 26 52 26 26 26 52]
NumUsersPerRU: [1 1 1 1 1 1 1]
NumSpaceTimeStreamsPerRU: [1 1 1 1 1 1 1]
PowerBoostFactorPerRU: [1 1 1 1 1 1 1]
RUNumbers: [1 2 3 4 5 6 7]
Inactivate RU for Second User in Multiuser HE
Create a two user HE configuration object. Make the RU for the second user inactive by setting the station identity to 2046.
Create a multiuser HE configuration object with the allocation index set to 96, which configures an object for two users. The resource information shows that RUs are active for two users.
hemu = wlanHEMUConfig(96); ruInfo(hemu)
ans = struct with fields:
NumUsers: 2
NumRUs: 2
RUIndices: [1 2]
RUSizes: [106 106]
NumUsersPerRU: [1 1]
NumSpaceTimeStreamsPerRU: [1 1]
PowerBoostFactorPerRU: [1 1]
RUNumbers: [1 2]
Set the station identity to 2046 for the second user. The RU allocation information now shows that RUs are active only for RU index 1.
hemu.User{2}.STAID = 2046; ruInfo(hemu)
ans = struct with fields:
NumUsers: 2
NumRUs: 1
RUIndices: 1
RUSizes: 106
NumUsersPerRU: 1
NumSpaceTimeStreamsPerRU: 1
PowerBoostFactorPerRU: 1
RUNumbers: 1
Input Arguments
cfgHE
— HE configuration object
wlanHESUConfig
object | wlanHEMUConfig
object | wlanHETBConfig
object
HE configuration object, specified as an object of type wlanHEMUConfig
, wlanHESUConfig
, or wlanHETBConfig
.
Output Arguments
info
— Information about RU properties of object
structure
Information about the RU properties of the input object, returned as a structure.
NumUsers
— Number of users
integer in the range [1, 74]
Number of users, returned as an integer in the range [1, 74].
Data Types: double
NumRUs
— Number of RUs
integer in the range [1, 74]
Number of RUs, returned as an integer in the range [1, 74].
Data Types: double
RUIndices
— RU indices
integer | vector
RU indices, returned as an integer or a 1-by-NumRUs
vector with elements that have integer values in the range [1, 8].
Data Types: double
RUSizes
— Resource unit sizes
integer | vector
Resource unit sizes, returned as an integer or a
1-by-NumRUs
vector with elements that have integer values
in the range [1, 8].
Data Types: double
NumUsersPerRU
— Number of users per RU
integer | vector
Number of users per RU, returned as an integer or a
1-by-NumRUs
vector with elements that have integer values
in the range [1, 8].
Data Types: double
NumSpaceTimeStreamsPerRU
— Number of space-time streams per RU
integer | vector
Number of space-time streams per RU, returned as an integer or a
1-by-NumRUs
vector with elements that have integer values in
the range [1, 8].
Data Types: double
PowerBoostFactorPerRU
— Power boost factor per RU
integer | vector
Power boost factor per RU, returned as an integer or a
1-by-NumRUs
vector with elements that have integer values
in the range [1, 8].
Data Types: double
RUNumbers
— RU numbers
integer | vector
RU numbers, returned as an integer or a 1-by-NumRUs
vector with elements that have integer values in the range [1, 8].
RUNumbers
correspond to the indices for each active RU
configured in the cfgHE
.RU
object. An RU
is not active when it contains a single station with its station identifier set to
2046.
Data Types: double
Data Types: struct
Extended Capabilities
C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.
Version History
See Also
Objects
Functions
Open Example
You have a modified version of this example. Do you want to open this example with your edits?
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)