getFlags

R2026b

Retrieve flags from Safety Analysis Manager documents

Since R2023b

Syntax

flags = getFlags(spreadsheet)

flags = getFlags(spreadsheetCell)

flags = getFlags(spreadsheetRow)

flags = getFlags(faultTreeDocument)

flags = getFlags(event)

flags = getFlags(gate)

flags = getFlags(failureModel)

Description

Spreadsheets

flags = getFlags(spreadsheet) returns the flags in the specified Safety Analysis Manager spreadsheet.

flags = getFlags(spreadsheetCell) returns the flags in a spreadsheet cell.

flags = getFlags(spreadsheetRow) returns the flags in a spreadsheet row. (since R2024b)

Fault Tree Documents

flags = getFlags(faultTreeDocument) returns the flags in the specified Safety Analysis Manager fault tree document.

flags = getFlags(event) returns the flags in a fault tree document event.

flags = getFlags(gate) returns the flags in a fault tree document gate.

flags = getFlags(failureModel) returns the flags in a fault tree document failure model.

Examples

Add and Retrieve Flags from Spreadsheet

Create a new Safety Analysis Manager spreadsheet.

mySpreadsheet = safetyAnalysisMgr.newSpreadsheet;

Add two text columns and two rows to the spreadsheet.

addRow(mySpreadsheet,Count=2)
addColumn(mySpreadsheet,Count=2)

Retrieve the SpreadsheetCell objects for the cells in the second column.

for n = 1:mySpreadsheet.Rows
  myCells(n) = getCell(mySpreadsheet,n,2);
end

Add a warning flag to the cells in the first and second row of the second column.

addFlag(myCells(1),"warning");
addFlag(myCells(2),"warning");

Retrieve the flags in the spreadsheet.

myFlags = getFlags(mySpreadsheet);

Add and Retrieve Flags from a Spreadsheet Cell

Create a new Safety Analysis Manager spreadsheet.

mySpreadsheet = safetyAnalysisMgr.newSpreadsheet;

Add two text columns and two rows to the spreadsheet.

addRow(mySpreadsheet,Count=2)
addColumn(mySpreadsheet,Count=2)

Retrieve the SpreadsheetCell objects for the cells in the second column.

for n = 1:mySpreadsheet.Rows
  myCells(n) = getCell(mySpreadsheet,n,2);
end

Add a warning flag to the cells in the first and second row of the second column.

addFlag(myCells(1),"warning");
addFlag(myCells(2),"warning");

Retrieve the flags from the cell in the first row.

myFlags = getFlags(myCells(1));

Add and Retrieve Flags from a Spreadsheet Row

Since R2024b

Create a new Safety Analysis Manager spreadsheet.

mySpreadsheet = safetyAnalysisMgr.newSpreadsheet;

Add two text columns and two rows to the spreadsheet.

addRow(mySpreadsheet,Count=2)
addColumn(mySpreadsheet,Count=2)

Retrieve the SpreadsheetRow objects for the rows.

for n = 1:mySpreadsheet.Rows
  myRows(n) = getRow(mySpreadsheet,n);
end

Add a warning flag to the first and second rows.

addFlag(myRows(1),"warning");
addFlag(myRows(2),"warning");

Retrieve the flag from the first row.

myFlags = getFlags(myRows(1));

Add and Retrieve Flags in Fault Tree Document

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 top-level gate and the first event.

addFlag(myGate,"check");
addFlag(myEvent1,"check");

Retrieve the flags in the fault tree document.

myFlags = getFlags(myFaultTreeDoc);

Add and Retrieve Flags in Fault Tree Document Event

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 top-level gate and the first event.

addFlag(myGate,"check");
addFlag(myEvent1,"check");

Get the flag from the event.

myFlag = getFlags(myEvent1);

Add and Retrieve Flags in Fault Tree Document Gate

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 top-level gate and the first event.

addFlag(myGate,"check");
addFlag(myEvent1,"check");

Retrieve the flag from the gate.

myFlag = getFlags(myGate);

Add and Retrieve Flags in Fault Tree Failure Models

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);

Each new event has a unique failure model. Retrieve the failure model from each event.

myFailureModel1 = myEvent1.FailureModel;
myFailureModel2 = myEvent2.FailureModel;

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

addFlag(myFailureModel1,"check");
addFlag(myFailureModel2,"warning");

Get the flag from the first failure model.

myFlag = getFlags(myFailureModel1);

Input Arguments

spreadsheet — Spreadsheet

Spreadsheet object

Spreadsheet in the Safety Analysis Manager, specified as a Spreadsheet object.

spreadsheetCell — Cell in Safety Analysis Manager

SpreadsheetCell object

Cell in the Safety Analysis Manager spreadsheet, specified as a SpreadsheetCell object.

spreadsheetRow — Row in Safety Analysis Manager spreadsheet

SpreadsheetRow object

Row in the Safety Analysis Manager spreadsheet, specified as a SpreadsheetRow object.

faultTreeDocument — Fault tree document

FaultTreeDocument object

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

event — Event in fault tree document

Event object

Event in the Safety Analysis Manager fault tree document, specified as an Event object.

gate — Gate in fault tree document

Gate object

Gate in the Safety Analysis Manager fault tree document, specified as a Gate object.

failureModel — Failure model in fault tree document

FailureModel object

Failure model in the Safety Analysis Manager fault tree document, specified as a FailureModel object.

Output Arguments

flags — Document or document artifact flags

DocumentFlag object array

Document or document artifact flags, returned as a DocumentFlag object array.

Version History

Introduced in R2023b

R2026b: Get flags from fault tree document elements

Use the getFlags function to get flags from FaultTreeDocument, Event, Gate, and FailureModel objects.

R2024b: SpreadsheetRow Support

The getFlags function supports SpreadsheetRow objects.