configset.reference.overrideParameter

コンフィギュレーション参照のパラメーター値の変更

R2021a 以降

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

    構文

    configset.reference.overrideParameter(model,parameter)
    configset.reference.overrideParameter(model,parameter,value)

    説明

    configset.reference.overrideParameter(model,parameter) は、model が使用するアクティブなコンフィギュレーション参照でパラメーター parameter をオーバーライドします。既定では、コンフィギュレーション参照は、参照するコンフィギュレーション セットからのパラメーター値を使用し、編集を有効にしません。パラメーターをオーバーライドするとコンフィギュレーション参照で編集が有効になるため、参照コンフィギュレーション セットを変更せずに参照でパラメーターの値を変更できます。参照コンフィギュレーション セットの値を変更しても、オーバーライドされたパラメーターの値に影響しません。一部のパラメーターはオーバーライドできません。

    例

    configset.reference.overrideParameter(model,parameter,value) はパラメーターをオーバーライドし、コンフィギュレーション参照の値を value に設定します。

    例

    すべて折りたたむ

    ライブ スクリプトを開く

    コンフィギュレーション参照のパラメーターをプログラムでオーバーライドし、参照コンフィギュレーション セットとは異なる値を設定します。

    コンフィギュレーション参照をアクティブなコンフィギュレーションとして使用するモデル slexConfigSetRefExample を開きます。

    model = 'slexConfigSetRefExample';
open(model)

    モデルにオーバーライドされたパラメーターが含まれているかどうかチェックします。

    configset.reference.hasOverriddenParameters(model)
    ans = logical
   0

    モデルにオーバーライドされたパラメーターは含まれていません。この例では、パラメーター ModelReferenceMinAlgLoopOccurrences をオーバーライドします。このパラメーターで、このモデルへの参照を含む疑似代数ループの削除を試みます。参照コンフィギュレーション セットでは、このパラメーターは無効になっています。モデル slexConfigSetRefExample で、このパラメーターをオーバーライドして有効にします。

    configset.reference.overrideParameter(model,ModelReferenceMinAlgLoopOccurrences="on");

    パラメーター ModelReferenceMinAlgLoopOccurrences がオーバーライドされることを検証し、モデルの値をチェックします。

    configset.reference.isParameterOverridden(model,"ModelReferenceMinAlgLoopOccurrences")
    ans = logical
   1


    get_param(model,"ModelReferenceMinAlgLoopOccurrences")
    ans = 
'on'

    パラメーターを参照コンフィギュレーション セットの値に復元します。パラメーターを復元すると、再度読み取り専用になります。

    configset.reference.restoreOverriddenParameter(model,"ModelReferenceMinAlgLoopOccurrences");

    モデルの複数のパラメーターがオーバーライドされる場合、それらすべてを一度に操作できます。たとえば、パラメーター StartTime、StopTime、SolverType をオーバーライドします。次に、関数 configset.reference.getOverriddenParameters を使用して、オーバーライドされたパラメーターのリストを表示します。

    configset.reference.overrideParameter(model,"StartTime");
configset.reference.overrideParameter(model,"StopTime");
configset.reference.overrideParameter(model,"SolverName");
configset.reference.getOverriddenParameters(model)
    ans = 3×1 string
    "StartTime"
    "StopTime"
    "SolverName"

    今度は、モデルのオーバーライドされたパラメーターをすべて復元します。パラメーターは参照コンフィギュレーション セットの値にリセットされ、再度読み取り専用になります。

    configset.reference.restoreAllOverriddenParameters(model)

    入力引数

    すべて折りたたむ

    コンフィギュレーション参照を使用するモデル。文字ベクトルまたは string スカラーとして指定します。

    例: 'mymodel'

    オーバーライドするパラメーター。文字ベクトルまたは string スカラーとして指定します。

    例: 'ModelReferenceNumInstancesAllowed'

    オーバーライドされたパラメーターに設定する値。文字ベクトルまたは string スカラーとして指定します。

    例: 'Multi'

    バージョン履歴

    R2021a で導入

    参考

    |

    トピック