Main Content

setUserString

Simulink.SimulationOutput オブジェクト内のメタデータに対する string の追加

ページ内をすべて折りたたむ

    構文

    simOut = setUserString(simOut,str)

    説明

    例

    simOut = setUserString(simOut,str) は、Simulink.SimulationOutput オブジェクト simOut に保存されているメタデータにテキスト str を追加します。

    この関数を使用すると、Simulink.SimulationOutput オブジェクトを生成したシミュレーションに関する説明または結果の説明を追加できます。

    例

    すべて折りたたむ

    ライブ スクリプトを開く

    Simulink.SimulationOutput オブジェクトには、シミュレーションに関する情報を取得する Simulink.SimulationMetadata オブジェクトが含まれています。シミュレーションに関する追加情報は、UserData プロパティおよび UserString プロパティで指定できます。たとえば、シミュレーションの構成に使用した Simulink.SimulationInput オブジェクトを UserData プロパティで保存し、UserString をシミュレーションの説明として指定することができます。

    モデル ex_sldemo_bounce を開きます。このモデルは、跳ねるボールの動きを初期速度に基づいてシミュレートします。

    mdl = "ex_sldemo_bounce";
open_system(mdl);

    Simulink.SimulationInput オブジェクトを作成してモデルのシミュレーションを構成します。関数 setBlockParameter を使用して、初期速度を 20 と指定します。

    simIn = Simulink.SimulationInput(mdl);
simIn = setBlockParameter(simIn,"ex_sldemo_bounce/Initial Velocity",...
    "Value","20");

    モデルをシミュレートします。

    simOut = sim(simIn);

    関数 setUserData を使用して、シミュレーション メタデータに Simulink.SimulationInput オブジェクトを追加します。

    simOut = setUserData(simOut,simIn);

    関数 setUserString を使用して、シミュレーションの説明を追加します。

    simOut = setUserString(simOut,"Initial Velocity = 20");

    シミュレーション メタデータを検査します。

    simMetadata = getSimulationMetadata(simOut)
    simMetadata = 
  SimulationMetadata with properties:

        ModelInfo: [1x1 struct]
       TimingInfo: [1x1 struct]
    ExecutionInfo: [1x1 struct]
       UserString: "Initial Velocity = 20"
         UserData: [1x1 Simulink.SimulationInput]

    入力引数

    すべて折りたたむ

    テキストの追加先のシミュレーション結果。Simulink.SimulationOutput オブジェクトとして指定します。

    メタデータに追加するテキスト。string または文字ベクトルとして指定します。

    データ型: char | string

    出力引数

    すべて折りたたむ

    テキストが追加されたシミュレーション結果。Simulink.SimulationOutput オブジェクトとして返されます。SimulationOutput オブジェクトは、シミュレーション メタデータを Simulink.SimulationMetadata オブジェクトとして保存します。指定するデータは、Simulink.SimulationMetadata オブジェクトの UserString プロパティに追加されます。

    simMetadata = simOut.SimulationMetadata;
userData = simMetadata.UserString;

    バージョン履歴

    R2015a で導入

    参考

    オブジェクト

    関数