Simulink.fault.findFaultedElements

Retrieve paths of model elements that have faults

Since R2023b

Syntax

elements = Simulink.fault.findFaultedElements(model)

elements = Simulink.fault.findFaultedElements(model,Enabled=status)

Description

elements = Simulink.fault.findFaultedElements(model) returns the model elements that have faults in the model, model.

elements = Simulink.fault.findFaultedElements(model,Enabled=status) returns the model elements that are or are not enabled, filtered by status.

Examples

Retrieve Model Subelements Faults

Open a model with a block that supports fault modeling.

openExample('simscape_shared/SimpleMotorArmatureWindingFaultExample')

Add two faults to the DC Motor block.

Simulink.fault.addFault(...
"SimpleMotorArmatureWindingFault/DC Motor/Armature winding"...
,Name="myFault1");
Simulink.fault.addFault(...
"SimpleMotorArmatureWindingFault/DC Motor/Armature winding"...
,Name="myFault2");

Retrieve the path of the model elements that have faults.

paths = Simulink.fault.findFaultedElements(...
"SimpleMotorArmatureWindingFault")

Retrieve Enabled Model Subelement Faults

Open a model with a block that supports fault modeling.

openExample('simscape_shared/SimpleMotorArmatureWindingFaultExample')

Add two faults to the DC Motor block.

myFault1 = Simulink.fault.addFault(...
"SimpleMotorArmatureWindingFault/DC Motor/Armature winding"...
,Name="myFault1");
myFault2 = Simulink.fault.addFault(...
"SimpleMotorArmatureWindingFault/DC Motor/Armature winding"...
,Name="myFault2");

Assign noise behavior both faults and store the behavior in a fault model named myBehaviorModel.

addBehavior(myFault1,"myBehaviorModel",...
FaultBehavior="Add Noise")
addBehavior(myFault2,"myBehaviorModel",...
FaultBehavior="Add Noise")

Enable a fault.

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

Retrieve the paths of the model elements that have faults that are enabled for fault simulation.

paths = Simulink.fault.findFaultedElements(...
"SimpleMotorArmatureWindingFault",Enabled=true);

Input Arguments

model — Path or handle to model

string scalar | character vector | handle

Path or handle to the model, specified as a string scalar, character vector, or model handle.

Data Types: string | char | double

status — Model subelement status

true or 1 | false or 0

Whether the model elements are enabled, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

Output Arguments

elements — Paths of model elements

string array

Paths of the model elements, returned as a string array.

Version History

Introduced in R2023b