Main Content

systemcomposer.profile.Profile.load

Load profile from file

    Description

    example

    profile = systemcomposer.profile.Profile.load(fileName) loads a profile from a file name.

    Examples

    collapse all

    Create a profile for latency characteristics and save it.

    profile = systemcomposer.profile.Profile.createProfile('LatencyProfile');
    
    latencybase = profile.addStereotype('LatencyBase');
    latencybase.addProperty('latency','Type','double');
    latencybase.addProperty('dataRate','Type','double','DefaultValue','10');
    
    connLatency = profile.addStereotype('ConnectorLatency','Parent',...
    'LatencyProfile.LatencyBase');
    connLatency.addProperty('secure','Type','boolean');
    connLatency.addProperty('linkDistance','Type','double');
    
    nodeLatency = profile.addStereotype('NodeLatency','Parent',...
    'LatencyProfile.LatencyBase');
    nodeLatency.addProperty('resources','Type','double','DefaultValue','1');
    
    portLatency = profile.addStereotype('PortLatency','Parent',...
    'LatencyProfile.LatencyBase');
    portLatency.addProperty('queueDepth','Type','double');
    portLatency.addProperty('dummy','Type','int32');
    
    profile.save;

    Load the profile into another variable.

    newProfile = systemcomposer.profile.Profile.load('LatencyProfile')
    newProfile = 
    
      Profile with properties:
    
                Name: 'LatencyProfile'
        FriendlyName: ''
         Description: ''
         Stereotypes: [1×5 systemcomposer.profile.Stereotype]

    Input Arguments

    collapse all

    File name for profile, specified as a character vector or string. Profile must be available on the MATLAB® path.

    Example: 'ProfileName.xml'

    Example: 'LatencyProfile'

    Data Types: char | string

    Output Arguments

    collapse all

    Loaded profile, returned as a systemcomposer.profile.Profile object.

    More About

    collapse all

    Definitions

    TermDefinitionApplicationMore Information
    stereotypeA stereotype is a custom extension of the modeling language. Stereotypes provide a mechanism to extend the architecture language elements by adding domain-specific metadata.Apply stereotypes to elements: root-level architecture, component architecture, connectors, ports, data interfaces, and value types of a model. A model element can have multiple stereotypes. Stereotypes provide model elements with a common set of property fields, such as mass, cost, and power.Extend Architectural Design Using Stereotypes
    propertyA property is a field in a stereotype. For each element the stereotype is applied to, specific property values are specified.Use properties to store quantitative characteristics, such as weight or speed, that are associated with a model element. Properties can also be descriptive or represent a status. You can view and edit the properties of each element in the architecture model using the Property Inspector.
    profileA profile is a package of stereotypes to create a self-consistent domain of element types.Author profiles and apply profiles to a model using the Profile Editor. You can store stereotypes for a project in one profile or in several. Profiles are stored in XML files when they are saved.

    Introduced in R2019a