Main Content

getParameterNames

Get parameter names on element

    Description

    example

    paramNames = getParameterNames(element) gets the names of the parameters available on the specified architectural element, element.

    Examples

    collapse all

    This example shows a wheel axle architecture model with instance-specific parameters exposed in System Composer™. These parameters are defined as model arguments on the Simulink® reference model used as a model behavior linked to two System Composer components. You can change the values of these parameters independently on each reference component.

    Open mAxleArch Architecture Model

    Open the architecture model of the wheel axle mAxleArch to interact with the parameters on the reference components using the Property Inspector.

    model = systemcomposer.openModel("mAxleArch");

    Look Up RightWheel and LeftWheel Components

    Look up the Component objects for the RightWheel and LeftWheel components.

    rightWheelComp = lookup(model,Path="mAxleArch/RightWheel");
    leftWheelComp = lookup(model,Path="mAxleArch/LeftWheel");

    Get Parameter Names on RightWheel Component

    Get the parameter names for the RightWheel component. Since the LeftWheel component is linked to the same reference model mWheel, the parameters are the same on the LeftWheel component.

    paramNames = rightWheelComp.getParameterNames
    paramNames = 1×3 string
        "Pressure"    "Diameter"    "Wear"
    
    

    Get Parameter Definition on RightWheel Component for Pressure Parameter

    Get the parameter definition for the Pressure parameter on the RightWheel component architecture.

    paramDefinition = rightWheelComp.Architecture.getParameterDefinition(paramNames(1))
    paramDefinition = 
      ParameterDefinition with properties:
    
               Name: 'Pressure'
               Type: 'double'
               Unit: 'psi'
         Complexity: 'real'
         Dimensions: '[1  1]'
              Value: '32'
                Min: ''
                Max: ''
        Description: ''
              Owner: [1×1 systemcomposer.arch.Architecture]
    
    

    Get Parameter Values for RightWheel and LeftWheel Components

    Get the parameter values for the RightWheel and LeftWheel components.

    RightWheel Parameters

    for i = 1:length(paramNames)
        paramName = paramNames(i)
        [paramValue,paramUnits,isDefault] = rightWheelComp.getParameterValue(paramNames(i))
    end
    Right Wheel Parameters
    
    paramName = 
    "Pressure"
    
    paramValue = 
    '31'
    
    paramUnits = 
    'psi'
    
    isDefault = logical
       0
    
    
    paramName = 
    "Diameter"
    
    paramValue = 
    '16'
    
    paramUnits = 
    'in'
    
    isDefault = logical
       1
    
    
    paramName = 
    "Wear"
    
    paramValue = 
    '0.25'
    
    paramUnits = 
    'in'
    
    isDefault = logical
       1
    
    

    LeftWheel Parameters

    for i = 1:length(paramNames)
        paramName = paramNames(i)
        [paramValue,paramUnits,isDefault] = leftWheelComp.getParameterValue(paramNames(i))
    end
    paramName = 
    "Pressure"
    
    paramValue = 
    '32'
    
    paramUnits = 
    'psi'
    
    isDefault = logical
       1
    
    
    paramName = 
    "Diameter"
    
    paramValue = 
    '15'
    
    paramUnits = 
    'in'
    
    isDefault = logical
       0
    
    
    paramName = 
    "Wear"
    
    paramValue = 
    '0.23'
    
    paramUnits = 
    'in'
    
    isDefault = logical
       0
    
    

    Get Evaluated Parameter Values for RightWheel and LeftWheel Components

    Get the evaluated parameter values for the RightWheel and LeftWheel components.

    Evaluated RightWheel Parameters

    for i = 1:length(paramNames)
        paramName = paramNames(i)
        [paramValue,paramUnits] = rightWheelComp.getEvaluatedParameterValue(paramNames(i))
    end
    paramName = 
    "Pressure"
    
    paramValue = 31
    
    paramUnits = 
    'psi'
    
    paramName = 
    "Diameter"
    
    paramValue = 16
    
    paramUnits = 
    'in'
    
    paramName = 
    "Wear"
    
    paramValue = 0.2500
    
    paramUnits = 
    'in'
    

    Evaluated LeftWheel Parameters

    for i = 1:length(paramNames)
        paramName = paramNames(i)
        [paramValue,paramUnits] = leftWheelComp.getEvaluatedParameterValue(paramNames(i))
    end
    paramName = 
    "Pressure"
    
    paramValue = 32
    
    paramUnits = 
    'psi'
    
    paramName = 
    "Diameter"
    
    paramValue = 15
    
    paramUnits = 
    'in'
    
    paramName = 
    "Wear"
    
    paramValue = 0.2300
    
    paramUnits = 
    'in'
    

    Set Parameter Value and Units for Pressure Parameter on LeftWheel Component

    Set the parameter value and unit for the PSI parameter on the LeftWheel component.

    Current Values for Pressure on LeftWheel

    [paramValue,paramUnits,isDefault] = leftWheelComp.getParameterValue("Pressure")
    paramValue = 
    '32'
    
    paramUnits = 
    'psi'
    
    isDefault = logical
       1
    
    

    New Values for Pressure on LeftWheel

    leftWheelComp.setParameterValue("Pressure","2000")
    leftWheelComp.setUnit("Pressure","mbar")
    [paramValue,paramUnits,isDefault] = leftWheelComp.getParameterValue("Pressure")
    paramValue = 
    '2000'
    
    paramUnits = 
    'mbar'
    
    isDefault = logical
       0
    
    

    Revert Pressure Parameter on LeftWheel to Default Value

    leftWheelComp.resetParameterToDefault("Pressure")

    Save Models

    model = systemcomposer.loadModel("mWheelArch");
    save(model)
    topModel = systemcomposer.loadModel("mAxleArch");
    save(topModel)

    Input Arguments

    collapse all

    Output Arguments

    collapse all

    Parameter names, returned as an array of strings.

    Data Types: string

    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.

    Compose Architecture Visually
    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.

    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
    reference component

    A reference component is a component whose definition is a separate architecture model, Simulink® behavior model, or Simulink subsystem behavior. A reference component represents a logical hierarchy of other compositions.

    You can reuse compositions in the model using reference components. There are three types of reference components:

    • Model references are Simulink models.

    • Subsystem references are Simulink subsystems.

    • Architecture references are System Composer architecture models.

    parameter definition

    A parameter definition is the definition of a property that has instance semantics. A parameter definition specifies attributes such as name, data type, default value, and units.

    Parameter definitions can be specified as model arguments on a Simulink model or a System Composer architecture model.

    Access Model Arguments as Parameters on Reference Components
    parameter

    A parameter is an instance-specific value of a parameter definition. A parameter captures instance-specific values and units.

    Parameters are available for each component linking to a model reference or architecture reference that specifies model arguments. You can specify independent values for a parameter on each component.

    Use Parameters to Store Instance Values with Components
    subsystem component

    A subsystem component is a Simulink subsystem that is part of the parent System Composer architecture model.

    Add Simulink subsystem behavior to a component to author a subsystem component in System Composer. You cannot synchronize and reuse subsystem components as Reference Component blocks because the component is part of the parent model.

    state chart

    A state chart diagram demonstrates the state-dependent behavior of a component throughout its state lifecycle and the events that can trigger a transition between states.

    Add Stateflow® chart behavior to describe a component using state machines. You cannot synchronize and reuse Stateflow chart behaviors as Reference Component blocks because the component is part of the parent model.

    Version History

    Introduced in R2022a