Check if tunable block parameters are defined as named constants

Check ID: mathworks.jmaab.jc_0645

Guideline: jc_0645: Parameter definition for calibration

• MAB v6.0

• JMAAB v5.1

• JMAAB v6.0

Description

Checks if tunable block parameters are defined as named constants.

Block parameters that are targets of calibration must be defined as named constants. These parameters are the exception:

• Initial value when set to 0

• Increment, decrement value when set to 1

• Arithmetic expressions

Note

Literals are used for array indexing.

This table lists the Simulink^® blocks and respective parameters supported:

Blocks	Supported Parameters
Backlash	BacklashWidth,InitialOutput
Bias	Bias
Combinatorial Logic	TruthTable
Constant	Value
Dead Zone	LowerValue,UpperValue
Derivative	CoefficientInTFapproximation
Discrete-Time Integrator	gainval,InitialCondition,UpperSaturationLimit,LowerSaturationLimit
Gain	Gain
Hit Crossing	HitCrossingOffset
Initial Condition (IC)	Value
Integrator	InitialCondition,UpperSaturationLimit,LowerSaturationLimit,AbsoluteTolerance
n-D Lookup Table
Magnitude-Angle to Complex	ConstantPart
Memory	InitialCondition
Permute Dimensions	Order
Quantizer	QuantizationInterval
Rate Limiter	RisingSlewLimit,FallingSlewLimit,InitialCondition
Rate Transition	InitialCondition
Real-Imag to Complex	ConstantPart
Relay	OnSwitchValue,OffSwitchValue,OnOutputValue,OffOutputValue
Saturation	UpperLimit,LowerLimit
Sine	Amplitude,Bias,Frequency,Phase,Samples,Offset
State-Space	A,B,C,D,X0,AbsoluteTolerance
Switch	Threshold
Transport Delay	DelayTime,InitialOutput,BufferSize,PadeOrder
Unit Delay	InitialCondition

This check requires a Simulink Check™ license.

Check Parameterization

This check does not include sub-checks because the MAB modeling guideline provides only one sub ID.

For reference, the MAB guideline sub ID(s) that are recommended for use by the NA-MAAB and JMAAB modeling standards organizations are:

• NA-MAAB — No recommendations

• JMAAB — a

1. Open the Model Configuration Editor and search for check ID mathworks.jmaab.jc_0645.

2. Use the Allowed calibration values to define which values are acceptable for calibration variables in the model.

3. Use the Get Tunable Block Parameters corresponding to the Block Type table to add or delete block types and/or mask types that require calibration.

4. Click Apply and save the configuration.

Results and Recommended Actions

Condition	Recommended Action
Improper usage of tunable block parameter values.	Change the tunable block parameter literal values to named constants.

Capabilities and Limitations

• Runs on library models.

• Analyzes content in masked subsystems. By default, the input parameter Look under masks is set to graphical.

• Analyzes content of library-linked blocks. By default, the input parameter Follow links is set to on.

• Allows exclusions of blocks and charts.

Edit-Time Checking

This check is supported by edit-time checking.