addFlag

R2026b

Add flag to Safety Analysis Manager spreadsheet cell or row

Since R2023b

Syntax

flag = addFlag(spreadsheetCell,flagType)

flag = addFlag(spreadsheetRow,flagType)

flag = addFlag(event,flagType)

flag = addFlag(gate,flagType)

flag = addFlag(failureModel,flagType)

flag = addFlag(___,Name=Value)

Description

Spreadsheets

flag = addFlag(spreadsheetCell,flagType) adds a flag to the cell, spreadsheetCell that has the flag flagType, in a Safety Analysis Manager spreadsheet.

flag = addFlag(spreadsheetRow,flagType) adds a flag to the specified Safety Analysis Manager spreadsheet row, spreadsheetRow. (since R2024b)

Fault Tree Documents

flag = addFlag(event,flagType) adds a flag to the event, event, that has the flag flagType, in a Safety Analysis Manager fault tree document.

flag = addFlag(gate,flagType) adds a flag to the gate, gate, in a fault tree document.

flag = addFlag(failureModel,flagType) adds a flag to the failure model, failureModel, in a fault tree document.

Spreadsheets or Fault Tree Documents

flag = addFlag(___,Name=Value) adds a flag to the document element using one or more name-value arguments.

Examples

Add Flags to Spreadsheet Cells

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

Add Flags to Spreadsheet Rows

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

Add Flags to Fault Tree Events

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.

addFlag(myEvent1,"check");
addFlag(myEvent2,"warning");

Add Flags to Fault Tree Gates

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 a warning flag to the gate.

addFlag(myGate,"warning");

Add Flags to 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 uses 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 failure model.

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

Add Warning Flags with Descriptions

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",Description="This is a warning.");
addFlag(myCells(2),"warning",Description="This is another warning.");

Input Arguments

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.

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.

flagType — Type of flag

"error" | "warning" | "check"

Type of flag, specified as one of these values:

Value	Description
"error"	Creates an error flag. Elements with an error flag display the error icon .
"warning"	Creates a warning flag. Elements with a warning flag display the warning icon .
"check"	Creates a check flag. Elements with a check flag display the check icon .

Data Types: enumeration

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: addFlag(myCell,"check",Description="This indicates a check.") adds a check flag to the cell, myCell, that has a description.

Description — Flag description

string scalar | character vector

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

Data Types: char | string

Tag — Flag tag

string scalar | character vector

Flag tag, specified as a string scalar or character vector.

Data Types: char | string

Output Arguments

flag — Document flag

DocumentFlag object

Since R2026a

Document flag, returned as a DocumentFlag object.

Limitations

• When you close the spreadsheet or fault tree document, the Safety Analysis Manager deletes the flags, even if you saved the document.

Version History

Introduced in R2023b

R2026b: Add flags to fault tree document elements

Use the addFlag function to add flags to Event, Gate, and FailureModel objects in fault tree documents.

R2026a: Function returns document flag

The addFlag function returns the DocumentFlag object of the flag that you create.

R2024b: SpreadsheetRow support

Add flags to spreadsheet rows by using the addFlag function on SpreadsheetRow objects.