getInputParameters

Return input parameters for check

Since R2025a

collapse all in page

    Syntax

    inputParams = getInputParameters(cfgObj,checkInstanceID)

    Description

    inputParams = getInputParameters(cfgObj,checkInstanceID) returns a list of the input parameters of a specified check checkInstanceID in the Model Advisor configuration accessed by the cfgObj object.

    example

    Examples

    collapse all

    Obtain input parameters of a check in a Model Advisor configuration.

    Create a Model Advisor configuration object.

    cfgObj = Advisor.Config;

    Load the myCustomFile.json file. Loading this file allows you to set the JSON file as an active configuration, providing you with access to edit it.

    loadConfig(cfgObj,"myCustomFile.json");

    Get the input parameters of the check mathworks.maab.db_0140 in the folder _SYSTEM_By Product_Simulink Check_Modeling Standards_JMAAB v5.1 Checks. You can obtain the check instance ID in the Model Advisor when you select the check mathworks.maab.db_0140.

    inputParams = getInputParameters(cfgObj,"_SYSTEM_By Product_Simulink Check_Modeling Standards_JMAAB  v5.1 Checks_mathworks.maab.db_0140")

    The getInputParameters function returns the input parameters of the check mathworks.maab.db_0140 in a structure array.

    inputParams = 
 1×4 struct array with fields:
 name
 type
 value

    Input Arguments

    collapse all

    Model Advisor configuration object, specified as an Advisor.Config object.

    Instance ID of the check in Model Advisor, specified as a character vector or string scalar.

    The instance ID of the check represents the location of the check in the configuration file from which you want to get the input parameters. You can obtain the check instance ID in the Model Advisor when you select the desired check.

    Example: '_SYSTEM_By Product_Simulink Check_Modeling Standards_JMAAB v5.1 Checks_mathworks.maab.db_0140'

    Output Arguments

    collapse all

    List of input parameters for a check instance ID, returned as a structure array.

    Version History

    Introduced in R2025a

    See Also

    |