instantiate

Create an analysis instance from a specification

Description

instance = instantiate(model,properties,name) creates an instance of a model for analysis.

Input Arguments

collapse all

The instance is generated from the model specified in this argument.

Each value for an instance in an instance model can be drawn from any stereotype in any profile on the path. The structure of the property definition parameter accommodates this approach. The definition is a structure with a field for each profile of interest. The name of the field is the name of the profile. Each profile field is itself a structure, which has a field per stereotype whose name is the name of the stereotype. Each stereotype in turn is another structure that contains two fields, one called properties, which specifies properties of interest and another called elementKinds which indicates the kinds of instance to which the values corresponding to the properties are added. The properties field is a structure that lists the required properties as Boolean fields; the name of the field is the name of the property and the value indicates whether the field can be set via the API. The elementKinds field is a list of strings whose value must be one of: 'Component', 'Port' or 'Connector' to indicate the applicable elements.

Data Types: systemcomposer.analysis.InstanceProperties

This is the name given to the instance generated from the model.

Output Arguments

collapse all

This function is part of the instance API that you can use to analyze the model iteratively, element by element.instance refers to the element instance on which the iteration is being performed.

Data Types: systemcomposer.analysis.ArchitectureInstance

Introduced in R2019a