This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

setUserString

Class: Simulink.SimulationOutput
Package: Simulink

Store custom character vector in SimulationMetadata object that SimulationOutput object contains

Syntax

simoutNew = simout.setUserString(CustomString)

Description

simoutNew = simout.setUserString(CustomString) assigns a copy of the simout SimulationOutput object to simoutNew. The copy contains CustomString in its SimulationMetadata object.

Input Arguments

expand all

Simulation object to get metadata from, specified as a SimulationOutput object.

Any custom character vector you want to store in the metadata object.

Output Arguments

expand all

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

Examples

expand all

Simulate the vdp model. Store a custom character vector 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 a character vector to describe the simulation.

simout=simout.setUserString('First Simulation');

Use SimulationOutput.getSimulationMetadata to retrieve the information you stored.

mData=simout.getSimulationMetadata();
disp(mData.UserString)
First Simulation