Main Content

getParameters

Get real-time application parameters

Description

example

params_struct = getParameters(app_object) gets the application Parameters values as structures in an array. Use the getParameters function to get tunable parameter information from the Application object.

Examples

collapse all

You can get real-time application parameters by using the getParameters function.

Create an application object.

my_app = slrealtime.Application('slrt_ex_param_tuning')
my_app = 

  Application with properties:

    ApplicationName: 'slrt_ex_param_tuning'
          ModelName: 'slrt_ex_param_tuning'
           UserData: []
            Options: [1×1 slrealtime.internal.ApplicationOptions]

Get the application Parameters values as structures in an array.

my_params = getParameters(my_app)
my_params = 

  1×7 struct array with fields:

    BlockPath
    BlockParameterName

View application parameter values as array elements.

my_params(1).BlockParameterName
ans =

    'Gain'

Input Arguments

collapse all

Provides access to methods that manipulate the real-time application files.

Output Arguments

collapse all

The Parameters values are read-only. The structures in the array are:

  • BlockPath — block path of the parameter in the application

  • BlockParameterName — block parameter name in the application

Introduced in R2020b