	Contact \| Login
	Products \| Support \| About \| News \| FAQ

Section

Reactis API V2022.2

API - Reactis (C Bindings)

API C Types

RsCoverageMetric	Bit-mask type used to represent Reactis coverage metrics.
RsExtractFlags	Used to specify flags when extracting subsystems.
RsReportItem	Bit-mask type used to select Reactis test execution report items.
RsSeverity	Bit-mask type used to represent the severity of a message.
RsTargetStatus	Bit-mask type used to represent the status of a coverage target.
Other Types	Various abstract types used by the API.

General Reactis Functions

rsOpen	Start a Reactis API session.
rsClose	End a Reactis API session.
rsExtractSubsystem	Extract a subsystem from a model and save in a new .slx file.
rsGetParameterValue	Get the value of a global Reactis parameter or a model-specific default.
rsGetParameterValueBool	Get the value of a global 'boolean' typed Reactis parameter.
rsGetParameterValueDouble	Get the value of a global 'double' typed Reactis parameter.
rsSetParameterValue	Set the value of a global Reactis parameter.
rsSetStringEncoding	Set string encoding.
rsVersion	Return Reactis API version.
rsVersionParse	Parse Reactis version string.
rsDoubleToPreciseString	Convert double-precision value to string encoding.
rsPreciseStringToDouble	Convert a string created by rsDoubleToPreciseString back to double.

Errors and Warnings

rsGetLastError	Returns a string describing the most recent error.
rsGetNextWarning	Returns a string describing the next unread warning.
rsGetNumWarnings	Returns the number of unread warnings.
rsClearWarnings	Clears all currently stored warnings.
rsSetMaxNumWarnings	Sets the maximum number of warnings stored.

Reactis Simulator

rsSimOpen	Start a new Reactis Simulator session.
rsSimClose	Close a Reactis Simulator session.
rsSimExportSuite	Export a Reactis test suite to different formats.
rsSimExportSuiteEx	Export test suite (with extra parameters).
rsSimImportSuite	Import test data into a Reactis test suite.
rsSimImportSuiteEx	Import test suite (with extra parameters).
rsSimImportSuites	Import multiple files into a single Reactis test suite.
rsSimRunSuite	Run a test suite in a Reactis Simulator session.
rsSimUpdateOutputs	Update output and test point values in a test suite.
rsSimUpdateSuite	Update values in a test suite.
rsSimExportCCoverageDetails	Export extended C coverage data to CSV format.
rsSimRunSuiteWithReport	Run tests and generate HTML report.

Reactis Tester

rsTester	Create a test suite.
rsTesterWithReport	Create a test suite and a test execution report.
rsTesterStart	Initiate the asynchronous creation of a test suite.
rsTesterStartWithReport	Initiate the asynchronous creation of a test suite and report.
rsTesterStop	Stop running asynchronous test suite creation.
rsTesterClose	Close a Reactis Tester session.
rsTesterIsRunning	True if test suite creation is still ongoing.
rsTesterGetProgress	Get test suite generation progress.
rsTesterGetStatus	Get test suite generation status.
rsTesterGetSuite	Get test suite after generation is finished.
rsTesterGetNumStepsTaken	Retrieve number of steps taken so far during tester run.

Coverage Tracking

rsCoverageMetricFromString	Convert string to RsCoverageMetric value.
rsCoverageMetricToString	Convert RsCoverageMetric value to string.
rsGetCoverageCriteriaCount	Number of coverage metrics being tracked.
rsGetCoverageCriteriaName	Map an index to a coverage metric name.
rsGetCoverageCriteriaNumCovered	Number of covered targets in a metric.
rsGetCoverageCriteriaNumTargets	Number of targets in a metric.
rsGetCoverageCriteriaNumUncovered	Number of uncovered targets in a metric.
rsGetCoverageCriteriaNumUnreachable	Number of unreachable targets in a metric.
rsGetCoverageCriteriaPercentCovered	Percentage of reachable targets in a metric that are covered.

Reactis Test Suites

rsSuiteOpen	Open an existing Reactis test suite file.
rsSuiteClose	Close a test suite file.
rsSuiteSave	Save changes to a .rsi file.
rsSuiteGetNumTests	Get number of tests in a test suite.
rsSuiteGetTestNumSteps	Get number of steps in test suite.
rsSuiteGetTestName	Get name of a test in test suite.
rsSuiteGetReactisVersion	Get Reactis version of test suite.

Reactis Info File (General)

