Main Content

setUserData

Store custom data in SimulationMetadata object that SimulationOutput object contains

Syntax

simoutNew = setUserData(simout,CustomData)
simoutNew = simout.setUserData(CustomData)

Description

simoutNew = setUserData(simout,CustomData) assigns a copy of Simulink.SimulationOutput to simoutNew. The copy contains CustomData in its SimulationMetadata object.

simoutNew = simout.setUserData(CustomData) is a syntax with dot notation to assign the modified copy of Simulink.SimulationOutput to simoutNew.

Input Arguments

expand all

Simulation output in which to modify custom data

Any custom data you want to store in the metadata object.

Output Arguments

expand all

A copy of the simout SimulationOutput object that contains CustomData in its SimulationMetadata object, returned as an object.

Examples

expand all

Simulate the vdp model. Store custom data in the SimulationMetadata object that the SimulationOutput object contains.

Simulate the vdp model. Save the results of the Simulink.SimulationOutput object in simout.

 open_system('vdp')
 simout=sim(bdroot,'ReturnWorkspaceOutputs','on');

Store custom data about the simulation in the SimulationMetadata object that simout contains.

simout=simout.setUserData(struct('param1','value1','param2','value2','param3','value3'));

Use SimulationOutput.getSimulationMetadata to retrieve the information you stored.

mData=simout.getSimulationMetadata();
disp(mData.UserData)
    param1: 'value1'
    param2: 'value2'
    param3: 'value3'