Main Content

configset.reference.restoreAllOverriddenParameters

Restore all overridden parameters in configuration referenceof model

    Description

    example

    configset.reference.restoreAllOverriddenParameters(model) restores all parameters that are overridden in the configuration reference that is active in the model. The overridden parameters reset to the values in the referenced configuration and become read-only again.

    Examples

    collapse all

    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 ModelReferenceNumInstancesAllowed. This parameter controls the number of times that the model can be referenced directly or indirectly by another model. In the referenced configuration set, the value is Multi. For the model slexConfigSetRefExample, override the parameter and set the value to Single so that it can be referenced only once by another model.

    configset.reference.overrideParameter(model,"ModelReferenceNumInstancesAllowed","Single");

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

    configset.reference.isParameterOverridden(model,"ModelReferenceNumInstancesAllowed")
    ans = logical
       1
    
    
    get_param(model,"ModelReferenceNumInstancesAllowed")
    ans = 
    'Single'
    

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

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

    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,"Solver");
    configset.reference.getOverriddenParameters(model)
    ans = 3x1 string
        "StartTime"
        "StopTime"
        "Solver"
    
    

    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

    collapse all

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

    Example: 'vdp'

    Introduced in R2021a