export

Export run to base workspace or file

collapse all in page

Syntax

ds = export(runObj)
export(runObj,Name,Value)

Description

ds = export(runObj) exports the Simulink.sdi.Run object runObj to the base workspace as the Simulink.SimulationData.Dataset object ds.

example

export(runObj,Name,Value) exports the Simulink.sdi.Run object runObj to the base workspace or a file according to the options specified by one or more name-value pair arguments.

Examples

collapse all

Open Live Script

You can export data from a run in the Simulation Data Inspector to a Simulink.SimulationData.Dataset object in the base workspace that you can use to further process your data. The method you choose to export your run depends on the processing you do in your script. If you have a run object for the run, you can use the export method to create a Simulink.SimulationData.Dataset object with the run data in the base workspace. If you do not have a run object, use the Simulink.sdi.exportRun function to export the run to the workspace.

Export Run Using Simulink.sdi.exportRun

Use the Simulink.sdi.export function to export run data to the workspace or a file when your workflow does not include creating a run object.

To create a run of simulation data, open the vdp model, mark signals for logging, and run a simulation.

mdl = "vdp";
load_system(mdl);

SignalHandles = get_param(mdl,"Lines");

Simulink.sdi.markSignalForStreaming(SignalHandles(5).Handle,"on")
Simulink.sdi.markSignalForStreaming(SignalHandles(6).Handle,"on")

out = sim(mdl);

Use the Simulink.sdi.getAllRunIDs function to access the most recently created run.

runIDs = Simulink.sdi.getAllRunIDs;
runID = runIDs(end);

Use the Simulink.sdi.exportRun function to export the run data to a Dataset object in the workspace.

simDataset = Simulink.sdi.exportRun(runID);

Export Run Using the export Function

When your task involves creating a Run object, you can use the export function to create a Simulink.SimulationData.Dataset object in the base workspace to further process the run data. For example, suppose you need to access Run objects for simulation runs with signal data you want to compare using the Simulink.sdi.compareSignals function.

Load a model and mark signals for logging. Then simulate the model to create run data.

load_system(mdl)

SignalHandles = get_param(mdl,"Lines");

Simulink.sdi.markSignalForStreaming(SignalHandles(5).Handle,"on")
Simulink.sdi.markSignalForStreaming(SignalHandles(6).Handle,"on")

sim(mdl);

Use the Simulink.sdi.getAllRunIDs function to access the run ID for the most recently created run. Then, use the Simulink.sdi.getRun function to access the Run object corresponding to the run.

runIDs = Simulink.sdi.getAllRunIDs;
runID = runIDs(end);
vdpRun = Simulink.sdi.getRun(runID);

Use the export function to export the run data to a Dataset object in the workspace.

simDataset = export(vdpRun);

Input Arguments

collapse all

Run with data to export, specified as a Simulink.sdi.Run object.

Name-Value Arguments

collapse all

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: 'to','file'

Where to export data, specified as the comma-separated pair consisting of 'to' and 'variable' or 'file'.

When you export data to a file, you must also specify a file name using the 'filename' name-value pair argument. You can specify a file name with a .mat, .mldatx, or .xlsx extension.

When you export a run to a MAT file, the data is saved in a Simulink.SimulationData.Dataset object. When you export more than one run to a MAT file using the Simulink.sdi.exportRun function, the data is saved in a Dataset object, where each element is a Dataset object that contains the data for one exported run.

Data exported to a Microsoft® Excel® file is saved using the format described in Microsoft Excel Import, Export, and Logging Format.

When you export data to a Microsoft Excel file, you can specify additional options using the 'overwrite', 'metadata', and 'sharetimecolumn' name-value pairs.

Example: 'to','file'

Name of the file to contain the exported data, specified as the comma-separated pair consisting of 'filename' and a string or character array. Include a .mat, .mldatx, or .xlsx extension in the file name to specify whether to export the data to a MAT file, MLDATX file, or a Microsoft Excel file. When you do not specify an extension with a file name, the data exports to a MAT file.

Use the 'filename' name-value pair argument when you specify the 'to' name-value pair argument with the value 'file'.

When you export data to a Microsoft Excel file, you can specify additional options using the 'overwrite', 'metadata', and 'sharetimecolumn' name-value pair arguments.

Example: 'filename',"mySpreadsheet.xlsx"

Data to overwrite in existing Microsoft Excel file, specified as the comma-separated pair consisting of 'overwrite' and 'file' or 'sheetsonly'.

  • 'file' — Overwrite the entire file with the exported data.

  • 'sheetsonly' — Only overwrite sheets of the Microsoft Excel file with data that corresponds to the exported data.

When you export data to an existing MAT file or MLDATX file, the exported data overwrites the entire file.

Example: 'overwrite','sheetsonly'

Metadata to include in the exported Microsoft Excel file, specified as the comma-separated pair consisting of 'metadata' and a string array. By default, the export operation does not include any metadata. You can export this metadata to the Microsoft Excel file:

  • dataType — Signal data type

  • units — Signal units

  • blockPath — Path to the source block for logged signals

  • interp — Signal interpolation method

  • portIndex — Index of the port on the source block for logged signals

You can specify the desired metadata in any order you choose in the string array. The order of the metadata in the string array does not affect the format in the exported file, which always matches the description in Microsoft Excel Import, Export, and Logging Format.

Example: 'metadata',["units","dataType"]

Whether signals that have identical time data share time columns in the exported Microsoft Excel file, specified as the comma-separated pair consisting of 'sharetimecolumn' and 'on' or 'off'. By default, signals with the same time data share a time column in the exported file. When you specify the value as 'off', each signal in the exported file has its own time column.

Example: 'sharetimecolumn','off'

Output Arguments

collapse all

Exported run data, returned as a Simulink.SimulationData.Dataset object.

Do not return an output argument when you export data to a file.

Alternatives

You can export data programmatically for one or more runs using the Simulink.sdi.exportRun function, or you can use the Simulation Data Inspector UI. For more information, see Save and Share Simulation Data Inspector Data and Views.

Version History

Introduced in R2017b

See Also

| | |

Topics