getEvent

R2026b

Retrieve event with specified label from fault tree document

Since R2026b

Syntax

event = getEvent(faultTreeDocument,label)

Description

event = getEvent(faultTreeDocument,label) returns the event in the fault tree document, faultTreeDocument, that has the label, label.

Examples

Retrieve Event from Fault Tree Document

Suppose you have an open fault tree document in the Safety Analysis Manager that has an event with the label myEvent. Get the FaultTreeDocument object.

myTreeDoc = safetyAnalysisMgr.getOpenDocuments;

Retrieve the event from the fault tree document that has the label myEvent.

myEvent = getEvent(myTreeDoc,"myEvent");

Input Arguments

faultTreeDocument — Fault tree document

FaultTreeDocument object

Fault tree document in the Safety Analysis Manager, specified as a FaultTreeDocument object.

label — Label of event

string scalar | character vector

Label of the event, specified as a string scalar or character vector.

Data Types: char | string

Output Arguments

event — Fault tree document event

Event object

Fault tree document event, returned as an Event object.

Version History

Introduced in R2026b