FaultTreeDocument

R2026b

Fault tree document in Safety Analysis Manager

Since R2026b

Description

FaultTreeDocument objects represent fault tree documents in the Safety Analysis Manager. Use FaultTreeDocument objects to manage fault trees and their artifacts, such as events, gates, and failure models. After evaluating FaultTreeDocument objects, you can retrieve the evaluation results.

Creation

To create a FaultTreeDocument object:

Use the safetyAnalysisMgr.newDocument function to create a new fault tree document in the Safety Analysis Manager.
Use the safetyAnalysisMgr.openDocument function to open a fault tree document in the Safety Analysis Manager.
Use the safetyAnalysisMgr.getOpenDocuments function to retrieve the open fault tree documents in the Safety Analysis Manager.
In the Safety Analysis Manager, select the fault tree document and use the safetyAnalysisMgr.getCurrentDocument function.

Properties

expand all

`FaultTrees` — Fault trees in document
Read-only: array of `FaultTree` objects

This property is read-only.

Fault trees in the fault tree document, represented as an array of FaultTree objects. Each fault tree document can contain multiple fault trees. To add a fault tree to the document, use the createFaultTree function.

`Events` — Events in the document
Read-only: array of `Event` objects

This property is read-only.

Events in the fault tree document, represented as an array of Event objects. To add an event to the fault tree document, retrieve a Gate object from the tree and use the createEvent function.

`FailureModels` — Failure models in document
Read-only: array of `FailureModel` objects

This property is read-only.

Failure models in the fault tree document, represented as an array of FailureModel objects. Each fault tree document can contain multiple failure models, and events in the fault tree can share failure models. To add a new failure model to the document, use the createFailureModel function.

`Gates` — Gates in document
Read-only: array of `Gate` objects

This property is read-only.

Gates in the fault tree document, represented as an array of Gate objects. Within each fault tree, each gate must have a unique label. To add a gate to the fault tree document, retrieve a Gate object from the tree and use the createGate function.

`EvalConfig` — Evaluation configuration
`EvalConfig` object

Evaluation configuration of the fault tree document, specified as an EvalConfig object.

`FileName` — File name
Read-only: character vector

This property is read-only.

File name of the fault tree document, represented as a character vector.

Data Types: char

`Description` — Document description
`""` (default) | string scalar | character vector

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

Data Types: string | char

Object Functions

`acceptAllChanges`	Accept detected changes to linked artifacts in Safety Analysis Manager
`addCallback`	Add custom callback to Safety Analysis Manager spreadsheets
`addDocumentAttribute`	Add document attribute to spreadsheet in Safety Analysis Manager
`clearFlags`	Clear flags in Safety Analysis Manager spreadsheet and fault tree document elements
`close`	Close document in Safety Analysis Manager
`convertGateToTree`	Convert fault tree gates and inputs into fault trees
`createEvent`	Add event to fault tree document or gate
`createFailureModel`	Create failure model in fault tree document
`createFaultTree`	Create fault tree in fault tree document
`deleteCallback`	Delete custom callback from Safety Analysis Manager documents
`deleteDocumentAttribute`	Delete document attributes in spreadsheet in Safety Analysis Manager
`deleteEvent`	Delete event from a fault tree document
`deleteFailureModel`	Delete failure model from fault tree document
`deleteFaultTree`	Delete fault tree from fault tree document
`deleteSubtree`	Delete subtree in fault tree document
`detectChanges`	Detect changes to linked artifacts in Safety Analysis Manager document
`enableCallback`	Enable or disable callbacks in Safety Analysis Manager spreadsheets
`evaluate`	Evaluate failure parameters and cutsets of fault trees
`exportToPDF`	Export fault trees and fault tree documents to PDF
`getCallback`	Retrieve spreadsheet callback code in Safety Analysis Manager
`getChanges`	Get changed artifacts linked to artifacts in Safety Analysis Manager
`getCustomCallbackNames`	Retrieve names of custom callbacks in Safety Analysis Manager documents
`getDocumentAttribute`	Retrieve document attribute values in Safety Analysis Manager documents
`getDocumentAttributeProperties`	Retrieve document attribute properties in Safety Analysis Manager document
`getEvent`	Retrieve event with specified label from fault tree document
`getFailureModel`	Retrieve failure model with specified label from fault tree document
`getFlags`	Retrieve flags from Safety Analysis Manager documents
`getGate`	Retrieve gate with specified label from fault tree document
`isCallbackEnabled`	Determine whether custom callbacks are enabled
`refreshLinks`	(Removed) Refresh link resolved status in Safety Analysis Manager documents
`renameCallback`	Rename custom callbacks in Safety Analysis Manager spreadsheets
`renameDocumentAttribute`	Rename document attributes in Safety Analysis Manager documents
`runAnalysis`	Execute callback script on Safety Analysis Manager document
`save`	Save Safety Analysis Manager document
`saveTemplate`	Save Safety Analysis Manager document as a template
`setCallback`	Assign code to Safety Analysis Manager document callback
`setDocumentAttribute`	Set document attributes in Safety Analysis Manager documents

Examples

collapse all

Create a Fault Tree and Add Events

Create a fault tree document.

myTreeDoc = safetyAnalysisMgr.newDocument("fault-tree");

The new document contains one fault tree. Retrieve the FaultTree object from the document.

myFaultTree = myTreeDoc.FaultTree;

The fault tree contains one top-level gate. Retrieve the Gate object for the top level gate.

topGate = myFaultTree.Gates;

Add three events to the top-level gate.

createEvent(topGate);
createEvent(topGate);
createEvent(topGate);

Version History

Introduced in R2026b

FaultTreeDocument

Description

Creation

Properties

`FaultTrees` — Fault trees in document
Read-only: array of `FaultTree` objects

`Events` — Events in the document
Read-only: array of `Event` objects

`FailureModels` — Failure models in document
Read-only: array of `FailureModel` objects

`Gates` — Gates in document
Read-only: array of `Gate` objects

`EvalConfig` — Evaluation configuration
`EvalConfig` object

`FileName` — File name
Read-only: character vector

`Description` — Document description
`""` (default) | string scalar | character vector

Object Functions

Examples

Create a Fault Tree and Add Events

Version History

See Also

Apps

Objects

Topics

FaultTreeDocument

Description

Creation

Properties

FaultTrees — Fault trees in document Read-only: array of FaultTree objects

Events — Events in the document Read-only: array of Event objects

FailureModels — Failure models in document Read-only: array of FailureModel objects

Gates — Gates in document Read-only: array of Gate objects

EvalConfig — Evaluation configuration EvalConfig object

FileName — File name Read-only: character vector

Description — Document description "" (default) | string scalar | character vector

Object Functions

Examples

Create a Fault Tree and Add Events

Version History

See Also

Apps

Objects

Topics

`FaultTrees` — Fault trees in document
Read-only: array of `FaultTree` objects

`Events` — Events in the document
Read-only: array of `Event` objects

`FailureModels` — Failure models in document
Read-only: array of `FailureModel` objects

`Gates` — Gates in document
Read-only: array of `Gate` objects

`EvalConfig` — Evaluation configuration
`EvalConfig` object

`FileName` — File name
Read-only: character vector

`Description` — Document description
`""` (default) | string scalar | character vector