Architectural Data Editor

Manage architectural data

Since R2023b

Description

The Architectural Data Editor lets you edit the Architectural Data section of a Simulink^® data dictionary. By using the Architectural Data Editor, you can manage interfaces, data types, and constants that are used by Simulink and shared across architectural models.

With the Architectural Data Editor you can:

• Create and configure definitions for interfaces, data types, and constants.

• Filter, sort, and search architectural data in the main Contents pane. See Filter and Manage Entries in Contents Pane for more information.

• Manage the architectural data of multiple data dictionaries.

• Configure AUTOSAR Classic platform properties of architectural data:

  • Configure AUTOSAR XML options and share them across models.

  • Export architectural data and AUTOSAR definitions to ARXML and other support files.

• Save requirements when there are changes in the requirements.

For more information about shared interfaces and data types, see Graphically Manage Shared Interfaces, Data Types, and Constants and Programmatically Manage Shared Interfaces, Data Types, and Constants of Architecture Models.

×

Open the Architectural Data Editor

You can open the Architectural Data Editor using any of the following methods:

• Open Model Explorer by double-clicking an .sldd file, then navigate to the Architectural Data section and click the Open Architectural Data Editor button.

• From the Interface Editor (System Composer) of a system architecture model, click the Manage interfaces, data types and dictionary references in the Architectural Data Editor button.

• From the Modeling tab of a system architecture model, select Design > Architectural Data Editor.

• Use the show function on an Architectural Data object.

  archDataObj = Simulink.dictionary.archdata.create("newDictionary.sldd");
  show(archDataObj)

• At the MATLAB^® command prompt, enter archdataeditor.

Examples

Manage Architectural Data Section of Simulink Data Dictionary

You can create a data dictionary from the Architectural Data Editor and then edit the architectural data.

From the Architectural Data Editor, to create a new data dictionary, from the File section, click New.

To configure architectural data for an existing data dictionary, click Open and select the data dictionary. Add interfaces, data types, and constants by navigating to the Create tab and selecting the desired data object.

Manage Architectural Data Section in Simulink Data Dictionary Programmatically

You can create a data dictionary and return the Architectural Data object programmatically.

Use the Simulink.dictionary.archdata.create function to create an Architectural Data object and an associated data dictionary.

archDataObj = Simulink.dictionary.archdata.create('newDictionary.sldd');

To begin editing architectural data in an existing data dictionary use the Simulink.dictionary.archdata.open function.

archDataObj = Simulink.dictionary.archdata.open('dataDictionary.sldd');

Add interfaces, data types, and constants by using the Simulink.dictionary.ArchitecturalData programmatic interfaces. For more information see Programmatically Manage Shared Interfaces, Data Types, and Constants of Architecture Models.

Manage Architectural Data of Multiple Simulink Data Dictionaries

You can open multiple data dictionaries in a single editor window and switch between them by using the Sources pane.

To manage architectural data of multiple data dictionaries:

1. From the File section, click Open to open existing data dictionaries or click New to create new data dictionaries.

2. From the Sources pane, select a data dictionary.

3. Select the Interfaces, Data Types, Constants, or platform-specific tabs to view and edit architectural data. See Create and Configure Interface, Data Type, and Constant Definitions for more information.

On the Interfaces and Data Types tabs, the Architectural Data Editor provides a DataSource column indicating the source data dictionary for each interface or data type.

To reference a data dictionary from another data dictionary:

1. Open both data dictionaries.

2. From the Sources pane, double-click the name of the data dictionary to which you want to add a referenced data dictionary. The Details pane displays the Referenced Dictionaries section.

3. In the Details pane, click Add to add a referenced dictionary. The main Contents pane displays the architectural data in the referenced data dictionary.

4. On the toolstrip, under Settings, select or clear Include content from referenced dictionaries to show or hide the data from referenced data dictionaries.

Once a data dictionary is referenced, architectural data from the referenced dictionary can be used by the open dictionary that references it. For example, the image shows that the data element in data interface MyDataInterface2 uses enumeration OtherEnum from the referenced dictionary OtherDictionary for its data type.

From the Referenced Dictionaries section of the Details pane, you can add references to existing data dictionaries, remove references, or open referenced data dictionaries in the Sources pane.