rsRsiOpen	Open an existing or create a new .rsi file.
rsRsiClose	Close an .rsi file.
rsRsiGetModelName	Returns a pointer to the name of the model.
rsRsiSave	Save changes to an .rsi file.
rsRsiGetParameterValue	Get the value of a model-specific setting.
rsRsiSetParameterValue	Set the value of a model-specific setting.
rsRsiGetNumDependencies	Get number of files listed in the "Additional Dependencies" list.
rsRsiGetDependency	Return a file from the "Additional Dependencies" list.
rsRsiAddDependency	Adds the file specified by the 'file' parameter as an additional dependency.
rsRsiRemoveDependency	Remove a file from the "Additional Dependencies" list.
rsRsiClearDependencies	Removes all entries from the "Additional Dependencies" list.

Reactis Info File (Coverage)

rsRsiGetCoverageEnabled	Get enabled/disabled status of a coverage metric.
rsRsiSetCoverageEnabled	Set enabled/disabled status of a coverage metric.
rsRsiGetSystemCoverageTracking	Get coverage tracking status of a subsystem.
rsRsiSetSystemCoverageTracking	Set coverage tracking status of a subsystem.
rsRsiSetCumulativeCoverage	Enable/Disable cumulative coverage tracking.
rsRsiIsCumulativeCoverage	Query cumulative coverage tracking status for a system.
rsRsiGetNumCumulativeCoverage	Get number of systems for which cumulative coverage tracking is enabled.
rsRsiGetCumulativeCoverage	Return the path of a cumulatively tracked subsystem.

Reactis Info File (Inputs and Outputs)

rsRsiGetNumInputs	Return the number of inputs in the .rsi file.
rsRsiGetNumOutputs	Return the number of output ports in the .rsi file.
rsRsiGetInputName	Retrieve the name of an input port in the .rsi file.
rsRsiGetOutputName	Retrieve the name of an output port in the .rsi file.
rsRsiGetInputType	Get the type of an input in the .rsi file.
rsRsiSetInputType	Set the type of an input in the .rsi file.
rsRsiGetInputTypeElement	Get the type of a sub-element within a non-scalar input in the .rsi file.
rsRsiSetInputTypeElement	Set the type of a sub-element within a non-scalar input in the .rsi file.
rsRsiGetOutputType	Return the data type of an output port in the .rsi file.
rsRsiGetOutputTolerance	Get the tolerance for an output in the .rsi file.
rsRsiSetOutputTolerance	Set the tolerance for an output in the .rsi file.
rsRsiGetOutputIntervals	Get the coverage tracking intervals for an output in the .rsi file.
rsRsiSetOutputIntervals	Set the coverage tracking intervals for an output in the .rsi file.
rsRsiDefaultInputs	Reset input types in .rsi file to their defaults.
rsRsiDefaultOutputs	Reset output tolerances in .rsi file to defaults.
rsRsiDefaultAll	Combines effects of rsRsiDefaultInputs and rsRsiDefaultOutputs.
rsRsiSyncInputs	Synchronize input types between .rsi file and associated model.
rsRsiTlSyncInputRanges	Synchronize input value ranges between .rsi file and associated TargetLink model.
rsRsiSyncOutputs	Synchronize outputs between .rsi file and associated model.
rsRsiSyncAll	Combines effects of rsRsiSyncInputs and rsRsiSyncOutputs.

Reactis Info File (Test Points)

rsRsiGetNumTestPoints	Return the number of test points in the .rsi file.
rsRsiGetTestPointId	Return an identifier for a test point in the .rsi file.
rsRsiAddTestPoint	Add a new test point to the .rsi file.
rsRsiRemoveTestPoint	Remove a test point from the .rsi file.
rsRsiClearTestPoints	Remove all test points from the .rsi file.
rsRsiImportTestPoints	Import all Simulink test points set in the model and add them as Reactis test points.
rsRsiSyncTestPoints	Synchronize test point data types between the .rsi file and model.
rsRsiDefaultTestPoints	Remove constraints from all test points in the .rsi file.
rsRsiSetTestPointParameterValue	Set the value of a test point parameter.
rsRsiGetTestPointParameterValue	Get the value of a test point parameter.
rsRsiGetTestPointIntervals	Get the coverage tracking intervals for a test point in the .rsi file.
rsRsiSetTestPointIntervals	Set the coverage tracking intervals for a test point in the .rsi file.

Reactis Info File (Configuration Variables)

