Event

R2026b

Event in fault tree documents

Since R2026b

Description

Event objects represent events in Safety Analysis Manager fault tree documents. Use Event objects to define the starting point of failures in your safety analyses.

Creation

To create an Event object:

• Use the createEvent function on a FaultTreeDocument or Gate object.

• Use the getEvent function on a FaultTreeDocument object.

• Get the Events property of a FaultTreeDocument object.

• Get the Inputs property of a Gate object and filter for only Event objects.

• Get the DependentEvents property from a FailureModel object.

Properties

Type — Event type

"basic" (default) | "undeveloped" | "house"

Event type, specified as one of these options:

Value	Description
"basic"	Represents a basic event
"undeveloped"	Represents an undeveloped event
"house"	Represents a house event

For more information on event types, see Create Fault Tree Events.

Data Types: enumeration

Label — Event label

"EVENT" (default) | string scalar | character vector

Event label, specified as a string scalar or character vector. Each event must have a unique label. If you create another event with the default label, the next addition uses the default label with an appended number. Each new event increments the number, for example, EVENT1, EVENT2, and so on.

Data Types: char | string

Description — Event description

"" (default) | string scalar | character vector

Event description, specified as a string scalar or character vector.

Data Types: char | string

FailureModel — Failure model assigned to event

FailureModel object

Failure model assigned to the event, specified as a FailureModel object. To add a failure model to the event, use the createFailureModel function on the FaultTreeDocument object that contains this Event object, and assign the new failure model to this property.

FailureProperties — Failure properties

Read-only: FailureProperties object

This property is read-only.

Failure properties calculated at the event, represented as a FailureProperties object. This property is empty until you evaluate the fault tree document.

Object Functions

addFlag	Add flag to Safety Analysis Manager spreadsheet cell or row
acceptAllChanges	Accept detected changes to linked artifacts in Safety Analysis Manager
clearFlags	Clear flags in Safety Analysis Manager spreadsheet and fault tree document elements
getChanges	Get changed artifacts linked to artifacts in Safety Analysis Manager
getFlags	Retrieve flags from Safety Analysis Manager documents
getLinks	Get links associated with spreadsheet cell or row in Safety Analysis Manager
navigate	Navigate to elements in Safety Analysis Manager documents and changed artifacts

Examples

Create a Fault Tree That Has Events

Create a fault tree and add three events to it. First, create the fault tree document.

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

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

myFaultTree = myTreeDoc.FaultTrees(1);

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

topGate = myFaultTree.Gates(1);

Add three events to the top-level gate.

numberOfEvents = 3;
for n = 1:numberOfEvents
 myEvent(n) = createEvent(topGate);
end

Alternatively, use myEvent = arrayfun(@(~) createEvent(topGate),1:3); to perform the same operation.

Version History

Introduced in R2026b