DocumentFlag

Flags in Safety Analysis Manager

Since R2023b

Description

DocumentFlag objects represent flags in Safety Analysis Manager spreadsheet cells and rows. Use DocumentFlag objects to configure flags you use for safety analyses.

Creation

To create a DocumentFlag object, use the getFlags function to retrieve the flags in a Safety Analysis Manager spreadsheet, spreadsheet row, or spreadsheet cell.

Properties

Type — Type of flag

'error' | 'warning' | 'check'

This property is read-only after you create the flag. To specify this property, define the flagType argument when you use the addFlag function.

Type of flag, represented as one of these values:

Value	Description
'error'	An error flag. Cells and rows with an error flag display the error icon .
'warning'	A warning flag. Cells and rows with a warning flag display the warning icon .
'check'	A check flag. Cells and rows with a check flag display the check icon .

Data Types: enumeration

Description — Description of flag

'' (default) | string scalar | character vector

This property is read-only after you create the flag. To specify this property, define the Description name-value argument when you use the addFlag function.

Description of the flag, represented as a character vector.

Data Types: char

Tag — Flag tag

'' (default) | character vector

This property is read-only after you create the flag. To specify this property, define the Tag name-value argument when you use the addFlag function.

Flag tag, represented as a character vector.

Data Types: char

FlaggedObject — Cell or row that contains flag

Read-only: SpreadsheetCell object | SpreadsheetRow object

This property is read-only.

Cell or row in the Safety Analysis Manager spreadsheet that contains the flag, represented as a SpreadsheetCell (since R2023b) or SpreadsheetRow (since R2024b) object.

Object Functions

clear

Clear Safety Analysis Manager document flag

Examples

Add and Retrieve Flags from New 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 DocumentFlag objects from 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 DocumentFlag object from the cell in the first row.

myFlags = getFlags(myCells(1));

Version History

Introduced in R2023b

R2024b: SpreadsheetRow Support

SpreadsheetRow objects support flags.