Reactive Systems logo
Reactis API V2020

API - Reactis: C Bindings


API C Types

RsCoverageMetricBit-mask type used to represent Reactis coverage metrics.
RsExtractFlagsUsed to specify flags when extracting subsystems.
RsReportItemBit-mask type used to select Reactis test execution report items.
RsSeverityBit-mask type used to represent the severity of a message.
RsTargetStatusBit-mask type used to represent the status of a coverage target.
Other TypesVarious abstract types used by the API.

General Reactis Functions

rsOpenStart a Reactis API session.
rsCloseEnd a Reactis API session.
rsGetLastErrorReturns a string describing the most recent error.
rsExtractSubsystemExtract a subsystem from a model and save in a new .slx file.
rsGetParameterValueGet the value of a global Reactis parameter or a model-specific default.
rsGetParameterValueBoolGet the value of a global 'boolean' typed Reactis parameter.
rsGetParameterValueDoubleGet the value of a global 'double' typed Reactis parameter.
rsSetParameterValueSet the value of a global Reactis parameter.
rsSetStringEncodingSet string encoding.
rsVersionReturn Reactis API version.
rsVersionParseParse Reactis version string.
rsDoubleToPreciseStringConvert double-precision value to string encoding.
rsPreciseStringToDoubleConvert a string created by rsDoubleToPreciseString back to double.

Reactis Simulator

rsSimOpenStart a new Reactis Simulator session.
rsSimCloseClose a Reactis Simulator session.
rsSimExportSuiteExport a Reactis test suite to different formats.
rsSimExportSuiteExExport test suite (with extra parameters).
rsSimImportSuiteImport test data into a Reactis test suite.
rsSimImportSuiteExImport test suite (with extra parameters).
rsSimImportSuitesImport multiple files into a single Reactis test suite.
rsSimRunSuiteRun a test suite in a Reactis Simulator session.
rsSimUpdateOutputsUpdate output values in a test suite.
rsSimExportCCoverageDetailsExport extended C coverage data to CSV format.
rsSimRunSuiteWithReportRun tests and generate HTML report.

Reactis Tester

rsTesterCreate a test suite.
rsTesterWithReportCreate a test suite and a test execution report.
rsTesterStartInitiate the asynchronous creation of a test suite.
rsTesterStartWithReportInitiate the asynchronous creation of a test suite and report.
rsTesterStopStop running asynchronous test suite creation.
rsTesterCloseClose a Reactis Tester session.
rsTesterIsRunningTrue if test suite creation is still ongoing.
rsTesterGetProgressGet test suite generation progress.
rsTesterGetStatusGet test suite generation status.
rsTesterGetSuiteGet test suite after generation is finished.
rsTesterGetNumStepsTakenRetrieve number of steps taken so far during tester run.

Coverage Tracking

rsCoverageMetricFromStringConvert string to RsCoverageMetric value.
rsCoverageMetricToStringConvert RsCoverageMetric value to string.
rsGetCoverageCriteriaCountNumber of coverage metrics being tracked.
rsGetCoverageCriteriaNameMap an index to a coverage metric name.
rsGetCoverageCriteriaNumCoveredNumber of covered targets in a metric.
rsGetCoverageCriteriaNumTargetsNumber of targets in a metric.
rsGetCoverageCriteriaNumUncoveredNumber of uncovered targets in a metric.
rsGetCoverageCriteriaNumUnreachableNumber of unreachable targets in a metric.
rsGetCoverageCriteriaPercentCoveredPercentage of reachable targets in a metric that are covered.

Reactis Test Suites

rsSuiteOpenOpen an existing Reactis test suite file.
rsSuiteCloseClose a test suite file.
rsSuiteSaveSave changes to a .rsi file.
rsSuiteGetNumTestsGet number of tests in a test suite.
rsSuiteGetTestNumStepsGet number of steps in test suite.
rsSuiteGetTestNameGet name of a test in test suite.
rsSuiteGetReactisVersionGet Reactis version of test suite.

Reactis Info File (General)

