importModels

Class: mbcrunner

Import new models into CAGE project

Since R2024b

Syntax

[models,updatedItems,updatedTables,diagnosticsMessage] = importModels(obj,mdls)

[models,updatedItems,updatedTables,diagnosticsMessage] = importModels(obj,mdls,Name=Value)

Description

[models,updatedItems,updatedTables,diagnosticsMessage] = importModels(obj,mdls) imports the models specified by mdls to the CAGE project specified by obj and reruns optimizations and feature filling.

[models,updatedItems,updatedTables,diagnosticsMessage] = importModels(obj,mdls,Name=Value) import models to a CAGE project using additional options specified by name-value arguments.

Input Arguments

obj — Handle to CAGE project

mbcrunner object

Handle to the CAGE project, specified as an mbcrunner object.

mdls — Models to import

mbcmodel.project object | mbcmodel.testplan object | cell array of mbcmodel.model objects

Models to import, specified as an mbcmodel.project object, mbcmodel.testplan object, or a cell array of mbcmodel.model objects.

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.

Example: models = importModels(mbcrunner,model,RunUpdates=true)

Composite — Option to import composite model

false (default) | true

Option to import a composite model, specified as false or true.

Example: Composite=true

Data Types: logical

RunUpdates — Option to rerun optimizations and feature filling

true (default) | false

Option to rerun optimizations and feature filling, specified as true or false.

Example: RunUpdates=false

Data Types: logical

Output Arguments

models — Imported models

1-by-n vector of strings

Imported models, returned as a 1-by-n vector of strings.

updatedItems — Updated features and optimizations

1-by-n vector of strings

Updated features and optimizations, returned as a 1-by-n vector of strings.

updatedTables — Updated lookup tables

1-by-n vector of strings

Updated lookup tables, returned as a 1-by-n vector of strings.

diagnosticsMessage — Diagnostic message from import

character array

Diagnostic message from the import, returned as a character array.

Data Types: char

Examples

Import Models from CAGE Project

Import models from the GasolineOneStage model project to the GasolineOneStage CAGE model template.

proj = mbcmodel.LoadProject(fullfile(matlabroot,'toolbox', 'mbc', 'mbctraining', 'gasolineOneStage.mat'));
r = mbcrunner(fullfile(matlabroot, 'toolbox', 'mbc', 'mbctraining', 'gasolineOneStage.cag'));
[models, updatedItems, updatedTables] = importModels(r,proj);

Version History

Introduced in R2024b