setCheckResult

Set result for currently running check

Syntax

success = setCheckResult(ma,result)

Description

Use the success = setCheckResult(ma,result) function to set the check result for the currently running check. Only the callback function of a check can invoke this function.

This function enables you to access custom checks that you create using the Model Advisor customization API, an optional feature that is available with Simulink^® Check™ software. For more information, see Define Custom Model Advisor Checks (Simulink Check).

Input Arguments

ma — Model Advisor object

Simulink.ModelAdvisor object

Simulink.ModelAdvisor object for which you want to set the result for the currently running check.

result — Result to be set

character vector | cell array of character vectors

Character vector or cell array that specifies the result of the currently running check.

Output Arguments

success — Boolean value indicating whether the result is set

Boolean

Boolean value that indicates whether the Model Advisor successfully set the result for the currently running check. A value of 1 indicates that the Model Advisor successfully set the result. A value of 0 indicates that the Model Advisor did not set the result.

Version History

Introduced in R2006a