rsRsiOpenOpen an existing or create a new .rsi file.
rsRsiCloseClose an .rsi file.
rsRsiGetModelNameReturns a pointer to the name of the model.
rsRsiSaveSave changes to an .rsi file.
rsRsiGetParameterValueGet the value of a model-specific setting.
rsRsiSetParameterValueSet the value of a model-specific setting.
rsRsiGetNumDependenciesGet number of files listed in the "Additional Dependencies" list.
rsRsiGetDependencyReturn a file from the "Additional Dependencies" list.
rsRsiAddDependencyAdds the file specified by the 'file' parameter as an additional dependency.
rsRsiRemoveDependencyRemove a file from the "Additional Dependencies" list.
rsRsiClearDependenciesRemoves all entries from the "Additional Dependencies" list.

Reactis Info File (Coverage)

rsRsiGetCoverageEnabledGet enabled/disabled status of a coverage metric.
rsRsiSetCoverageEnabledSet enabled/disabled status of a coverage metric.
rsRsiGetSystemCoverageTrackingGet coverage tracking status of a subsystem.
rsRsiSetSystemCoverageTrackingSet coverage tracking status of a subsystem.
rsRsiSetCumulativeCoverageEnable/Disable cumulative coverage tracking.
rsRsiIsCumulativeCoverageQuery cumulative coverage tracking status for a system.
rsRsiGetNumCumulativeCoverageGet number of systems for which cumulative coverage tracking is enabled.
rsRsiGetCumulativeCoverageReturn the path of a cumulatively tracked subsystem.

Reactis Info File (Inputs and Outputs)

rsRsiGetNumInputsReturn the number of inputs in the .rsi file.
rsRsiGetNumOutputsReturn the number of output ports in the .rsi file.
rsRsiGetInputNameRetrieve the name of an input port in the .rsi file.
rsRsiGetOutputNameRetrieve the name of an output port in the .rsi file.
rsRsiGetInputTypeGet the type of an input in the .rsi file.
rsRsiSetInputTypeSet the type of an input in the .rsi file.
rsRsiGetInputTypeElementGet the type of a sub-element within a non-scalar input in the .rsi file.
rsRsiSetInputTypeElementSet the type of a sub-element within a non-scalar input in the .rsi file.
rsRsiGetOutputTypeReturn the data type of an output port in the .rsi file.
rsRsiGetOutputToleranceGet the tolerance for an output in the .rsi file.
rsRsiSetOutputToleranceSet the tolerance for an output in the .rsi file.
rsRsiDefaultInputsReset input types in .rsi file to their defaults.
rsRsiDefaultOutputsReset output tolerances in .rsi file to defaults.
rsRsiDefaultAllCombines effects of rsRsiDefaultInputs and rsRsiDefaultOutputs.
rsRsiSyncInputsSynchronize input types between .rsi file and associated model.
rsRsiSyncOutputsSynchronize outputs between .rsi file and associated model.
rsRsiSyncAllCombines effects of rsRsiSyncInputs and rsRsiSyncOutputs.

Reactis Info File (Test Points)

rsRsiGetNumTestPointsReturn the number of test points in the .rsi file.
rsRsiGetTestPointIdReturn an identifier for a test point in the .rsi file.
rsRsiAddTestPointAdd a new test point to the .rsi file.
rsRsiRemoveTestPointRemove a test point from the .rsi file.
rsRsiClearTestPointsRemove all test points from the .rsi file.
rsRsiImportTestPointsImport all Simulink test points set in the model and add them as Reactis test points.
rsRsiSyncTestPointsSynchronize test point data types between the .rsi file and model.
rsRsiDefaultTestPointsRemove constraints from all test points in the .rsi file.
rsRsiSetTestPointParameterValueSet the value of a test point parameter.
rsRsiGetTestPointParameterValueGet the value of a test point parameter.

Reactis Info File (Configuration Variables)

