| |
Reactis API V2022.2
API - Shared by all Bindings:
|
| Introduction | Reactis parameters set from File -> Global Settings... in the Reactis GUI. |
| General | Options from the General pane of the Global Settings dialog. |
| Reactis for C | Settings related to Reactis for C Plugin. |
| Embedded MATLAB | Settings related to Embedded MATLAB (EML) Plugin. |
| MATLAB | Settings configure Reactis interaction with MATLAB. |
| Path | Settings configure the Global Reactis path. |
| Files | Settings to configure where Reactis stores files it creates. |
| User Info | Settings to configure information Reactis will report to the license server. |
Introduction
Reactis parameters set from File -> Global Settings... in the Reactis GUI.
Parameters listed below can be used for the rsGetParameterValue and rsSetParameterValue functions (both MATLAB and C versions). These parameters influence the general function of Reactis. Each parameter described here can also be manipulated from the Global Settings dialog invoked via File -> Global Settings... in the main window of the Reactis GUI. The parameter names and allowed values are described below. For a more detailed description of the functionality being controlled see Chapter 4 of the Reactis User's Guide. The parameters are listed below in groups corresponding to the different tabs of the Global Settings dialog.
For parameters of type boolean, allowed values are 0, false, 1 or true.
The availability specification in parentheses beside 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.
General
Options from the General pane of the Global Settings dialog.
| Parameter Name (Availability) | Allowed Values | Description |
|---|---|---|
| Locale (R,R4C) | en_EN, ja_JP | Set the language used in the Reactis GUI to English (en_EN) or Japanese (ja_JP). |
| HelpSystemLanguage (R,R4C) | en | Set the language used in the Reactis in-tool documentation. Currently English (en) is the only available language. |
| AutoUpdateEnabled (R,R4C) | boolean | Enable automatic checking for updates. |
| Solver (R) | z3, rsi, none | Specify which solvers Reactis should use. |
| EnableLogging (R, R4C) |
boolean | Enable the Reactis logging facility. Enabling this can decrease performance and may generate large log files. Only enable this if asked to do so by the Reactis support team. |
| LogLevel (R, R4C) |
string | Set information about what to write to the Reactis log file (see parameter EnableLogging). If you are asked to create a log file by the Reactis support team, the required LogLevel string will be indicated. |
| LogFile (R, R4C) |
string | Set the location of the Reactis log file to be created when logging is enabled (see parameter EnableLogging). |
Reactis for C
Settings related to Reactis for C Plugin.
| Parameter Name (Availability) | Allowed Values | Description |
|---|---|---|
| UseCPlugin (R) |
boolean | Enable Reactis for C Plugin features to support white-box testing of C code parts of model (S-Functions, Stateflow custom code). |
Embedded MATLAB
Settings related to Embedded MATLAB (EML) Plugin.
| Parameter Name (Availability) | Allowed Values | Description |
|---|---|---|
| UseEmlPlugin (R) |
boolean | Enable Reactis for EML Plugin features to support white-box testing of Embedded MATLAB parts of model (MATLAB Function blocks, MATLAB functions in Stateflow). |
MATLAB
Settings configure Reactis interaction with MATLAB.
| Parameter Name (Availability) | Allowed Values | Description |
|---|---|---|
| MatlabRoot (R) |
string | Root directory of the MATLAB version that Reactis should use. Do not use quotes. |
| MatlabEngineType (R) | dll, com, socket | Select the method used by Reactis to invoke MATLAB: MATLAB engine DLL (dll), Windows COM interface (com) or Full MATLAB window (socket). |
| MatlabStartupTimeout (R) |
double | Maximum time for Reactis to wait when starting up MATLAB. If this timeout expires, Reactis will report an unable to invoke MATLAB error. |
| ReuseMatlabCommandWindows (R) | boolean | When Reactis invokes MATLAB , it will use this option to determine whether to reuse to existing MATLAB instances, or invoke new ones. |
Path
Settings configure the Global Reactis path.
| Parameter Name (Availability) | Allowed Values | Description |
|---|---|---|
| LibraryPath (R) |
string | Global Reactis library path. This must be a semicolon-separated list of directories. Do not use quotes. |
Files
Settings to configure where Reactis stores files it creates.
| Parameter Name (Availability) | Allowed Values | Description |
|---|---|---|
| ReactisFilesDir (R) |
string | Specifies the directory where Reactis stores files that it creates and uses. |
User Info
Settings to configure information Reactis will report to the license server.
| Parameter Name (Availability) | Allowed Values | Description |
|---|---|---|
| UserName (R, R4C) |
string | Name of the current user. Setting this to — (single dash with no quotes) will make Reactis use the logon name of the current user. This information will be reported to the license server. |
| UserPhone (R, R4C) |
string | Phone number of the current user. This information will be reported to the license server. |