configset.reference.getOverriddenParameters

コンフィギュレーション参照でオーバーライドされるパラメーター

R2021a 以降

構文

parameters = configset.reference.getOverriddenParameters(model)

説明

parameters = configset.reference.getOverriddenParameters(model) は、モデルでアクティブになっているコンフィギュレーション参照でオーバーライドされるパラメーターを返します。

例

コンフィギュレーション参照のパラメーターのオーバーライド

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

コンフィギュレーション参照をアクティブなコンフィギュレーションとして使用するモデル 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)

入力引数

model — コンフィギュレーション参照を使用するモデル

文字ベクトル | string スカラー

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

例: 'mymodel'

出力引数

parameters — オーバーライドされたパラメーター

string 配列

オーバーライドされたパラメーター。string 配列として返されます。

バージョン履歴

R2021a で導入

参考

configset.reference.overrideParameter | configset.reference.restoreOverriddenParameter | configset.reference.restoreAllOverriddenParameters

トピック

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