rsRsiAddConfigVarAdd a configuration variable to the .rsi file.
rsRsiRemoveConfigVarRemove configuration variable from .rsi file.
rsRsiGetNumConfigVarsNumber of configuration variables in an .rsi file.
rsRsiGetConfigVarNameReturn name of a configuration variable with the given index.
rsRsiGetConfigVarTypeReturn the type of a configuration variable.
rsRsiSetConfigVarTypeSet the type of a configuration variable.
rsRsiGetNumPotentialConfigVarsNumber of workspace vars that could be configuration vars.
rsRsiGetPotentialConfigVarNameRetrieve name of potential configuration variable.
rsRsiAddConfigVarSetAdd a new configuration variable set to the .rsi file.
rsRsiRemoveConfigVarSetDelete a configuration variable set from .rsi file.
rsRsiGetNumConfigVarSetsNumber of configuration variable sets in an .rsi file.
rsRsiGetConfigVarSetEnabledGet enabled/disabled status of a configuration variable set.
rsRsiSetConfigVarSetEnabledSet enabled/disabled status of a configuration variable set.
rsRsiGetActiveConfigVarSetReturn name of currently active configuration variable set.
rsRsiSetActiveConfigVarSetSets the active configuration variable set.
rsRsiGetConfigVarSetNameReturn name of a configuration variable set with the given index.

Reactis Info File (Validator Objectives)

rsRsiAddAssertionDiagramAdd a diagram assertion.
rsRsiAddAssertionExpressionAdd an expression assertion.
rsRsiAddAssertionTimerAdd a timer assertion.
rsRsiAddUserTargetDiagramAdd a diagram-based user-defined target.
rsRsiAddUserTargetExpressionAdd an expression-based user-defined target.
rsRsiAddUserTargetTimerAdd a timer-based user-defined target.
rsRsiAddStateflowAssertionExpressionAdd an expression assertion.
rsRsiAddStateflowAssertionTimerAdd a timer assertion.
rsRsiQueryObjectivesQuery Validator objectives.
rsRsiGetQueriedObjectiveIdReturns an identifier for a Validator objective.
rsRsiGetObjectiveParameterValueGet the value of a Validator objective parameter.
rsRsiRemoveObjectiveRemove a Validator objective.
rsRsiAddStateflowUserTargetExpressionAdd an expression-based user-defined target.
rsRsiAddStateflowUserTargetTimerAdd a timer-based user-defined target.
rsRsiAddVirtualSourceDiagramAdd a diagram-based virtual source.
rsRsiAddVirtualSourceExpressionAdd an expression-based virtual source.

Reactis Report Configuration

rsReportConfigCreate a report configuration.
rsReportConfigDefaultCreates a report configuration with default settings.
rsReportConfigCloseClose a report configuration.
rsReportConfigGetGlobalDefaultGet the global default report configuration.
rsReportConfigGetItemsGet items included in report configuration.
rsReportConfigGetSummaryMetricsGet summary metrics in report configuration.
rsReportConfigGetDetailMetricsGet detail metrics in report configuration.
rsReportConfigGetDetailStatusGet detail status in report configuration.
rsReportConfigGetDiffLimitGet the limit on the number of difference details which will appear in a report.
rsReportConfigSetGlobalDefaultSet the global default report configuration.
rsReportConfigSetItemsSet items included in report configuration.
rsReportConfigSetSummaryMetricsSet summary metrics in report configuration.
rsReportConfigSetDetailMetricsSet detail metrics in report configuration.
rsReportConfigSetDetailStatusSet detail status in report configuration.
rsReportConfigSetDiffLimitSpecify a limit on the number of difference details which will appear in a report.
rsReportItemFromStringConverts a string to an individual RsReportItem value.
rsReportItemToStringConverts an individual RsReportItem value to a string.
rsRsiGetDefaultReportConfigGet the default report configuration for an .rsi file.
rsRsiSetDefaultReportConfigSet the default report configuration for an .rsi file.
rsTargetStatusFromStringConvert a string to a RsTargetStatus value.
rsTargetStatusToStringConvert a RsTargetStatus value to a string.