setDescription

Set description for value type or interface

Since R2021b

Syntax

setDescription(valueType,description)

setDescription(interface,description)

Description

setDescription(valueType,description) sets the description for the designated value type.

setDescription(interface,description) sets the description for the designated interface.

Examples

Set Description for Value Type

Create a model archModel.

modelName = "archModel";
arch = systemcomposer.createModel(modelName);
systemcomposer.openModel(modelName);

Add a value type airSpeed to the dictionary of the model.

airSpeedType = arch.InterfaceDictionary.addValueType("airSpeed");

Set the description for the value type as Maintain altitude.

airSpeedType.setDescription("Maintain altitude")

Input Arguments

valueType — Value type, data element, or function argument

value type object | data element object | function argument object

Value type, data element, or function argument, specified as a systemcomposer.ValueType, systemcomposer.interface.DataElement, or systemcomposer.interface.FunctionArgument object.

interface — Interface

data interface object | physical interface object | service interface object

Interface, specified as a systemcomposer.interface.DataInterface, systemcomposer.interface.PhysicalInterface, or systemcomposer.interface.ServiceInterface object.

description — Description

character vector | string

Description, specified as a character vector or string.

Data Types: char | string

More About

Definitions

Term	Definition	Application	More Information
Data dictionary	A data dictionary is a repository of data relevant to your model. The Architectural Data section of a data dictionary stores shared definitions used in Simulink® and architecture model interfaces, such as port interfaces, data types, and system wide constants. For more information, see What Is a Data Dictionary?	You can save local interfaces on a System Composer™ model to the Architectural Data section of a Simulink data dictionary using the Interface Editor. In addition to the Interface Editor, you can also use the Architectural Data Editor to manage and modify interfaces and value types.	Manage Interfaces with Data Dictionaries Reference Data Dictionaries Store Shared Data in Architectural Data Section
Data interface	A data interface defines the kind of information that flows through a port. The same interface can be assigned to multiple ports. A data interface can be composite, meaning that it can include data elements that describe the properties of an interface signal.	Data interfaces represent the information that is shared through a connector and enters or exits a component through a port. Use the Interface Editor to create and manage data interfaces and data elements and store them in a data dictionary for reuse between models.	Create Architecture Model with Interfaces and Requirement Links Define Port Interfaces Between Components
Data element	A data element describes a portion of an interface, such as a communication message, a calculated or measured parameter, or other decomposition of that interface.	Data interfaces are decomposed into data elements that can represent pins or wires in a connector or harness, messages transmitted across a bus, and data structures shared between components.	Create Interfaces Assign Interfaces to Ports
Value type	A value type can be used as a port interface to define the atomic piece of data that flows through that port and has a top-level type, dimension, unit, complexity, minimum, maximum, and description.	You can also assign the type of data elements in data interfaces to value types. Add value types to data dictionaries using the Interface Editor so that you can reuse the value types as interfaces or data elements.	Create Value Types as Interfaces
Owned interface	An owned interface is an interface that is local to a specific port and not shared in a data dictionary or the model dictionary.	Create an owned interface to represent a value type or data interface that is local to a port.	Define Owned Interfaces Local to Ports
Adapter	An adapter connects two components with incompatible port interfaces by mapping between the two interfaces. An adapter can act as a unit delay, rate transition, or merge. You can also use an adapter for bus creation. Use the Adapter block to implement an adapter.	With an adapter, on the Interface Adapter dialog box, you can: create and edit mappings between input and output interfaces, apply an interface conversion UnitDelay to break an algebraic loop, apply an interface conversion RateTransition to reconcile different sample time rates for reference models, apply an interface conversion Merge to merge two or more message or signal lines, and when output interfaces are undefined, you can use input interfaces in bus creation mode to author owned output interfaces.	Interface Adapter Adapter

Version History

Introduced in R2021b