Simulink.fault.addFault

Add fault to model

Since R2023b

Syntax

fault = Simulink.fault.addFault(modelElement)

fault = Simulink.fault.addFault(modelElement,Name=Value)

Description

fault = Simulink.fault.addFault(modelElement) adds a fault to the model element , modelElement.

fault = Simulink.fault.addFault(modelElement,Name=Value) specifies additional properties for a fault using one or more name-value arguments.

Examples

Add a Fault to a Model Subelement

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 Motor block.

Simulink.fault.addFault(...
"SimpleMotorArmatureWindingFault/DC Motor/Armature winding")

ans = 

  Fault with properties:

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

Add Fault with Name

Open a model with a block that supports fault modeling.

openExample("simscape_shared/SimpleMotorArmatureWindingFaultExample")

Add a fault named myFault to the Armature winding model subelement in the DC Motor block.

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

Input Arguments

modelElement — Path or handle of model element

string scalar | character vector | handle

Path or handle of model element, specified as a string scalar, character vector, or handle. This argument is the path of a fault-capable model subelement.

Example: "myModel/DC Motor/Armature winding"

Data Types: string | char | double

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: Name="new_fault_1"

Name — Name of fault

string scalar | character vector

Name of the fault, specified as a string scalar or character vector. If you do not specify this argument, then the name is automatically generated.

Data Types: char | string

Description — Description of fault

'' (default) | string scalar | character vector

Description of the fault, specified as a string scalar or character vector.

Data Types: char | string

FaultInfoDir — Fault information directory

string scalar | character vector

Fault information directory, specified as a string scalar or a character vector. You can only specify this argument for the first fault added to a model. If you do not specify this argument, the function saves the fault information file in the current folder.

Example: simulink.fault.addFault("myModel/DC Motor/Armature winding",FaultInfoDir="C:\myFolder")

Data Types: char | string

Output Arguments

fault — Fault on model element

Fault object

Fault on the specified model element, returned as a Fault object.

Version History

Introduced in R2023b