addValueType

Create named value type in interface dictionary

Since R2021b

Syntax

valueType = addValueType(dictionary,name)

valueType = addValueType(dictionary,name,Name=Value)

Description

valueType = addValueType(dictionary,name) adds a named value type to a specified interface dictionary.

To remove a value type, use the destroy function.

valueType = addValueType(dictionary,name,Name=Value) adds a named value type to a specified interface dictionary with additional options.

Examples

Add Value Type

Create a data dictionary and add a value type airSpeed.

dictionary = systemcomposer.createDictionary("new_dictionary.sldd");
airSpeedType = addValueType(dictionary,"airSpeed")

Create a new model, link the data dictionary to the model, and view the Interface Editor to confirm the existence of the new value type airSpeed.

arch = systemcomposer.createModel("newModel");
linkDictionary(arch,"new_dictionary.sldd");

Input Arguments

dictionary — Data dictionary

dictionary object

Data dictionary, specified as a systemcomposer.interface.Dictionary object. You can specify the default data dictionary that defines local interfaces or an external data dictionary that carries interface definitions. If the model links to multiple data dictionaries, then dictionary must be the dictionary that carries interface definitions. For information on how to create a dictionary, see createDictionary.

name — Name of new value type

character vector | string

Name of new value type, specified as a character vector or string. This name must be a valid MATLAB^® identifier.

Example: "airSpeed"

Data Types: char | string

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: addValueType(dictionary,"airSpeed",DataType="double",Dimensions="2",Units="m/s",Complexity="complex",Minimum="0",Maximum="100",Description="Maintain altitude")

DataType — Data type of value type

character vector | string

Data type of value type, specified as a character vector or string for a valid MATLAB data type. The default value is double.

Example: addValueType(dictionary,"airSpeed",DataType="double")

Data Types: char | string

Dimensions — Dimensions of value type

character vector | string

Dimensions of value type, specified as a character vector or string. The default value is 1.

Example: addValueType(dictionary,"airSpeed",Dimensions="2")

Data Types: char | string

Units — Units of value type

character vector | string

Units of value type, specified as a character vector or string.

Example: addValueType(dictionary,"airSpeed",Units="m/s")

Data Types: char | string

Complexity — Complexity of value type

character vector | string

Complexity of value type, specified as a character vector or string. The default value is real. Other possible values are complex and auto.

Example: addValueType(dictionary,"airSpeed",Complexity="complex")

Data Types: char | string

Minimum — Minimum of value type

character vector | string

Minimum of value type, specified as a character vector or string.

Example: addValueType(dictionary,"airSpeed",Minimum="0")

Data Types: char | string

Maximum — Maximum of value type

character vector | string

Maximum of value type, specified as a character vector or string.

Example: addValueType(dictionary,"airSpeed",Maximum="100")

Data Types: char | string

Description — Description of value type

character vector | string

Description of value type, specified as a character vector or string.

Example: addValueType(dictionary,"airSpeed",Description="Maintain altitude")

Data Types: char | string

Output Arguments

valueType — Value type

value type object

Value type, returned as a systemcomposer.ValueType object.

More About

Definitions

Term	Definition	Application	More Information
interface data dictionary	An interface data dictionary is a consolidated list of all the interfaces and value types in an architecture and where they are used.	Local interfaces on a System Composer™ model can be saved in an interface data dictionary using the Interface Editor. You can reuse interface dictionaries between models that need to use a given set of interfaces, elements, and value types. Linked data dictionaries are stored in separate SLDD files.	Manage Interfaces with Data Dictionaries Reference Data Dictionaries
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 an interface 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: Pins or wires in a connector or harness. Messages transmitted across a bus. 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 helps connect two components with incompatible port interfaces by mapping between the two interfaces. An adapter can act as a unit delay or rate transition. You can also use an adapter for bus creation. Use the Adapter block to implement an adapter.	With an adapter, you can perform functions on the Interface Adapter dialog box: 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 merges two or more message or signal lines. 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