dependencies.fileDependencyAnalysis

Find model file dependencies

Syntax

files = dependencies.fileDependencyAnalysis("modelname")

[files,missing] = dependencies.fileDependencyAnalysis("modelname")

[files,missing,depfile] = dependencies.fileDependencyAnalysis("modelname")

[files,missing,depfile,manifestfile] = dependencies.fileDependencyAnalysis("modelname",ManifestFile=manifestFileName)

[___] = dependencies.fileDependencyAnalysis("modelname",Name=Value)

Description

files = dependencies.fileDependencyAnalysis("modelname") returns the full paths of all existing files referenced by the model modelname.

[files,missing] = dependencies.fileDependencyAnalysis("modelname") also returns missing, any referenced files that cannot be found.

[files,missing,depfile] = dependencies.fileDependencyAnalysis("modelname") also returns the full path of the user dependencies (.smd), if it exists, that stores the names of any files the user manually added or excluded.

[files,missing,depfile,manifestfile] = dependencies.fileDependencyAnalysis("modelname",ManifestFile=manifestFileName) also creates a manifest file specified in ManifestFile.

[___] = dependencies.fileDependencyAnalysis("modelname",Name=Value) specifies additional options as one or more name-value arguments.

Examples

Find Model File Dependencies

Open the project that contains the sldemo_mdlref_depraph model.

openProject('ModelReferenceHierarchy');

Programmatically find all the file dependencies of the sldemo_mdlref_depgraph model.

files = dependencies.fileDependencyAnalysis('sldemo_mdlref_depgraph')

files = 8×1 cell
    {'/tmp/Bdoc25b_2988451_1129109/tp1e5c1fee/simulink-ex05898741/ModelReferenceHierarchy/sldemo_mdlref_F2C.slx'         }
    {'/tmp/Bdoc25b_2988451_1129109/tp1e5c1fee/simulink-ex05898741/ModelReferenceHierarchy/sldemo_mdlref_depgraph.slx'    }
    {'/tmp/Bdoc25b_2988451_1129109/tp1e5c1fee/simulink-ex05898741/ModelReferenceHierarchy/sldemo_mdlref_heat2cost.slx'   }
    {'/tmp/Bdoc25b_2988451_1129109/tp1e5c1fee/simulink-ex05898741/ModelReferenceHierarchy/sldemo_mdlref_heater.slx'      }
    {'/tmp/Bdoc25b_2988451_1129109/tp1e5c1fee/simulink-ex05898741/ModelReferenceHierarchy/sldemo_mdlref_house.slx'       }
    {'/tmp/Bdoc25b_2988451_1129109/tp1e5c1fee/simulink-ex05898741/ModelReferenceHierarchy/sldemo_mdlref_outdoor_temp.slx'}
    {'/tmp/Bdoc25b_2988451_1129109/tp1e5c1fee/simulink-ex05898741/ModelReferenceHierarchy/sldemo_mdlref_thermostat.slx'  }
    {'/tmp/Bdoc25b_2988451_1129109/tp1e5c1fee/simulink-ex05898741/ModelReferenceHierarchy/thermdat.m'                    }

Input Arguments

modelname — Model, library, or subsystem name or path

character vector | string

Full name or path of a model, library, or subsystem to analyze, specified as a character vector or string.

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.

Example: dependencies.fileDependencyAnalysis("mymodel.slx",ManifestFile="manifestFileName",AnalyzeUnsavedModels=true)

ManifestFile — Manifest file name or path

character vector | string

Full name or path of the manifest file to create, specified as a character vector or string. The function adds the suffix .smf to the user-specified name.

Data Types: char | string

AnalyzeUnsavedModels — Option to analyze files without unsaved changes

false or 0 (default) | true or 1

Option to enable analyzing files that have unsaved changes, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

AnalyzeToolboxFiles — Option to analyze files inside of toolbox

true or 1 (default) | false or 0

Option to enable analyzing files inside of toolboxes, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

Output Arguments

files — Full paths of referenced files

character vector | cell array of character vectors

Full paths of all existing files referenced by the model or library modelname, returned as a character vector or a cell array of character vectors.

missing — Full paths of missing files

character vector | cell array of character vectors

Full paths of files referenced by the model or library modelname that cannot be found, returned as a character vector or a cell array of character vectors.

depfile — Full path of user dependencies file

character vector

Full path of user dependencies (.smd) file, if it exists, that stores the names of any files the user manually added or excluded, returned as a character vector.

manifestfile — Full path of created manifest file

character vector

Full path of new manifest (.smf) file, returned as a character vector.

Tips

• Interactively generate a dependency graph and a report summarizing the list of required files and products. For more details, see Analyze Model Dependencies.

• If your model is in a project, use listRequiredFiles instead.

• To programmatically check which add-ons are required, use dependencies.toolboxDependencyAnalysis instead.

Version History

Introduced in R2012a

R2024a: dependencies.fileDependencyAnalysis(modelname,manifestfile) syntax will be removed

The dependencies.fileDependencyAnalysis(modelname,manifestfile) syntax will be removed in a future release. Use the dependencies.fileDependencyAnalysis(modelname, ManifestFile="manifestFileName") syntax instead. In R2024a, scripts using dependencies.fileDependencyAnalysis(modelname,manifestfile) warn.

Note

Starting in R2020b, you can only generate the manifest file programmatically. You can open manifest files created prior to R2020b using the Dependency Analyzer. To interactively generate a dependency graph and report, perform a dependency analysis. For more details, see Analyze Model Dependencies.

R2020b: Output arguments manifestfile and depfile will be removed

Output arguments manifestfile and depfile will be removed in a future release.

Starting in R2020b, you can only generate the manifest file programmatically. You can open manifest files created prior to R2020b using the Dependency Analyzer. To interactively generate a dependency graph and report, perform a dependency analysis. For more details, see Analyze Model Dependencies.

Starting in R2020b, you can no longer generate a user dependencies file (.smd file). The function only returns a .smd file if it already exists. To manually add or exclude dependencies, create a project from your model. For more details, see Create Project from Model and Manage Project Files.