Main Content

addValueType

Create named value type in interface dictionary

Description

example

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

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

Examples

collapse all

Create a data dictionary and add a value type named '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',true);
linkDictionary(arch,'new_dictionary.sldd');

Input Arguments

collapse all

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 one that carries interface definitions. For information on how to create a dictionary, see createDictionary.

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 comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

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

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 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 of value type, specified as a character vector or string.

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

Data Types: char | 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 of value type, specified as a character vector or string.

Example: addValueType(dictionary,'airSpeed','Minimum','0')

Data Types: char | string

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

Example: addValueType(dictionary,'airSpeed','Maximum','100')

Data Types: char | 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

collapse all

New value type, returned as a systemcomposer.ValueType object.

More About

collapse all

Definitions

TermDefinitionApplicationMore Information
interface data dictionaryAn 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.

Interface dictionaries can be reused between models that need to use a given set of interfaces, elements, and value types. Data dictionaries are stored in separate SLDD files.

data interfaceA 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 an Architecture Model with Interfaces and Requirement Links
data elementA 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.

value typeA 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 interfaceAn owned interface is a locally defined 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
adapterAn adapter helps connect two components with incompatible port interfaces by mapping between the two interfaces. An adapter can also act as a unit delay or rate transition. Use the Adapter block to implement an adapter.

With an adapter, you can perform functions on the Interface Adapter dialog:

  • 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.

Introduced in R2021b