Main Content

addReference

Add reference to dictionary

    Description

    example

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

    Examples

    collapse all

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

    % Create a new model and add an interface to its local dictionary
    arch = systemcomposer.createModel('newModel',true);
    addInterface(arch.InterfaceDictionary,'newInterface');
    
    % Save interfaces from a local dictionary to a shared dictionary
    saveToDictionary(arch,'TopDictionary')
    
    % Open the shared dictionary
    topDictionary = systemcomposer.openDictionary('TopDictionary.sldd');

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

    % Create a new dictionary
    refDictionary = systemcomposer.createDictionary('ReferenceDictionary.sldd');
    
    % Add the new dictionary as a reference
    addReference(topDictionary,'ReferenceDictionary.sldd')

    Input Arguments

    collapse all

    Dictionary, specified as a systemcomposer.interface.Dictionary object.

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

    Example: 'ReferenceDictionary.sldd'

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    interfaceAn interface defines the kind of information that flows through a port. The same interface can be assigned to multiple ports. An interface can be composite, meaning that it can include elements that describe the properties of an interface signal.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 interfaces and interface elements and store them in an interface data dictionary for reuse between models.Define Interfaces
    interface elementAn interface element describes a portion of an interface, such as a communication message, a calculated or measured parameter, or other decomposition of that interface.

    Interface elements describe the decompositions of an interface:

    • Pins or wires in a connector or harness.

    • Messages transmitted across a bus.

    • Data structures shared between components.

    Assign Interfaces to Ports
    interface dictionaryAn interface data dictionary is a consolidated list of all the interfaces 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 and interface elements. Data dictionaries are stored in separate .sldd files.
    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.

    With an adapter, you can perform three 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.

    Interface Adapter

    Introduced in R2021a