Main Content

instantiate

Create analysis instance from specification

Description

example

instance = instantiate(arch,properties,name) creates an instance instance named name of a model architecture arch with properties properties for analysis. Get the Architecture property of the systemcomposer.arch.Model object model using model.Architecture in the MATLAB® Command Window.

Note

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

example

instance = instantiate(arch,profile,name) creates an instance instance named name of a model architecture arch with all stereotypes in a profile profile for analysis.

example

instance = instantiate(___,Name,Value) creates an instance of a model architecture for analysis with additional arguments.

Examples

collapse all

Instantiate all properties of stereotypes in a profile that will be applied to specific elements during instantiation.

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

Create a new model and apply the profile to the model.

model = systemcomposer.createModel("archModel",true);
model.applyProfile("LatencyProfile");

Specify type of elements each stereotype can be applied on.

NodeLatency = struct("elementKinds",["Component"]);
ConnectorLatency = struct("elementKinds",["Connector"]);
LatencyBase = struct("elementKinds",["Connector","Port","Component"]);
PortLatency = struct("elementKinds",["Port"]);

Create the analysis structure.

LatencyAnalysis = struct("NodeLatency",NodeLatency, ...
                "ConnectorLatency",ConnectorLatency, ...
                "PortLatency",PortLatency, ...
                "LatencyBase",LatencyBase);

Create the properties structure.

properties = struct("LatencyProfile",LatencyAnalysis);

Instantiate all properties of stereotypes in the profile.

instance = instantiate(model.Architecture,properties,"NewInstance")

Instantiate specific properties of stereotypes in a profile that will be applied to specific elements during instantiation.

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

Create a new model and apply the profile to the model.

model = systemcomposer.createModel("archModel",true);
model.applyProfile("LatencyProfile");

Specify some properties of the stereotypes in the profile.

NodeLatency = struct("elementKinds",["Component"], ...
                "properties",struct("resources",true));
ConnectorLatency = struct("elementKinds",["Connector"], ...
                "properties",struct("secure",true,"linkDistance",true));
LatencyBase = struct("elementKinds",[], ...
                "properties",struct("dataRate",true,"latency",false));
PortLatency = struct('elementKinds',["Port"], ...
                "properties",struct("queueDepth",true));
 
LatencyAnalysis = struct("NodeLatency",NodeLatency, ...
                "ConnectorLatency",ConnectorLatency, ...
                "PortLatency",PortLatency, ...
                "LatencyBase",LatencyBase);

Create the properties structure.

properties = struct("LatencyProfile",LatencyAnalysis);

Instantiate some properties of stereotypes in the profile.

instance = instantiate(model.Architecture,properties,"NewInstance")

Instantiate all stereotypes already in a profile that will be applied to elements during instantiation.

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

Create a new model and apply the profile to the model.

model = systemcomposer.createModel("archModel",true);
model.applyProfile("LatencyProfile");

Instantiate all stereotypes in a profile.

instance = instantiate(model.Architecture,"LatencyProfile","NewInstance")

Create an instantiation for analysis for a system with latency in its wiring. The materials used are copper, fiber, and WiFi.

Create Latency Profile with Stereotypes and Properties

Create a System Composer profile with a base, connector, component, and port stereotype. Add properties with default values to each stereotype as needed for analysis.

profile = systemcomposer.profile.Profile.createProfile("LatencyProfileC");

Add a base stereotype with properties.

latencybase = profile.addStereotype("LatencyBase");
latencybase.addProperty("latency",Type="double");
latencybase.addProperty("dataRate",Type="double",DefaultValue="10");

Add a connector stereotype with properties.

connLatency = profile.addStereotype("ConnectorLatency",...
    Parent="LatencyProfileC.LatencyBase");
connLatency.addProperty("secure",Type="boolean",DefaultValue="true");
connLatency.addProperty("linkDistance",Type="double");

Add a component stereotype with properties.

nodeLatency = profile.addStereotype("NodeLatency",...
    Parent="LatencyProfileC.LatencyBase");
nodeLatency.addProperty("resources",Type="double",DefaultValue="1");

Add a port stereotype with properties.

portLatency = profile.addStereotype("PortLatency",...
    Parent="LatencyProfileC.LatencyBase");
portLatency.addProperty("queueDepth",Type="double",DefaultValue="4.29");
portLatency.addProperty("dummy",Type="int32");

Instantiate Using Analysis Function

Create a new model and apply the profile. Create components, ports, and connections in the model. Apply stereotypes to the model elements. Finally, instantiate using the analysis function.

model = systemcomposer.createModel("archModel",true);
arch = model.Architecture;

Apply profile to model.

model.applyProfile("LatencyProfileC");

Create components, ports, and connections.

componentSensor = addComponent(arch,"Sensor");
sensorPorts = addPort(componentSensor.Architecture,{'MotionData','SensorPower'},{'in','out'});

componentPlanning = addComponent(arch,"Planning");
planningPorts = addPort(componentPlanning.Architecture,{'Command','SensorPower','MotionCommand'},{'in','in','out'});
componentMotion = addComponent(arch,"Motion");
motionPorts = addPort(componentMotion.Architecture,{'MotionCommand','MotionData'},{'in','out'});

c_sensorData = connect(arch,componentSensor,componentPlanning);
c_motionData = connect(arch,componentMotion,componentSensor);
c_motionCommand = connect(arch,componentPlanning,componentMotion);

