configset.reference.overrideParameter

Change value of parameter in configuration reference

Since R2021a

Syntax

configset.reference.overrideParameter(model,parameter)

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

Description

configset.reference.overrideParameter(model,parameter) overrides the parameter parameter in the active configuration reference that model uses. By default, a configuration reference uses the parameter values from the configuration set that it references and does not enable editing. Overriding a parameter enables editing in the configuration reference so that you can change the value for the parameter in the reference without changing the referenced configuration set. Changing the value in the referenced configuration set does not affect the value of the overridden parameter. Some parameters cannot be overridden.

configset.reference.overrideParameter(model,parameter,value) overrides the parameter and sets the value in the configuration reference to value.

Examples

Override Parameters in a Configuration Reference

Programmatically override a parameter in a configuration reference and set a value that is different from the referenced configuration set.

Open the model slexConfigSetRefExample, which uses a configuration reference as the active configuration.

model = 'slexConfigSetRefExample';
open(model)

Check if the model has any overridden parameters.

configset.reference.hasOverriddenParameters(model)

ans = logical
   0

The model does not have any overridden parameters. For this example, override the parameter ModelReferenceMinAlgLoopOccurrences. This parameter attempts to eliminate artificial algebraic loops involving references to this model. In the referenced configuration set, the parameter is disabled. For the model slexConfigSetRefExample, enable the parameter by overriding it.

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

Verify that the parameter ModelReferenceMinAlgLoopOccurrences is overridden and check its value for the model.

configset.reference.isParameterOverridden(model,"ModelReferenceMinAlgLoopOccurrences")

ans = logical
   1

get_param(model,"ModelReferenceMinAlgLoopOccurrences")

ans = 
'on'

Restore the parameter to the value in the referenced configuration set. Restoring the parameter makes it read-only again.

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

If multiple parameters are overridden for the model, you can interact with all of them at once. For example, override the parameters StartTime, StopTime, and SolverType. Then, use the function configset.reference.getOverriddenParameters to see a list of the overridden parameters.

configset.reference.overrideParameter(model,"StartTime");
configset.reference.overrideParameter(model,"StopTime");
configset.reference.overrideParameter(model,"SolverName");
configset.reference.getOverriddenParameters(model)

ans = 3x1 string
    "StartTime"
    "StopTime"
    "SolverName"

Now, restore all of the overridden parameters for the model. The parameters reset to the values in the referenced configuration set and become read-only again.

configset.reference.restoreAllOverriddenParameters(model)

Input Arguments

model — Model that uses configuration reference

character vector | string scalar

Model that uses the configuration reference, specified as a character vector or string scalar.

Example: 'mymodel'

parameter — Parameter to override

character vector | string scalar

Parameter to override, specified as a character vector or string scalar.

Example: 'ModelReferenceNumInstancesAllowed'

value — Value to set

character vector | string scalar

Value to set for the overridden parameter, specified as a character vector or string scalar.

Example: 'Multi'

Version History

Introduced in R2021a