instantiate - Create analysis instance from specification - MATLAB (original) (raw)

Create analysis instance from specification

Syntax

Description

[instance](#mw%5F0dde3a14-973c-4ff9-99b7-fa1d14a32eab) = instantiate([arch](#mw%5F922735d9-aa7e-44e6-9d7f-8e5f7b71c8e6%5Fsep%5Fmw%5Feac4bd99-f7ec-4b2d-8753-44a4fc3f47d4),[properties](#mw%5Fb65553b1-4463-418d-85a2-45a8bb57c6ed),[name](#mw%5F4dd86fa4-0dc5-44ad-8e6b-a4f88ed67f51)) 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 usingmodel.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](#mw%5F0dde3a14-973c-4ff9-99b7-fa1d14a32eab) = instantiate([arch](#mw%5F922735d9-aa7e-44e6-9d7f-8e5f7b71c8e6%5Fsep%5Fmw%5Feac4bd99-f7ec-4b2d-8753-44a4fc3f47d4),[profile](#mw%5Fc0c672d7-d66d-4700-b066-2b6ce5c27fa8),[name](#mw%5F4dd86fa4-0dc5-44ad-8e6b-a4f88ed67f51)) creates an instance instance named name of a model architecture arch with all stereotypes in a profileprofile for analysis.

example

[instance](#mw%5F0dde3a14-973c-4ff9-99b7-fa1d14a32eab) = instantiate(___,[Name=Value](#namevaluepairarguments)) creates an instance of a model architecture for analysis with additional arguments.

example

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"); 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"); 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"); 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 Wi-Fi®.

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"); systemcomposer.openModel("archModel")

ans = Model with properties:

               Name: 'archModel'
     SimulinkHandle: 153.0012
       Architecture: [1×1 systemcomposer.arch.Architecture]
           Profiles: [0×0 systemcomposer.profile.Profile]
InterfaceDictionary: [1×1 systemcomposer.interface.Dictionary]
              Views: [0×0 systemcomposer.view.View]
       Interactions: [0×0 systemcomposer.interaction.Interaction]

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: [1×1 systemcomposer.arch.Architecture]
         IsStrict: 1
   NormalizeUnits: 0
 AnalysisFunction: @calculateLatency
AnalysisDirection: PreOrder
AnalysisArguments: '3'
  ImmediateUpdate: 0
      listenerFnc: []
       Components: [1×3 systemcomposer.analysis.ComponentInstance]
            Ports: [0×0 systemcomposer.analysis.PortInstance]
       Connectors: [1×3 systemcomposer.analysis.ConnectorInstance]
       Parameters: [0×0 systemcomposer.analysis.InstanceParameter]
             Name: 'NewInstance'

Inspect Component, Port, and Connector Instances

Get properties from component, port, and connector instances.

defaultResources = instance.Components(1).getValue("LatencyProfileC.NodeLatency.resources")

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

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

collapse all

Specify optional pairs of arguments asName1=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 1 (true) or 0 (false).

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

Data Types: char | string

Condition for instances getting properties only if the specification of the instance has the stereotype applied, specified as 1 (true) or 0 (false).

Data Types: logical

Output Arguments

More About

collapse all

Term Definition Application More Information
Architecture A System Composer™ architecture represents a system of components and how they interface with each other structurally and behaviorally. Different types of architectures describe different aspects of systems. You can use views to visualize a subset of components in an architecture. You can define parameters on the architecture level using the Parameter Editor. Compose Architectures VisuallyAuthor Parameters in System Composer Using Parameter Editor
Root A root is at the top of an architecture hierarchy. A root architecture has a boundary defined by its architecture ports that surround the system of interest. The root architecture has a system boundary surrounding your architecture model. You can add architecture ports that define interfaces across the boundary. Compose Architectures Visually
Model A System Composer model is the file that contains architectural information, such as components, ports, connectors, interfaces, and behaviors. Perform operations on a model including extracting root-level architecture, applying profiles, linking interface data dictionaries, or generating 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 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, another 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 port interfaces using the Interface Editor, and parameters using the Parameter Editor. Compose Architectures Visually
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. 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. The root architecture has a boundary defined by its ports. Compose Architectures Visually
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. Compose Architectures Visually
Term Definition Application More Information
Analysis Static analysis analyzes the structure of the system to quantitatively evaluate an architecture for certain characteristics. Static analysis uses an analysis function and parametric values of properties and parameters 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 size, weight, and power (SWaP) analysis to increase efficiency. Analyze Architecture Model Properties with Analysis FunctionAnalyze ArchitectureSimple Roll-Up Analysis Using Robot System with Properties
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 and instance-specific parameters at the component and architecture levels. Use an analysis function to calculate the result of an analysis. Analysis Function ConstructsWrite Analysis Function
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

See Also

Tools

Functions

Objects

Topics