Clean up the canvas.

Simulink.BlockDiagram.arrangeSystem("archModel"); 

Batch apply stereotypes to model elements.

batchApplyStereotype(arch,"Component","LatencyProfileC.NodeLatency");
batchApplyStereotype(arch,"Port","LatencyProfileC.PortLatency");
batchApplyStereotype(arch,"Connector","LatencyProfileC.ConnectorLatency");

Instantiate using the analysis function.

instance = instantiate(model.Architecture,"LatencyProfileC","NewInstance",...
    Function=@calculateLatency,Arguments="3", ...
    Strict=true,NormalizeUnits=false,Direction="PreOrder")
instance = 
  ArchitectureInstance with properties:

        Specification: [1x1 systemcomposer.arch.Architecture]
             IsStrict: 1
       NormalizeUnits: 0
     AnalysisFunction: @calculateLatency
    AnalysisDirection: PreOrder
    AnalysisArguments: '3'
      ImmediateUpdate: 0
           Components: [1x3 systemcomposer.analysis.ComponentInstance]
                Ports: [0x0 systemcomposer.analysis.PortInstance]
           Connectors: [1x3 systemcomposer.analysis.ConnectorInstance]
                 Name: 'NewInstance'

Inspect Component, Port, and Connector Instances

Get properties from component, port, and connector instances.

defaultResources = instance.Components(1).getValue("LatencyProfileC.NodeLatency.resources")
defaultResources = 1
defaultSecure = instance.Connectors(1).getValue("LatencyProfileC.ConnectorLatency.secure")
defaultSecure = logical
   1

defaultQueueDepth = instance.Components(1).Ports(1).getValue("LatencyProfileC.PortLatency.queueDepth")
defaultQueueDepth = 4.2900

Input Arguments

collapse all

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

Stereotype properties, specified as a structure containing profile, stereotype, and property information. Use properties to specify which stereotypes and properties need to be instantiated.

Data Types: struct

Name of instance generated from the model, specified as a character vector or string.

Example: "NewInstance"

Data Types: char | string

Profile name, specified as a character vector or string.

Example: 'LatencyProfile'

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: instantiate(model.Architecture,"LatencyProfile","NewInstance",Function=@calculateLatency,Arguments="3",Strict=true,NormalizeUnits=false,Direction="PreOrder")

Whether to normalize value based on units, if any, specified in property definition upon instantiation, specified as a logical.

Example: instantiate(model.Architecture,'LatencyProfile','NewInstance','NormalizeUnits',true)

Data Types: logical

Analysis function, specified as the MATLAB function handle to be executed when analysis is run.

Analysis arguments, specified as a character vector, string, array of strings, or a cell array of character vectors of optional arguments to the analysis function.

Data Types: char | string

Iteration type, specified as "PreOrder", "PostOrder", "TopDown", or "BottomUp".

  • Pre-order — Start from the top level, move to a child component, and process the subcomponents of that component recursively before moving to a sibling component.

  • Top-Down — Like pre-order, but process all sibling components before moving to their subcomponents.

  • Post-order — Start from components with no subcomponents, process each sibling, and then move to parent.

  • Bottom-up — Like post-order, but process all subcomponents at the same depth before moving to their parents.

Data Types: char | string

Condition for instances getting properties only if the specification of the instance has the stereotype applied, specified as a logical.

Data Types: logical

Output Arguments

collapse all

Architecture instance, returned as a systemcomposer.analysis.ArchitectureInstance object.

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. You can represent specific architectures using alternate views.

Different types of architectures describe different aspects of systems:

  • Functional architecture describes the flow of data in a system.

  • Logical architecture describes the intended operation of a system.

  • Physical architecture describes the platform or hardware in a system.

You can define parameters on the architecture level using the Parameter Editor.

model

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

Perform operations on a model:

  • Extract the root-level architecture contained in the model.

  • 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 nontrivial, nearly independent, and 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, a 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:

Components
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.

There are different types of ports:

  • 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.

Ports
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.

Connections

TermDefinitionApplicationMore Information
stereotype

A 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 model elements such as root-level architecture, component architecture, connectors, ports, data interfaces, value types, functions, requirements, and links. Functions only apply to software architectures. You must have a Requirements Toolbox™ license to apply stereotypes to requirements and links. 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
property

A property is a field in a stereotype. You can specify property values for each element to which the stereotype is applied.

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.

profile

A profile is a package of stereotypes that you can use 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 or several profiles. When you save profiles, they are stored in XML files.

TermDefinitionApplicationMore Information
analysis

Analysis is a method for quantitatively evaluating an architecture for certain characteristics. Static analysis analyzes the structure of the system. Static analysis uses an analysis function and parametric values of properties captured in the system model.

Use analyses to calculate overall reliability, mass roll-up, performance, or thermal characteristics of a system, or to perform a SWaP analysis.

analysis function

An analysis function is a MATLAB function that computes values necessary to evaluate the architecture using the properties of each element in the model instance.

Use an analysis function to calculate the result of an analysis.

instance model

An instance model is a collection of instances.

You can update an instance model with changes to a model, but the instance model will not update with changes in active variants or model references. You can use an instance model, saved in a MAT file, of a System Composer architecture model for analysis.

Run Analysis Function
instance

An instance is an occurrence of an architecture model element at a given point in time.

An instance freezes the active variant or model reference of the component in the instance model.

Create a Model Instance for Analysis

Version History

Introduced in R2019a