Advisor.authoring.NegativeModelParameterConstraint Class

Namespace: Advisor.authoring
Superclasses:

Create a Model Advisor constraint to check for unsupported model parameter values

Description

Instances of Advisor.authoring.NegativeModelParameterConstraint class define unsupported values for specified model parameters.

Construction

constraint = Advisor.authoring.NegativeModelParameterConstraint creates an instance of this class.

Properties

ID — Unique identifier

character vector

Unique identifier for the negative model parameter constraint. This property is read/write.

ParameterName — Name of model parameter

character vector

Model parameter for which you are specifying a constraint. This property is read/write.

UnsupportedParameterValues — Unsupported model parameter values

cell array of character vectors | cell array of structs | cell array of array of character vectors

List of unsupported values for the model parameter specified by the ParameterName field. This property is read/write.

PreRequisiteConstraintIDs — IDs of prerequisite constraints

cell array of character vectors

IDs of constraints that you specify as prerequisites by using the addPreRequisiteConstraintID method. If a prerequisite is not satisfied, the Model Advisor does not check the constraint that has the prerequisite. This property is read-only.

Examples

Specify Unsupported Model Parameter Value

Specify an unsupported model parameter value by using a negative model parameter constraint.

These commands specify that the MaxType parameter does not support a value of zero:

c1=Advisor.authoring.NegativeModelParameterConstraint;
c1.ID='ID_1';
c1.ParameterName='MaxStep';
c1.UnsupportedParameterValues={'0'};

Version History

Introduced in R2018a