Main Content

Simulink.fault.enable

Enable or disable faults on model elements

Since R2023b

Description

example

Simulink.fault.enable(modelElements,status) enables or disables the model elements, modelElements, for fault injection based on the value of status.

Examples

collapse all

Open a model with a block that supports fault modeling.

openExample('simscape_shared/SimpleMotorArmatureWindingFaultExample')

Add a fault to the Armature winding model subelement in the DC Motorblock called myFault.

Simulink.fault.addFault(...
"SimpleMotorArmatureWindingFault/DC Motor/Armature winding",...
Name="myFault")
ans = 

  Fault with properties:

            Name: 'myFault'
     Description: ''
    ModelElement: 'SimpleMotorArmatureWindingFault/DC Motor/Armature winding'
            Type: 'Simscape'
        IsActive: 0

Assign behavior to the fault and store the behavior in a fault model named myBehaviorModel on the path.

addBehavior(myFault,"myBehaviorModel");

Enable the fault.

Simulink.fault.enable(...
"SimpleMotorArmatureWindingFault/DC Motor/Armature winding",true)

Input Arguments

collapse all

Paths or handles of model elements, specified as a string array, cell array of character vectors, or a vector of handles. If you specify only one model element, enter it as a scalar.

Each entry in the array must be the path of a fault-capable model subelement.

Example: "myModel/DC Motor/Armature winding"

Example: ["myModel/DC Motor/Armature winding" "myModel/RC Servo/Servo"]

Example: ['myModel/DC Motor/Armature winding', 'myModel/RC Servo/Servo']

Data Types: string | char | double

Enabled status of model elements, specified as a numeric or logical 1 (true) or 0 (false). Enter 0 or false to disable fault injection on the model elements. Each model element must have at least one fault that has behavior.

Data Types: logical

Version History

Introduced in R2023b