Package and Share Protected Models
When you protect a model, you can automatically create and package the following
contents in a project archive (
.mlproj) for easy sharing:
Protected model file (
Harness model file
MAT-file with base workspace definitions
Data dictionary pruned to relevant definitions
Other supporting files
In the Create Protected Model dialog box, set Contents to
Protected model (.slxp) and dependencies in a
Before sharing the project, check whether the project contains the necessary supporting files. If supporting files are missing, simulating or generating code for the related harness model can help identify them. Add the missing dependencies to the project and update the harness model as needed.
Alternatively, you can use one of these options to deliver the protected model package:
Provide the protected model file and supporting files as separate files.
Combine the files into a ZIP or other container file.
Provide the files in some other standard or proprietary format specified by the receiver.
Whichever approach you use to deliver a protected model, include information on how to retrieve the original files.
You can create a harness model when you create your protected model. The harness model contains a Model block that references the protected model. A third-party can use the Model block to reference your protected model. The harness model is set up for simulation of the protected model.
MAT-File with Base Workspace Definitions
Referenced models can use object definitions or tunable parameters that are defined in the MATLAB® base workspace. These variables are not saved with the model. When you protect a model, you must obtain the definitions of required base workspace entities and ship them with the model.
For example, if the model uses the following base workspace variables, they must be saved to a MAT-file:
Global tunable parameter
Global data store
The following objects used by a signal that connects to a root-level model Inport or Outport:
Simulink.NumericTypethat is an alias
To determine the required base workspace definitions and save them to a MAT-file, see Explore Protected Model Capabilities. Before executing the protected model as a part of a third-party model, the receiver of the protected model must load the MAT-file.
Simulink Data Dictionary
Referenced models can use data definitions from a data dictionary, which are not saved with the model. When you protect a model that uses a data dictionary, package and ship the data dictionary with the protected model.
Protected Model File Contents
A protected model file (
.slxp) consists of the derived files
that support the options that you selected when you created the protected model. The
derived files are unpacked when you or a third-party use the protected model in
simulation. You do not need to package these derived files with the protected
If you created a protected model for simulation only and the referencing model is
Normal mode, after simulation, the
file is placed in the build folder. The derived files that are unpacked depends on
the support that you enabled when creating the protected model.
Protected Model Derived Files
|Supported Functionality||Derived Files|
|Created a protected model for simulation only and the referencing
model is in ||The
|Created protected model for simulation only and referencing model
is in |
In addition to the preceding files in the build folder,
these files are unpacked in the
For the protected model report, these additional files are unpacked (but not in the build folder):
|Created protected model with code generation support.|
These files are unpacked in the
|Specified a |
These files are unpacked in the
For the protected model report, after building your model these files are unpacked (in addition to the preceding files):
|Created protected model with HDL code generation support (requires HDL Coder™ license).|
The files are unpacked in the
files are deleted after they are used.