createComponentAsModel

Create Simulink representation of AUTOSAR ARXML atomic software component

Syntax

createComponentAsModel(ar,ComponentName)

[mdl, sts] = createComponentAsModel(ar,ComponentName,Name,Value)

Description

createComponentAsModel(ar,ComponentName) creates a Simulink^® model corresponding to AUTOSAR atomic software component ComponentName. The component description is part of AUTOSAR information previously imported from AUTOSAR XML files, which is represented by arxml.importer object ar.The importer creates an initial Simulink representation of the imported AUTOSAR component, with an initial, default mapping of Simulink model elements to AUTOSAR component elements. The initial representation provides a starting point for further AUTOSAR configuration and Model-Based Design. For more information, see AUTOSAR ARXML Importer.

The initial representation of AUTOSAR component behavior in the created model depends on the XML description:

• If the XML description of the component does not describe component behavior, the importer creates a model with a default representation of AUTOSAR runnables and ports.

• If the XML description of the component describes component behavior, the importer creates a model based on AUTOSAR elements that are accessed in the component.

  For example, AUTOSAR ports must be accessed by runnables in order to generate the corresponding Simulink elements. If a sender-receiver or client-server port in XML code is not accessed by a runnable, the importer does not create the corresponding inports, outports, or Simulink functions.

[mdl, sts] = createComponentAsModel(ar,ComponentName,Name,Value) specifies additional options for Simulink model creation with one or more Name,Value pair arguments.

Examples

Import AUTOSAR Component and Model Periodic Runnables as Atomic Subsystems

Import AUTOSAR software component /pkg/swc from XML file mySWC.arxml and create an initial Simulink representation of the component. Model AUTOSAR periodic runnables as atomic subsystems with periodic rates.

ar = arxml.importer('mySWC.arxml')
createComponentAsModel(ar,'/pkg/swc','ModelPeriodicRunnablesAs','AtomicSubsystem')

Import AUTOSAR Component and Model Periodic Runnables as Function-Call Subsystems

Import AUTOSAR software component /pkg/swc from XML file mySWC.arxml and create an initial Simulink representation of the component. Model AUTOSAR periodic runnables as function-call subsystems with periodic rates.

ar = arxml.importer('mySWC.arxml')
createComponentAsModel(ar,'/pkg/swc','ModelPeriodicRunnablesAs','FunctionCallSubsystem')

Import AUTOSAR Component and Use Data Dictionary

Import AUTOSAR software component /pkg/swc from XML file mySWC.arxml and create an initial Simulink representation of the component. Place Simulink data objects corresponding to AUTOSAR data types into data dictionary ardata.sldd.

ar = arxml.importer('mySWC.arxml')
createComponentAsModel(ar,'/pkg/swc','ModelPeriodicRunnablesAs','AtomicSubsystem',...
  'DataDictionary','ardata.sldd')

Import AUTOSAR Component and Designate Initialization Runnable

Import AUTOSAR software component /pkg/swc from XML file mySWC.arxml and create an initial Simulink representation of the component. Configure AUTOSAR runnable Runnable_Init as the initialization runnable for the component.

ar = arxml.importer('mySWC.arxml')
createComponentAsModel(ar,'/pkg/swc','ModelPeriodicRunnablesAs','AtomicSubsystem',...
  'InitializationRunnable','Runnable_Init')

Import AUTOSAR Component and Use PredefinedVariant to Resolve Variation Points

Import AUTOSAR software component /pkg/swc from XML file mySWC.arxml and create an initial Simulink representation of the component. Use PredefinedVariant Senior to resolve variation points in the component at model creation time.

ar = arxml.importer('mySWC.arxml')
createComponentAsModel(ar,'/pkg/swc','ModelPeriodicRunnablesAs','AtomicSubsystem',...
  'PredefinedVariant','/pkg/body/Variants/Senior');

Import AUTOSAR Component and Use SwSystemconstantValueSets to Resolve Variation Points

Import AUTOSAR software component /pkg/swc from XML file mySWC.arxml and create an initial Simulink representation of the component. Use SwSystemconstantValueSets A and B to resolve variation points in the component at model creation time.

ar = arxml.importer('mySWC.arxml')
createComponentAsModel(ar,'/pkg/swc','ModelPeriodicRunnablesAs','AtomicSubsystem',...
  'SystemConstValueSets',{'/pkg/body/SystemConstantValues/A','/pkg/body/SystemConstantValues/B'});

Input Arguments

ar — arxml.importer object

handle

AUTOSAR information previously imported from XML files, specified as an arxml.importer object handle.

ComponentName — Component path

character vector | string scalar

Absolute short-name path of the atomic software component.

Example: '/Company/Powertrain/Components/ASWC'

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: 'ModelPeriodicRunnablesAs','AtomicSubsystem' directs the importer to model AUTOSAR periodic runnables as atomic subsystems with periodic rates.

DataDictionary — Simulink data dictionary

character vector | string scalar

