getFaultModel

Get name of fault model

Since R2023b

Syntax

name = getFaultModel(fault)

Description

name = getFaultModel(fault) returns the name of the fault model that contains the behavior assigned to fault.

Examples

Retrieve Fault Model File Name

Open a model with a block that supports fault modeling.

openExample("simscape_shared/SimpleMotorArmatureWindingFaultExample")

Add a fault to the DC Motor block.

myFault = Simulink.fault.addFault(...
'SimpleMotorArmatureWindingFault/DC Motor/Armature winding');

Add an empty behavior to the fault.

addBehavior(myFault,"myBehaviorModel");

Retrieve the name of the fault model associated with myFault.

myBehaviorModel = getFaultModel(myFault)

myBehaviorModel =

    'myBehaviorModel'

Input Arguments

fault — Fault

Fault object

Fault, specified as a Fault object.

Output Arguments

name — Name of fault model

character vector

Name of the fault model that contains the fault behavior, returned as a character vector.

Version History

Introduced in R2023b