Main Content

addReference

Add reference to dictionary

Since R2021a

collapse all in page

    Syntax

    addReference(dictionary,reference,collisionResolutionOption)

    Description

    addReference(dictionary,reference,collisionResolutionOption) adds a referenced dictionary to a dictionary in a System Composer™ model.

    example

    Examples

    collapse all

    Add a data interface named newInterface to the local interface dictionary of the model. Save the local interface dictionary to a shared dictionary as an SLDD file.

    arch = systemcomposer.createModel("newModel");
systemcomposer.openModel("newModel");
addInterface(arch.InterfaceDictionary,"newInterface");
saveToDictionary(arch,"TopDictionary")
topDictionary = systemcomposer.openDictionary("TopDictionary.sldd");

    Create a new dictionary and add it as a reference to the existing dictionary.

    refDictionary = systemcomposer.createDictionary("ReferenceDictionary.sldd");
addReference(topDictionary,"ReferenceDictionary.sldd")

    Confirm in the Model Explorer.

    Input Arguments

    collapse all

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

    Referenced dictionary, specified as a character vector or string of the name of the referenced dictionary with the .sldd extension.

    Example: "ReferenceDictionary.sldd"

    Data Types: char | string

    Collision resolution option if there is a conflict between two interfaces with the same name in the dictionaries, specified as one of the following:

    • "KeepTop" to keep the interface from the top dictionary and remove the one in the reference dictionary.

    • "KeepReference" to keep the interface from the reference dictionary and remove the one in the top dictionary.

    • "Unspecified", which will error if any conflicts exist when creating the reference.

    Data Types: char | string

    More About

    collapse all

    Definitions

    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 R2021a

    See Also

    Functions

    Objects

    Blocks

    Tools

    Topics