Simulink data dictionary into which to import data objects corresponding to AUTOSAR data types in the XML file. If the specified dictionary does not already exist, the importer creates it. The model is then associated with that data dictionary.

Example: 'DataDictionary','ardata.sldd'

InitializationRunnable — Initialization runnable

character vector | string scalar

Name of an existing AUTOSAR runnable to select as the initialization runnable for the component.

Example: 'InitializationRunnable','Runnable_Init'

ModelPeriodicRunnablesAs — Subsystem type for periodic runnables

'AtomicSubsystem' (default) | 'FunctionCallSubsystem' | 'Auto'

By default, createComponentAsModel imports AUTOSAR periodic runnables found in ARXML files and models them as atomic subsystems with periodic rates. If conditions prevent use of atomic subsystems, the importer throws an error.

To model periodic runnables as function-call subsystems with periodic rates, specify 'FunctionCallSubsystem'.

If you specify Auto, the importer attempts to model periodic runnables as atomic subsystems. If conditions prevent use of atomic subsystems, the importer models periodic runnables as function-call subsystems.

For more information, see Import AUTOSAR Software Component with Multiple Runnables.

Example: 'ModelPeriodicRunnablesAs','AtomicSubsystem'

PredefinedVariant — Path to AUTOSAR predefined variant

character vector | string scalar

Path to a PredefinedVariant defined in the AUTOSAR XML file. A PredefinedVariant describes a combination of system constant values among potentially multiple valid combinations to apply to an AUTOSAR software component. Use this argument to resolve variation points in the AUTOSAR software component at model creation time. If specified, the importer uses the PredefinedVariant to initialize SwSystemconst data that serves as input to control variation points.

For more information, see Control AUTOSAR Variants with Predefined Value Combinations.

Example: 'PredefinedVariant','/pkg/body/Variants/Senior'

SystemConstValueSets — Paths to one or more AUTOSAR system constant value sets

cell array of character vectors | string array

Paths to one or more SystemConstValueSets defined in the AUTOSAR XML file. A SystemConstValueSet specifies a set of system constant values to apply to an AUTOSAR software component. Use this argument to resolve variation points in the AUTOSAR software component at model creation time. If specified, the importer uses the SystemConstValueSets to initialize SwSystemconst data that serves as input to control variation points.

For more information, see Control AUTOSAR Variants with Predefined Value Combinations.

Example: 'SystemConstValueSets','{'/pkg/body/SystemConstantValues/A','/pkg/body/SystemConstantValues/B'}'

UseBusElementPorts — Whether to use of bus element ports

false (default) | true

Whether to use bus element ports in place of Simulink inports and outports for port-based sender-receiver communication.

Example: 'UseBusElementPorts',true

Data Types: logical

UseFunctionPorts — Option to use Simulink function ports

false or 0 (default) | true or 1

Option to import client-server ports as Simulink function ports, specified as a numeric or logical 1 (true) or 0 (false).

• true — Port-scoped Simulink functions and function callers are used.

• false— Global Simulink functions and function callers are used.

Example: "UseFunctionPorts"=true

Data Types: logical

UseValueTypes — Option to use Simulink.ValueType objects

true (default) | false

Option to import AUTOSAR data types as Simulink.ValueType data type objects, specified as either true (1), or false (0).

Example: "useValueTypes"=false

Data Types: logical

Output Arguments

mdl — Model handle

handle

Variable that returns a handle to created model.

sts — Success or failure

true or false

Variable that returns true if the import is successful. Otherwise, returns false.

Tips

• If you enter the arxml.importer object function call without a terminating semicolon (;), the importer lists the AUTOSAR content of the specified XML file or files. The information includes paths to software components in the AUTOSAR package structure, which you can specify in calls to createComponentAsModel and createCompositionAsModel.

• When importing an AUTOSAR software component into a model, it is recommended that you explicitly specify the 'ModelPeriodicRunnablesAs' argument. This argument determines how the importer models AUTOSAR periodic runnables in the created model. See the argument description under Name-Value Arguments.

Version History

Introduced in R2008a

R2024b: Import client-server ports as Simulink function ports for client-server communication

Starting in R2024b, you can specify the name-value argument UseFunctionPorts to use port-scoped Simulink functions and function callers.

R2024a: Import AUTOSAR data types as Simulink.ValueType objects

Starting in R2024a, you can specify whether to import AUTOSAR data types as Simulink.ValueType objects using the UseValueTypes name-value argument.

R2023b: Use bus element ports for port-based server communication

Starting in R2023b a name-value argument 'UseBusElementPorts' is supported which allows bus element ports to be used in place of Simulink inports and outports for port-based server communication.

R2022b: Import for Basic Software blocks

createComponentAsModel supports creating AUTOSAR Basic Software (BSW) caller blocks for ARXML-imported software components that access Diagnostic Event Manager (Dem), NVRAM Manager (NvM), or Function Inhibition Manager (FiM) services through client-server calls.