clear

R2026b

Clear Safety Analysis Manager document flag

Since R2023b

Syntax

clear(flag)

Description

clear(flag) clears the flag, flag, in the Safety Analysis Manager document.

Examples

Clear Flag in Spreadsheet

Suppose you have a Safety Analysis Manager spreadsheet open that has two columns and two rows. Retrieve the Spreadsheet object.

mySpreadsheet = safetyAnalysisMgr.getOpenDocuments;

Get the SpreadsheetCell object of the cell in the first row and first column.

myCell = getCell(mySpreadsheet,1,1);

Add a warning flag to the cell.

myFlag = addFlag(myCell,"warning");

Clear the flag from the document.

clear(myFlag)

Clear Flag in Fault Tree

Since R2026b

Create a new Safety Analysis Manager fault tree document.

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

Retrieve the fault tree from the document.

myFaultTree = myFaultTreeDoc(1).FaultTrees(1);

New fault trees contain one top-level gate. Retrieve the gate.

myGate = myFaultTree.Gates(1);

Add two basic events to the gate.

myEvent1 = createEvent(myGate);
myEvent2 = createEvent(myGate);

Add a check flag to the first event, and a warning flag to the second event.

myFlag1 = addFlag(myEvent1,"check");
myFlag2 = addFlag(myEvent2,"warning");

Clear the warning flag.

clear(myFlag2)

Input Arguments

flag — Flag in Safety Analysis Manager document

DocumentFlag object

Flag in the Safety Analysis Manager document, specified as a DocumentFlag object. Using this function does not delete the DocumentFlag object from the base workspace, but clears association with the object.

Version History

Introduced in R2023b

R2026b: Clear flags for elements in fault tree documents

Use the clear function to clear flags in fault tree document elements.