|
Reactis API V2021.2
Shared by all Bindings: Model-Specific and Harness-Library-Specific Parameters
Introduction | Parameters edited with Reactis Info File Editor and stored in .rsi file or
edited with the Reactis for C Harness Editor and stored in .rsh file. |
General | Parameters set using the General pane of the Reactis Info File Editor. |
Error Checking | Parameters set in the Error Checking pane of the Info File
Editor. |
Coverage Metrics | Parameters set in the Coverage Metrics pane of the Info File Editor. |
C Code | Parameters set in the C Code pane of the Info File Editor. |
Callbacks | Parameters set in the Callbacks pane of the Info File Editor. |
Search Path | Parameters set in the Search Path pane of the Info File Editor. |
Introduction
Parameters edited with Reactis Info File Editor and stored in .rsi file or
edited with the Reactis for C Harness Editor and stored in .rsh file.
Most parameters described here are available in both the Reactis and Reactis
for C APIs; however, some are available in only one of the APIs.
The availability specification in parentheses under the parameter name
indicates which version(s) of the API the parameter is available in:
- R means available in the Reactis API.
- R4C means available in the Reactis for C API.
Reactis API
Parameters listed here can be used for the rsGetParameterValue ,
rsSetParameterValue , rsRsiGetParameterValue and
rsRsiSetParameterValue functions.
When used with rsRsiGetParameterValue or
rsRsiSetParameterValue they specify the settings in the given .rsi
file.
When used with rsGetParameterValue or rsSetParameterValue
they specify the default model-specific setting which will be applied when
a new .rsi file is created. Also, if a new version of Reactis introduces a
new parameter, then when upgrading an .rsi file created with a prior
version of Reactis, the value for the new parameter will be the
model-specific default.
Each parameter described here can also be manipulated from the Reactis
Info File Editor or the Default Model-Specific Settings dialog available in
the Reactis GUI. The parameter names and allowed values are described
below. The parameters are listed below in groups corresponding to the
different panes of the Info File Editor.
For parameters of type boolean, allowed values are 0, false, 1
or true.
Reactis for C API
Parameters listed here can be used for the rcRshGetParameterValue,
rcRshSetParameterValue, rcGetParameterValue, and rcSetParameterValue
functions.
When used with rcRshGetParameterValue or rcRshSetParameterValue they
specify the settings in the harness library within given .rsh file.
When used with rcGetParameterValue or rcSetParameterValue they specify
the default harness-library-specific setting which will be applied when a
new harness library is created. Also, if a new version of Reactis for C
introduces a new parameter, then when upgrading a harness created with a
prior version of Reactis for C, the value for the new parameter will be the
harness-library-specific default.
Each parameter described here can also be manipulated from the Reactis
Info File Editor or the Default Model-Specific Settings dialog available in
the Reactis GUI. The parameter names and allowed values are described
below. The parameters are listed below in groups corresponding to the
different panes of the Info File Editor.
For parameters of type boolean, allowed values are 0, false, 1
or true.
General
Parameters set using the General pane of the Reactis Info File Editor.
For a more detailed description of the functionality being controlled by
the General parameters, see the
Chapter 5 of the Reactis User's Guide
Parameter Name (Availability) | Allowed Values | Description |
ConditionalInputExecution (R) |
'off', 'on', 'inherit' |
Enable/disable conditional input branch execution. When set to
'inherit' Reactis will use the setting given in the model.
|
InferBusElementNames (R) |
'none', 'all' |
Enable/disable a host of features introduced in V2012 to offer more
user-friendly interactions with bus data types. |
DoMWICaching (R) |
boolean |
Create and use cache files (files with extension .mwi) to greatly
decrease start up time for Simulator and Tester if no changes to
a model occur and the cache file can be used.
|
DoMWIBinaryCaching (R) |
boolean |
Create and use binary cache files (files with extension .mwib).
For large models this can significantly improve Simulator startup
time over regular (.mwi only) caching. 'DoMWICaching' must also
be enabled for this parameter to take effect.
|
CreateTesterParameterFiles (R) |
boolean |
When creating a test suite, also create a parameters file (extension ’.rtp’).
|
UpdateModelInSimulink (R) |
boolean |
Enable/disable whether Reactis will cause Simulink to apply all the
changes to the model made during initialization (e.g. set_param,
add_block ,etc. ), then automatically save them to a temporary file,
before importing the temporary version of the model (with changes
applied).
|
UseNewFixedStepComputation (R) |
boolean |
Enable/disable fixed-step sample time computation introduced in
V2010 to reduce rounding errors for sample times that have poor
floating point representations such as 0.1, 0.01 or similar.
|
IgnoreToWorkspaceBlocks (R) |
boolean |
Ignore ToFile and ToWorkspace blocks.
|
ShortCircuitSLLogicBlocks (R) |
boolean |
Short-circuit Simulink boolean operators.
|
ShortCircuitSFExpressions (R) |
boolean |
Short-circuit Stateflow boolean operators.
|
PrependReactisPathToMatlabPath (R) |
boolean |
Before loading a model in MATLAB, prepend Reactis’ search
path to MATLAB’s search path.
|
ExecuteMatlabStartupScripts (R) |
boolean |
Execute startup.m and pathdef.m scripts in model folder.
|
RemoveUnusedMatlabWorkspaceVars (R) |
boolean |
If enabled, Reactis will instruct MATLAB to delete any unused workspace
variables after loading a model during import. This can significantly speed
up import times for models that use a generic workspace setup from which
only a few variables are actually used. However, in some cases MATLAB may
remove variables that are actually used by the model which can lead to
errors about undefined variables during import.
|
InheritParentRsiParameters (R) |
boolean |
If this option is enabled and the current model is referenced by another
model, the referenced model will inherit import-related parameters such
as Reactis callback functions and search path from the parent model.
|
Error Checking
Parameters set in the Error Checking pane of the Info File
Editor.
For a more detailed description of the functionality being controlled by
the Error Checking parameters, see the
Chapter 5 of the Reactis User's Guide
Parameter Name (Availability) | Allowed Values | Description |
OnInputOutOfRange (R) |
'none', 'warning', 'error' |
This setting specifies what happens if an input value violates the
constraint given for the input. For example, if a range constraint is
given, what happens when a value outside the range is encountered.
|
OnConfigOutOfRange (R) |
'none', 'warning', 'error' |
This setting specifies what happens if an configuration variable
value violates the constraint given for the variable. For example, if a
range constraint is given, what happens when a value outside the range is
encountered.
|
DeltaExceedsTypeRange (R, R4C) |
'none', 'warning', 'error' |
When specifying a delta input constraint, the allowed maximum
change should not exceed the range for the input. This setting
lets you configure how Reactis responds if you specify a maximum
allowed change that is greater than the range of an input.
For example, consider delta constraint:
double [min,max] delta [dmin,dmax]
a delta constraint size error occurs if dmin < −range or
dmax > range where range = max − min. This setting
lets you configure how Reactis responds to such errors. When starting
Simulator or Tester with an .rsi file containing an delta constraint
size error, Reactis will do the following according to this setting:
- 'none' means clip the delta constraint so it is not too big and
produce no warning or error.
- 'warning' means clip the delta constraint and produce a warning.
- 'error' produce an error and stop test generation or simulation.
| Tolerance (R, R4C) |
rtol |
rel,rtol |
abs,atol |
min,rtol,atol |
max,rtol,atol
where
rtol (relative tolerance) and
atol (absolute tolerance) are doubles
|
When running a test suite in Reactis Simulator, the values of
outputs and test points computed by the model are compared to those
stored in the test suite. A warning is produced if the
difference exceeds the tolerance given by this parameter.
Example Tolerance Values
0.01 | Relative tolerance of 0.01 (i.e. 1% difference triggers warning) |
rel,0.01 | Same as above |
abs,0.01 |
Absolute tolerance of 0.01 (i.e. difference > 0.01 triggers warning) |
min,0.01,0.02 | Difference flagged if either relative tolerance of 0.1 is exceeded
or absolute tolerance of 0.2 is exceeded. |
max,0.01,0.02 | Difference flagged if both relative tolerance of 0.1 is exceeded
and absolute tolerance of 0.2 is exceeded. |
| OnIntegerOverflow (R) |
'none', 'warning', 'error', 'inherit' |
Set integer overflow behavior. When set to ’inherit’ Reactis will
use the setting given in the model.
|
OnIntegerSaturation (R) |
'none', 'warning', 'error', 'inherit' |
Set integer saturation behavior. When set to ’inherit’ Reactis will
use the setting given in the model.
|
OnDetectInfNan (R, R4C) |
'none', 'warning', 'error', 'inherit' |
Configure how Reactis responds to Inf and NaN values. When set to
'inherit' Reactis will use the setting given in the model.
|
OnDetectInfNanConversion (R) |
'none', 'error', 'inherit' |
Configure how Reactis responds to conversion of an Inf or NaN value
to an integer.
|
OnShiftOutOfRange (R) |
'none', 'error', 'inherit' |
Configure how Reactis responds to a shift operation larger than the
word size of the model.
|
OnCompareIncompatibleEnums (r) |
'none', 'warning', 'error' |
This setting specifies what should happen if a model compares an
enumerated value against a value of a different enumerated type.
|
StateflowOutportMerge (R) |
'none', 'error', 'warning' |
What to do when detecting a Stateflow outport merge.
|
OnEventBroadcast (R) |
'none', 'error', 'warning' |
What to do when detecting an undirected local event broadcast in Stateflow.
|
OnMultipleEdgeEventTrigger (R) |
'none', 'error', 'warning' |
What to do when detecting multiple trigger event outputs.
|
StateflowLoopDetectionTimeout (R) |
double |
Maximum time for Reactis to compute a simulation step. If the
computation of a simulation step takes longer, Reactis assumes there is
an infinite loop; the simulation is then terminated and an error
message printed.
|
OnCIntegerOverflow (R, R4C) |
'none', 'warning', 'error' |
Set the behavior of the C-Plugin when overflow occurs during
a signed integer computation.
|
OnCUnsignedIntegerOverflow (R, R4C) |
'none', 'error' |
Set the behavior of the C-Plugin when overflow occurs during
an unsigned integer computation. |
OnCIntegerConversionOverflow (R, R4C) |
'none', 'error', 'inherit' |
Set the behavior of the C-Plugin when an overflow occurs while
converting an unsigned integer to a signed integer.
|
OnCFloatToUIntConversionOverflow (R, R4C) |
'none', 'error', 'inherit' |
Set the behavior of the C-Plugin when an overflow occurs
while converting a floating-point value to an (signed or unsigned) integer.
|
OnCDetectInfNan (R, R4C) |
'none', 'warning', 'error', 'inherit' |
Configure how the C-Plugin responds of NaN/Inf values. When set to
inherit, the C-Plugin uses the value of OnDetectInfNan.
|
OnCEmptyStruct (R, R4C) |
'none', 'warning', 'error' |
Configure how the C-Plugin responds to empty structures and unions.
|
OnCUndefinedFunctionCall (R, R4C) |
'none', 'error' |
Configure how the C-Plugin responds to calls to undefined functions.
|
OnCInvalidPointer (R, R4C) |
'none', 'warning', 'error' |
Set what happens when a pointer expression yields an invalid address.
|
CLoopDetectionTimeout (R, R4C) |
double |
Maximum time for the C-Plugin to complete a call to an S-function
or custom code function. If the computation takes longer, Reactis
assumes there is an infinite loop; the simulation is then terminated
and an error message printed. A value of zero disables the timeout.
|
OnTrigonometryInputOverflow (R, R4C) |
'nan', 'saturate', 'tracksaturate', 'inherit' |
Controls the output of the Simulink Trigonometry block's 'asin' or 'acos'
functions when the input is outside their domain (i.e. less than -1.0 or greater than 1.0).
If set to 'nan', the function will output 'nan'.
If set to 'saturate', the input value will be saturated at -1.0 or 1.0 respectively.
If set to 'tracksaturate', the input value will be saturated and
a coverage target will track whether saturation has occurred or not.
If set to 'inherit' then the behavior will be determined by the
Trigonometry block's 'Remove Protection for out-of-range input' setting.
|
Coverage Metrics
Parameters set in the Coverage Metrics pane of the Info File Editor.
Each coverage metric tracked by Reactis can be turned on and off with
the rsRsiSetCoverageEnabled API function. Several of the metrics (CSEPT,
MC/DC, and Boundary) also have additional settings that can be manipulated
using the parameter access functions: rsGetParameterValue,
rsSetParameterValue, rsRsiGetParameterValue and rsRsiSetParameterValue.
The names of these parameters and their allowed values are described below.
Parameter Name (Availability) | Allowed Values | Description |
CoverageCSEPTUseAncestors (R) |
boolean |
For a Stateflow state S, configure whether CSEPT
defines PairStates(S) using all ancestors
or just the parent of S. See the
CSEPT section of the Reactis User's Guide for details.
|
CoverageCSEPTUsePaths (R) |
boolean |
Configure how CSEPT constructs ExitTrans(S′):
- true use full transitions(sequences of segments).
- false use only the first segment of each transition.
See the
CSEPT section of the Reactis User's Guide for details.
|
CoverageMCDCCombineLogicOp (R) |
boolean |
Enable/disable Multi-Block MC/DC.
See the
MC/DC section of the Reactis User's Guide for details.
|
CoverageMCCMaxNumConditions (R, R4C) |
string containing positive integer |
Set the maximum number of conditions that can be in a decision for which
MCC coverage is tracked. If a decision has more conditions than the limit
then MCC will not be tracked for that decision. |
CoverageBoundary (R, R4C) |
boolean |
Enable/Disable Boundary coverage |
CoverageBoundaryInputs (R) |
boolean |
Include boundary targets for top-level inputs in Boundary coverage |
CoverageBoundaryConfigs (R) |
boolean |
Include boundary targets for configuration variables in Boundary coverage |
CoverageBoundaryIntSat (R) |
boolean |
Include boundary targets for the upper and lower boundaries of blocks which
are set to saturate on integer overflow. |
CoverageBoundaryIntSatMid (R) |
boolean |
Include boundary targets for no saturation for blocks which
are set to saturate on integer overflow. |
CoverageBoundaryRelops (previously DoRelationalOperatorBoundaryCoverage) (R) |
boolean |
Track boundary coverage for relational operators.
|
CoverageBoundaryRelopsFloat (previously DoRelationalOperatorBoundaryCoverageFloat) (R) |
boolean |
Track boundary value coverage for relational operators operating
on floating point values.
|
CoverageBoundaryRelopsFloatEqual (R) |
boolean |
Track boundary value coverage for the 'equal' case of relational operators operating
on floating point values.
|
CoverageBoundaryRelopsFloatEps (previously
RelationalOperatorBoundaryCoverageFloatTolerance) (R) |
double or 'next' |
Relative tolerance to use when tracking boundary value coverage
for relational operators operating on floating point values.
|
CoverageValidatorDiagramsInternal (R) |
boolean |
Toggles whether or not the targets within diagram-based Validator Objectives
are tracked. The objective itself (assertion or UDT) is tracked even
when the targets within the objective are not.
|
CDecisionMetric (R, R4C) |
'ifwhilefor', 'branching', 'nonstatic') |
Set the criteria used to decide if a C expression is a decision.
The possible values are interpreted as follows:
- ifwhilefor
Expressions which control if/while/for statements are decisions.
- branching
Expressions which control if/while/for statements or the ? operator
are decisions.
- nonstatic
All non-trivial Boolean expressions except static initializers
are decisions.
|
C Code
Parameters set in the C Code pane of the Info File Editor.
Parameter Name (Availability) | Allowed Values | Description |
SFunctionCoverage (R) |
'off', 'cumulative', 'separate' |
Default S-Function source code coverage tracking behavior. |
DoCCaching (R) |
boolean |
Create and use cache files for C code (files with extension ’.rso’).
|
Callbacks
Parameters set in the Callbacks pane of the Info File Editor.
Parameter Name (Availability) | Allowed Values | Description |
PreLoadFcn (R) |
string |
MATLAB commands to execute before loading the model.
|
PostLoadFcn (R) |
string |
MATLAB commands to execute after loading the model but before type inference.
|
Search Path
Parameters set in the Search Path pane of the Info File Editor.
Parameter Name (Availability) | Allowed Values | Description |
LibraryPath (R) |
string |
Model-specific library search path. This gets added to the global
search path when processing the model. It must be a semicolon-separated
list of directories. Do not use quotes.
|
|