SpreadsheetCell

Cell in spreadsheet in Safety Analysis Manager

Since R2023b

Description

SpreadsheetCell objects represent cells in spreadsheets in the Safety Analysis Manager. Use SpreadsheetCell objects to configure spreadsheet cell properties you use in safety analyses.

Creation

To create a SpreadsheetCell object:

• Use the getCell function on a Spreadsheet object.

• Select a cell in a Safety Analysis Manager spreadsheet and use the safetyAnalysisMgr.getCurrentSelection function.

• Use the getCell function on a SpreadsheetRow object. (since R2024b)

Properties

Row — Row location of cell

Read-only: positive integer

This property is read-only.

Row location of the cell in the spreadsheet, represented as a positive integer. The row index of the topmost row of the spreadsheet is 1.

Data Types: uint64

Column — Column location of cell

Read-only: positive integer

This property is read-only.

Column location of the cell in the spreadsheet, represented as a positive integer. The column index of the leftmost column of the spreadsheet is 1.

Data Types: uint64

ColumnLabel — Label of column

Read-only: character vector

This property is read-only.

Label of the column in the spreadsheet that contains the cell, represented as a character vector.

Data Types: char

Value — Value of cell

string scalar | character vector | true or 1 | false or 0 | enumeration class value

Value of the cell, specified as a character vector, a numeric or logical 1 (true) or 0 (false), or an enumeration class value. The value type that you can specify depends on the column type that contains the cell:

Column Type	Value Type	More Information
Text	String scalar or character vector	Add Rows and Columns to a Spreadsheet
Check Box	Logical true (1) or false (0)	Create a Check Box Column
Enumeration	String scalar, character vector, or explicit value specified by an enumeration class	Create an Enumeration Column Add Enumeration Type Column
Derived	String scalar derived from the output of the column formula	Create a Derived Column That Outputs Based on Two Column Values

Data Types: char | logical | string

Description — Cell description

'' (default) | string scalar | character vector

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

Data Types: char | string

Object Functions

acceptAllChanges	Accept detected changes to linked artifacts in Safety Analysis Manager
addFlag	Add flag to Safety Analysis Manager spreadsheet cell or row
addReference	Add references to cells
clearFlags	Clear flags in Safety Analysis Manager spreadsheet
getChanges	Get changed artifacts linked to artifacts in Safety Analysis Manager
getFlags	Retrieve flags from Safety Analysis Manager spreadsheets
getLinks	Get links associated with spreadsheet cell or row in Safety Analysis Manager
getReferencedValues	Get referenced cell values
getReferences	Get referenced cells
getRow	Retrieve spreadsheet rows
getSpreadsheet	Retrieve spreadsheet containing specified cell
moveReference	Change order of references
removeReference	Remove references in Safety Analysis Manager spreadsheets

Examples

Assign Value in Specified Cell of Spreadsheet

Suppose that only one spreadsheet is loaded in the Safety Analysis Manager. Retrieve the Spreadsheet object of the spreadsheet.

mySpreadsheet = safetyAnalysisMgr.getOpenDocuments;

Retrieve the cell in the second row and the second column of the spreadsheet as a SpreadsheetCell object.

myCell = getCell(mySpreadsheet,2,2);

Set the cell value to This is a value.

myCell.Value = "This is a value";

Create References Between Two Spreadsheets and Retrieve CellReference Objects

Since R2024b

Create two Safety Analysis Manager spreadsheets, and store each Spreadsheet objects in a variable.

mySpreadsheet1 = safetyAnalysisMgr.newSpreadsheet;
mySpreadsheet2 = safetyAnalysisMgr.newSpreadsheet;

Add three rows to each spreadsheet by using the addRow function.

addRow(mySpreadsheet1,Count=3)
addRow(mySpreadsheet2,Count=3)

Add a text and derived column that have custom labels to the spreadsheet assigned to mySpreadsheet2 by using the addColumn function.

addColumn(mySpreadsheet2,Count=2,Type=["text","derived"]...
  ,Label=["Text Column","Derived Column"])

Save the spreadsheets.

save(mySpreadsheet1,"spreadsheet1.mldatx")
save(mySpreadsheet2,"spreadsheet2.mldatx")

Retrieve the SpreadsheetCell objects for the first cell in the mySpreadsheet1 spreadsheet and the first cell in the derived column in the mySpreadsheet2 spreadsheet.

myCell1 = getCell(mySpreadsheet1,1,1);
myCell2 = getCell(mySpreadsheet2,1,"Derived Column");

Create a reference where the myCell2 cell references the myCell1 cell by using the addReference function.

addReference(myCell2,myCell1)

Retrieve the CellReference object of the referenced cell by using the getReferences function on the myCell2 cell.

mySourceCells = getReferences(myCell2);
mySourceCells{1}

ans = 

  CellReference with properties:

       FileName: 'C:\spreadsheet2.mldatx'
            Row: 1
         Column: 1
    ColumnLabel: 'Label1'
          Value: ''

Limitations

• The SpreadsheetCell objects that you use is derived column formulas are read-only.

Version History

Introduced in R2023b

R2024b: Track changes to artifacts linked to spreadsheet cells in a project

If you have Requirements Toolbox™, identify changes to links or artifacts linked to cells and rows in a spreadsheet contained in a project.

• Accept the changes in the spreadsheet cell by using the acceptAllChanges function.

• Retrieve more information about the changes with the ChangeInformation object. Create ChangeInformation objects by using the getChanges function on the spreadsheet cell.

R2024b: Configure References

Use these functions on SpreadsheetCell to configure references in derived column cells:

• addReference

• getReferences

• getReferencedValues

• moveReference

• removeReference

The getReferences function returns a CellReference object.

R2024b: SpreadsheetRow Support

Retrieve spreadsheet rows by using the getRow function on SpreadsheetCell objects.