You cannot reference data dictionaries from Simulink data dictionaries that are mapped to the AUTOSAR Classic Platform. For more information see Configure AUTOSAR Classic Platform Properties in Architectural Data Section.

Create and Configure Interface, Data Type, and Constant Definitions

You can create interfaces, data types, and constants to be shared among both architecture models and other Simulink models and configure their associated properties.

On the toolstrip, in the Create section, add interface, data type, and constant definitions on the Interfaces, Data Types, and Constants tabs, respectively, by clicking the data type, interface, and constant icons.

To configure interfaces, data types, and constants, on the Interfaces, Data Types, Constants tabs, select an interface, data type, or constant object and edit its properties in the main Contents pane and in the Details pane.

On the Interfaces tab, you can view service interfaces previously created in System Composer or by using the getInterface and getInterfaceNames functions.

You can also add interfaces, data types, and constants programmatically. Add data types by using the addAliasType, addEnumType, addNumericType, addStructType, and addValueType functions.

Supported Data Types	Architectural Data Editor Operations
Alias Type	Add a Simulink.AliasType data type with the specified name to the Architectural Data section. For information about performing this operation programmatically, see addAliasType.
Enumerated Type	Add a Simulink enumeration data type Simulink.data.dictionary.EnumTypeDefinition with the specified name to the Architectural Data section. For information about performing this operation programmatically, see addEnumType.
Numeric Type	Add a Simulink.NumericType data type with the specified name to the Architectural Data section. For information about performing this operation programmatically, see addNumericType.
Structured Type	Add a Simulink.Bus type with the specified name to the Architectural Data section. For information about performing this operation programmatically, see addStructType.
Value Type	Add a Simulink.ValueType data type with the specified name to the Architectural Data section. For information about performing this operation programmatically, see addValueType.

Add interfaces using the addDataInterface and addServiceInterface function.

Add elements to interfaces using the programmatic interfaces of the Simulink.dictionary.archdata.DataInterface object and configure those elements using the Simulink.dictionary.archdata.DataElement object.

Supported Interface Elements	Architectural Data Editor Operations
Data Interface	Add a data interface object to the Architectural Data section. For information about performing this operation programmatically, see addDataInterface.
Data Element	Add a data element object to the selected data interface. For information about performing this operation programmatically, see addElement.
Physical Interface	Add a physical interface object to the Architectural Data section. For information about performing this operation programmatically, see .
Physical Element	Add a physical element object to the selected physical interface. For more information about performing this operation programmatically, see addElement.
Service Interface	Add a service interface object to the Architectural Data section. For information about performing this operation programmatically, see addServiceInterface.
Service Element	Add a service element object to the selected service interface. For more information about performing this operation programmatically, see addElement.
Function Element	Function elements are Simulink.dictionary.archdata.FunctionElement objects and are derived from the prototype of their service element

Note

Physical interfaces and service interfaces are not supported for the AUTOSAR Classic platform. For the AUTSOAR Adaptive platform configure service interfaces using a data dictionary with no applied platform mapping.

Add a Simulink.dictionary.archdata.Constant object to the dictionary by using the addConstant function.

When you save the Architectural Data section, the properties that you configured are stored in the .sldd file.

Configure AUTOSAR Classic Platform Properties in Architectural Data Section

Once you specify the platform as AUTOSAR Classic you can configure the platform-specific interface and calibration properties as well as the software address methods. Specifically:

• Define software address methods on the dedicated SwAddrMethods tab.

• Configure the AUTOSAR communication kind and calibration properties for data interfaces and interface elements.

• Set XML export options.

• Export a data dictionary, including architectural data, to ARXML.

To specify AUTOSAR Classic Platform:

• On the toolstrip, in the Platform section, select AUTOSAR Classic. The toolstrip, the main Contents pane, and the Details pane update to display platform-specific options.

To create and configure software address methods:

1. On the toolstrip, in the Create section, click SwAddrMethod. A software address method definition is added on the SwAddrMethods tab.

2. Under SwAddrMethods, set SectionType, MemoryAllocationKeywordPolicy, and Exported XML File as needed.

For more information about configuring software address methods, see Configure AUTOSAR SwAddrMethods.

To create and configure data interfaces and data elements:

