Main Content

saveToDictionary

Save interfaces to dictionary

collapse all in page

    Syntax

    saveToDictionary(model,dictionaryName)
    saveToDictionary(dictionary,dictionaryName)
    saveToDictionary(___,Name=Value)

    Description

    saveToDictionary(model,dictionaryName) saves all locally defined interfaces to a shared dictionary, and links the model to the shared dictionary with a .sldd extension.

    example

    saveToDictionary(dictionary,dictionaryName) saves all locally defined interfaces to a shared dictionary with an SLDD extension.

    saveToDictionary(___,Name=Value) saves all locally defined interfaces to a shared dictionary with additional options.

    Examples

    collapse all

    Create a model and a shared dictionary. Add an interface to the model's interface dictionary, and add an element. Save all interfaces defined in the model to the shared dictionary.

    arch = systemcomposer.createModel("newModel");
dictionary = systemcomposer.createDictionary("myInterfaces.sldd");
interface = addInterface(arch.InterfaceDictionary,"newSignal");
element = addElement(interface,"newElement",Type="double");
saveToDictionary(arch,"myInterfaces")

    Input Arguments

    collapse all

    Architecture model, specified as a systemcomposer.arch.Model object.

    Data dictionary, specified as a systemcomposer.interface.Dictionary object. For information on how to create a data dictionary, see createDictionary.

    Dictionary name, specified as a character vector or string. If a dictionary with this name does not exist, one will be created.

    Example: "myInterfaces"

    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: saveToDictionary(arch,"MyInterfaces",CollisionResolutionOption=systemcomposer.interface.CollisionResolution.USE_MODEL)

    Option to resolve interface collisions between the local model data dictionary and the shared data dictionary linked to the model, specified as one of these values:

    • systemcomposer.interface.CollisionResolution.USE_MODEL prioritizes interface duplicates using the local interfaces defined in the model.

    • systemcomposer.interface.CollisionResolution.USE_DICTIONARY prioritizes interface duplicates using the interfaces defined in the shared dictionary.

    Note

    If interface collisions are present and you do not specify a value for the CollisionResolutionOption name-value argument, the saveToDictionary function generates an error and prompts specification.

    Example: saveToDictionary(arch,"MyInterfaces",CollisionResolutionOption=systemcomposer.interface.CollisionResolution.USE_DICTIONARY)

    Data Types: enum

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    architecture

    A System Composer™ architecture represents a system of components and how they interface with each other structurally and behaviorally.

    Different types of architectures describe different aspects of systems. You can use views to visualize a subset of components in an architecture. You can define parameters on the architecture level using the Parameter Editor.
    root

    A root is at the top of an architecture hierarchy. A root architecture has a boundary defined by its architecture ports that surround the system of interest.

    The root architecture has a system boundary surrounding your architecture model. You can add architecture ports that define interfaces across the boundary.

    Compose Architectures Visually

    model

    A System Composer model is the file that contains architectural information, such as components, ports, connectors, interfaces, and behaviors.

    Perform operations on a model:

    • Extract root-level architecture.

    • Apply profiles.

    • Link interface data dictionaries.

    • Generate instances from model architecture.

    A System Composer model is stored as an SLX file.

    		Create Architecture Model with Interfaces and Requirement Links
    component

    A component is a replaceable part of a system that fulfills a clear function in the context of an architecture. A component defines an architectural element, such as a function, another system, hardware, software, or other conceptual entity. A component can also be a subsystem or subfunction.

    Represented as a block, a component is a part of an architecture model that can be separated into reusable artifacts. Transfer information between components with:

    Compose Architectures Visually

    port

    A port is a node on a component or architecture that represents a point of interaction with its environment. A port permits the flow of information to and from other components or systems.

    • Component ports are interaction points on the component to other components.

    • Architecture ports are ports on the boundary of the system, whether the boundary is within a component or the overall architecture model. The root architecture has a boundary defined by its ports.

    Compose Architectures Visually

    connector

    Connectors are lines that provide connections between ports. Connectors describe how information flows between components or architectures.

    A connector allows two components to interact without defining the nature of the interaction. Set an interface on a port to define how the components interact.

    Compose Architectures Visually

    TermDefinitionApplicationMore Information
    interface data dictionary

    An interface data dictionary is a consolidated list of interfaces and value types in an architecture and where you use them in the architecture.

    You can save local interfaces on a System Composer model in an interface data dictionary using the Interface Editor. You can reuse data dictionaries between models that need to use a given set of interfaces, elements, and value types. Data dictionaries that you link to models are stored in separate SLDD files.
    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.
    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.
    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, 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 merge 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.

    Version History

    Introduced in R2019b

    See Also

    Functions

    Objects

    Blocks

    Tools

    Topics