publishActor

Generate package for actor simulation

Since R2022a

Syntax

Simulink.publish.publishActor(actorBehavior,Name,Value)

Simulink.publish.publishActor(modelName,Name,Value)

Description

Simulink.publish.publishActor(actorBehavior,Name,Value) generates a package from the actor behavior specified by actorBehavior for actor simulation with additional options specified using one or more name-value arguments.

Simulink.publish.publishActor(modelName,Name,Value) generates a package from the model name specified by modelName for actor simulation with additional options specified using one or more name-value arguments.

Examples

Generate Package for Actor Simulation

Publish the model actor behavior as a package to use in actor simulation.

Simulink.publish.publishActor("mSimple",PackageType="Normal",...
SetupScript="setup.m",OutputFile="output.zip")

Input Arguments

actorBehavior — Actor behavior

character vector | string

Actor behavior for MATLAB^® System object™, specified as a character vector or string.

Example: "MySystemObjectBehavior.m"

Data Types: char | string

modelName — Simulink model name

character vector | string

Simulink^® model name, specified as a character vector or string.

Example: "mSimple"

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.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: Simulink.publish.publishActor("mSimple",PackageType="Normal",SetupScript="setup.m",OutputFile="output.zip")

PackageType — Relation target mode

"Normal" (default) | "ReadyToRun"

Relation target mode the actor will use, specified as a relationTarget value "Normal" or "ReadyToRun".

Data Types: string

SetupScript — Setup script file

string

Setup script file to include in package, specified as a string of the file name.

Data Types: string

CleanupScript — Cleanup script file

string

Cleanup script file to include in package, specified as a string of the file name.

Data Types: string

OutputFile — Output file

string

Output file for package, specified as a string of the full file path with the ZIP extension.

Data Types: string

DataFiles — Data files

array of strings

Data files to attach, specified as an array of strings of data file names.

Data Types: string

Version History

Introduced in R2022a

R2024a: Improve RoadRunner simulation performance using ready-to-run packages for Simulink actor behaviors

Starting from R2024a, you can generate ready-to-run packages for your Simulink models that include RoadRunner scenario blocks and MATLAB System blocks containing RoadRunner simulation APIs to significantly improve simulation performance.

To create a ready-to-run package, use the Simulink.publish.publishActor function with PackageType property set to ReadyToRun.

Simulink.publish.publishActor('myActorBehaviorModel', PackageType='ReadyToRun');