1. On the toolstrip, in the Create section, click Data Interface. A data interface object is added under the Interfaces tab.

2. Under Interfaces, click a data interface and edit its name as needed.

3. While the interface is selected, configure the attributes of the interface in the main Contents pane and in the Details pane. Platform-specific interface properties InterfaceKind, IsService, and Package are located under the AUTOSAR section in the Details pane.

4. While the interface is selected, on the toolstrip, in the Create section, click Interface Element to add elements to the interface.

5. Click a data element and edit its name as needed.

6. While the data element is selected, configure its attributes in the main Contents pane and in the Details pane.

   • For Type, supported data types include ones you have created, located on the Data Types tab. See Create and Configure Interface, Data Type, and Constant Definitions for more information.

   • Platform-specific calibration properties DisplayFormat, SwAddrMethod, SwCalibrationAccess are located under the AUTOSAR section in the Details pane.

To create and configure constants:

1. On the toolstrip, in the Create section, click Constant. A constant object is added under the Constants tab.

2. Under the Constants tab, click a constant and edit its name as needed.

3. While the constant is selected, configure its attributes in the main Contents pane and in the Details pane.

   • For the Value field, only double data types are supported.

   • The MappedTo and Package properties are located under the AUTOSAR section in the Details pane.

When you save the Architectural Data section, the interface, data type, constant, and platform-specific data is saved in the .sldd file.

For more information about AUTOSAR interface and calibration properties, see Configure AUTOSAR Communication Interfaces and Configure AUTOSAR Data for Calibration and Measurement. For more information about setting AUTOSAR properties programmatically, see setPlatformProperty.

Configure AUTOSAR XML Options in Architectural Data Section

The XML Options button is available in the Platform section when the development platform is set to AUTOSAR Classic. Component and architecture models linked to the data dictionary use the same XML export parameter values as defined in the linked data dictionary.

On the toolstrip, under Platform, click the XML Options button to configure the export options.

Clicking the XML Options button opens the View and Edit XML Options dialog box and lets you set options for export to ARXML files.

For more information about XML options for classic architecture modeling, see Configure AUTOSAR XML Options and AUTOSAR XML Options Settings.

Export AUTOSAR Definitions to ARXML and Support Files

You can export AUTOSAR definitions and other architectural data defined in a data dictionary to ARXML.

On the toolstrip, under Share, click the Export button.

Clicking the Export button exports the data dictionary contents to ARXML and RTE stub header files. This operation creates a folder in the current folder that contains the ARXML files. You can use exportDictionary to programmatically perform this operation.

Filter and Manage Entries in Contents Pane

The main Contents pane provides an interactive table with information about the interface, data types, and constants objects, such as hierarchy and properties. You can select which columns appear in the table by selecting Columns in the toolstrip.

Use the main Contents pane to:

• Filter objects — Enter a universal filter or a column-specific filter.

• Edit objects — Double-click a value in the table and enter a new value. When you enter a value that is not supported, a diagnostic message appears in the pane.

• Batch edit objects — Select objects of the same type that you want to edit. Double-click a value of one of the selected objects and enter a new value. The new value applies to all selected objects.

• Reorder interface and structure type element objects — Drag an element object to a new position, or select an element object and click the Move Up and Move Down buttons in the toolstrip.

• Copy, cut, and paste objects — Select an object and press keyboard shortcuts or click the corresponding buttons in the toolstrip.

• Delete objects — Select an element object and press the Delete key or click the Delete button in the toolstrip. When you delete an interface object, you also delete the interface element objects it contains.

For more information about using the Contents pane, see Manage Interfaces with Data Dictionaries (System Composer).

Version History

Introduced in R2023b

R2024a: Cut and paste in Architectural Data Editor

Cut and paste architectural data entries across permitted tabs and data dictionaries. Select the architectural data entry and click the Cut icon located in the Edit section of the Architectural Data Editor toolstrip. You can also right-click the architectural data entry and select the Cut option from the context menu, or use the keyboard shortcut Ctrl + X.

R2023b: Architectural Data Editor replaces Interface Editor (AUTOSAR Blockset)

In R2023b, the Architectural Data Editor replaced the Interface Editor (AUTOSAR Blockset) that was introduced in R2022b.