getDocumentAttributeProperties

R2026b

Retrieve document attribute properties in Safety Analysis Manager document

Since R2024b

Syntax

properties = getDocumentAttributeProperties(spreadsheet)

properties = getDocumentAttributeProperties(faultTreeDocument)

Description

properties = getDocumentAttributeProperties(spreadsheet) returns the document attribute properties in the Safety Analysis Manager spreadsheet, spreadsheet.

properties = getDocumentAttributeProperties(faultTreeDocument) returns the document attribute properties in the Safety Analysis Manager fault tree document, faultTreeDocument.

Examples

Retrieve Properties of Document Attributes in Spreadsheet

Create a new spreadsheet in the Safety Analysis Manager.

mySpreadsheet = safetyAnalysisMgr.newSpreadsheet;

Add three document attributes to the spreadsheet by using the addDocumentAttribute function.

addDocumentAttribute(mySpreadsheet,property="myAttribute1",value="1")
addDocumentAttribute(mySpreadsheet,property="myAttribute2",value="2")
addDocumentAttribute(mySpreadsheet,property="myAttribute3",value="3")

Retrieve the document attribute properties.

docProperties = getDocumentAttributeProperties(mySpreadsheet)

docProperties = 

  1×3 string array

    "myAttribute1"    "myAttribute2"    "myAttribute3"

Retrieve Properties of Document Attributes in Fault Tree Document

Create a new fault tree document in the Safety Analysis Manager.

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

Add three document attributes to the fault tree document by using the addDocumentAttribute function.

addDocumentAttribute(myFaultTreeDoc,property="myAttribute1",value="1")
addDocumentAttribute(myFaultTreeDoc,property="myAttribute2",value="2")
addDocumentAttribute(myFaultTreeDoc,property="myAttribute3",value="3")

Retrieve the document attribute properties.

docProperties = getDocumentAttributeProperties(myFaultTreeDoc)

docProperties = 

  1×3 string array

    "myAttribute1"    "myAttribute2"    "myAttribute3"

Input Arguments

spreadsheet — Spreadsheet

Spreadsheet object

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

faultTreeDocument — Fault tree document

FaultTreeDocument object

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

Output Arguments

properties — Properties of document attributes

string array

Properties of the document attributes, returned as a string array.

Version History

Introduced in R2024b

R2026b: Retrieve document attribute properties from fault tree documents

Use the getDocumentAttributeProperties function to retrieve document attribute properties from FaultTreeDocument objects.