rsRsiAddConfigVar	Add a configuration variable to the .rsi file.
rsRsiRemoveConfigVar	Remove configuration variable from .rsi file.
rsRsiGetNumConfigVars	Number of configuration variables in an .rsi file.
rsRsiGetConfigVarName	Return name of a configuration variable with the given index.
rsRsiGetConfigVarType	Return the type of a configuration variable.
rsRsiSetConfigVarType	Set the type of a configuration variable.
rsRsiGetNumPotentialConfigVars	Number of workspace vars that could be configuration vars.
rsRsiGetPotentialConfigVarName	Retrieve name of potential configuration variable.
rsRsiAddConfigVarSet	Add a new configuration variable set to the .rsi file.
rsRsiRemoveConfigVarSet	Delete a configuration variable set from .rsi file.
rsRsiGetNumConfigVarSets	Number of configuration variable sets in an .rsi file.
rsRsiGetConfigVarSetEnabled	Get enabled/disabled status of a configuration variable set.
rsRsiSetConfigVarSetEnabled	Set enabled/disabled status of a configuration variable set.
rsRsiGetActiveConfigVarSet	Return name of currently active configuration variable set.
rsRsiSetActiveConfigVarSet	Sets the active configuration variable set.
rsRsiGetConfigVarSetName	Return name of a configuration variable set with the given index.

Reactis Info File (Validator Objectives)

rsRsiAddAssertionDiagram	Add a diagram assertion.
rsRsiAddAssertionExpression	Add an expression assertion.
rsRsiAddAssertionTimer	Add a timer assertion.
rsRsiAddUserTargetDiagram	Add a diagram-based user-defined target.
rsRsiAddUserTargetExpression	Add an expression-based user-defined target.
rsRsiAddUserTargetTimer	Add a timer-based user-defined target.
rsRsiAddStateflowAssertionExpression	Add an expression assertion.
rsRsiAddStateflowAssertionTimer	Add a timer assertion.
rsRsiQueryObjectives	Query Validator objectives.
rsRsiGetQueriedObjectiveId	Returns an identifier for a Validator objective.
rsRsiGetObjectiveParameterValue	Get the value of a Validator objective parameter.
rsRsiRemoveObjective	Remove a Validator objective.
rsRsiAddStateflowUserTargetExpression	Add an expression-based user-defined target.
rsRsiAddStateflowUserTargetTimer	Add a timer-based user-defined target.
rsRsiAddVirtualSourceDiagram	Add a diagram-based virtual source.
rsRsiAddVirtualSourceExpression	Add an expression-based virtual source.

Reactis Report Configuration

rsReportConfig	Create a report configuration.
rsReportConfigDefault	Creates a report configuration with default settings.
rsReportConfigClose	Close a report configuration.
rsReportConfigGetGlobalDefault	Get the global default report configuration.
rsReportConfigGetItems	Get items included in report configuration.
rsReportConfigGetSummaryMetrics	Get summary metrics in report configuration.
rsReportConfigGetDetailMetrics	Get detail metrics in report configuration.
rsReportConfigGetDetailStatus	Get detail status in report configuration.
rsReportConfigGetDiffLimit	Get the limit on the number of difference details which will appear in a report.
rsReportConfigSetGlobalDefault	Set the global default report configuration.
rsReportConfigSetItems	Set items included in report configuration.
rsReportConfigSetSummaryMetrics	Set summary metrics in report configuration.
rsReportConfigSetDetailMetrics	Set detail metrics in report configuration.
rsReportConfigSetDetailStatus	Set detail status in report configuration.
rsReportConfigSetDiffLimit	Specify a limit on the number of difference details which will appear in a report.
rsReportItemFromString	Converts a string to an individual RsReportItem value.
rsReportItemToString	Converts an individual RsReportItem value to a string.
rsRsiGetDefaultReportConfig	Get the default report configuration for an .rsi file.
rsRsiSetDefaultReportConfig	Set the default report configuration for an .rsi file.
rsTargetStatusFromString	Convert a string to a RsTargetStatus value.
rsTargetStatusToString	Convert a RsTargetStatus value to a string.

Category

Section

API - Reactis (C Bindings)

API C Types

General Reactis Functions

Errors and Warnings

Reactis Simulator

Reactis Tester

Coverage Tracking

Reactis Test Suites

Reactis Info File (General)

Reactis Info File (Coverage)

Reactis Info File (Inputs and Outputs)

Reactis Info File (Test Points)

Reactis Info File (Configuration Variables)

Reactis Info File (Validator Objectives)

Reactis Report Configuration