setCheckResultStatus

Set status for currently running check

Syntax

success = setCheckResultStatus(ma,status)

Description

The success = setCheckResultStatus(ma,status) function sets the status 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 with 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 status for the currently running check.

status — Status of currently running check

Char | Boolean

For char type inputs, pass | fail | warn values indicate the status of the check that just ran. If you use char as input parameter, you do not need to update the severity of the error using the setCheckErrorSeverity function.

Boolean value that indicates the status of the check that just ran. A value of true indicates that the check passed. A value of false indicates that the check failed.

Output Arguments

success — Boolean value indicating whether the Model Advisor successfully set the status

Boolean

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

Note

You can use the setCheckResultStatus function only for 'StyleOne', 'StyleTwo', and 'StyleThree' style and not for the 'DetailStyle' style.

Version History

Introduced in R2006a