| |
Reactis API V2022
Reactis API:
|
| rsRsiAddHarness | Add a harness to an .rsi file. |
| rsRsiRemoveHarness | Remove a harness from an .rsi file. |
| rsRsiSetCurrentHarness | Set the currently active harness in the .rsi file |
| rsRsiGetCurrentHarness | Get the name of the currently active harness. |
| rsRsiGetHarnesses | Get the a list of all harnesses defined in an .rsi file. |
| rsRsiGetHarnessParameterValue | Get the value of a harness parameter |
| rsRsiSetHarnessParameterValue | Set the value of a harness parameter |
rsRsiAddHarness
Add a harness to an .rsi file.
Syntax
rsRsiAddHarness(rsiId,harnessName,system)
Description
rsRsiAddHarness(rsiId,system) adds a new harness
named harnessName to the .rsi file identified by rsiId.
The system parameter specifies the system under test for the new harness. The path is given as a list of systems separated by the "/" character. For example, sys1/sys2/sys3 specifies that system "sys3" (located within sys1/sys2) is the system under test.
See Also
rsRsiRemoveHarness, rsRsiSetCurrentHarness, rsRsiGetCurrentHarness, rsRsiGetHarnesses, rsRsiGetHarnessParameterValue, rsRsiSetHarnessParameterValuersRsiRemoveHarness
Remove a harness from an .rsi file.
Syntax
rsRsiRemoveHarness(rsiId,harnessName)
Description
rsRsiRemoveHarness(rsiId,harnessName) removes the harness
named harnessName from the file identified by rsiId.
The currently active harness and the (default) harness for the model's top-level system can not be removed.
See Also
rsRsiAddHarness, rsRsiSetCurrentHarness, rsRsiGetCurrentHarness, rsRsiGetHarnesses, rsRsiGetHarnessParameterValue, rsRsiSetHarnessParameterValuersRsiSetCurrentHarness
Set the currently active harness in the .rsi file
Syntax
rsRsiSetCurrentHarness(rsiId,harnessName)
Description
rsRsiSetCurrentHarness(rsiId,harnessName) sets the harness
named harnessName as the currently active harness in the file
identified by rsiId.
The currently active harness setting affects all calls to API functions that read or modify information about inputs or outputs, such as rsRsiSetInputType, rsRsiGetInputType, rsRsiSetOutputTolerance and similar. Those functions will operate on inputs/outputs of the system specified for the harness.
To activate the (default) harness for the model's top-level system, use "TopLevel" as the harness name
rsiId is the identifier of an .rsi file previously opened by rsRsiOpen. rsRsiSave must be called to save modifications to .rsi file in order for them to be used by subsequent calls to rsSimOpen or rsTester. Updates to .rsi file are not propagated to any running Simulator or Tester sessions.
See Also
rsRsiAddHarness, rsRsiRemoveHarness, rsRsiGetCurrentHarness, rsRsiGetHarnesses, rsRsiGetHarnessParameterValue, rsRsiSetHarnessParameterValue, rsRsiSaversRsiGetCurrentHarness
Get the name of the currently active harness.
Syntax
rsRsiGetCurrentHarness(rsiId)
Description
rsRsiGetCurrentHarness(rsiId) returns the name of the currently active
harness in the file identified by rsiId. If the (default) harness for the
model's top-level system is active, the name "TopLevel" will be returned.
The currently active harness setting affects all calls to API functions that read or modify information about input or output types, such as rsRsiSetInputType, rsRsiGetInputType, rsRsiSetOutputTolerance and similar. Those functions will operate on inputs/outputs of the system specified for the harness.
See Also
rsRsiAddHarness, rsRsiRemoveHarness, rsRsiSetCurrentHarness, rsRsiGetHarnesses, rsRsiGetHarnessParameterValue, rsRsiSetHarnessParameterValuersRsiGetHarnesses
Get the a list of all harnesses defined in an .rsi file.
Syntax
rsRsiGetHarnesses(rsiId)
Description
rsRsiGetHarnesses(rsiId) returns a cell array of strings listing all
harnesses defined in the file identified by rsiId. The list will include the
entry "TopLevel", specifying the (default) harness for the model's top-level system.
See Also
rsRsiAddHarness, rsRsiRemoveHarness, rsRsiSetCurrentHarness, rsRsiGetCurrentHarness, rsRsiGetHarnessParameterValuersRsiGetHarnessParameterValue
Get the value of a harness parameter
Syntax
rsRsiGetHarnessParameterValue(rsiId, parameterName)
Description
rsRsiGetHarnesssParameterValue(rsiId, harnessName, parameterName)
returns the value of harness parameter parameterName in the file
identified by rsiId.
Currently valid harness parameters are:
| Name | Description |
|---|---|
| System | The system under test that was specified when the harness was created. |
| SampleRate | The sample rate specified for the harness. A negative value means the harness uses the same sample rate as the model. |
See Also
rsRsiAddHarness, rsRsiRemoveHarness, rsRsiSetCurrentHarness, rsRsiGetCurrentHarness, rsRsiGetHarnesses, rsRsiSetHarnessParameterValuersRsiSetHarnessParameterValue
Set the value of a harness parameter
Syntax
rsRsiSetHarnessParameterValue(rsiId, parameterName, parameterValue)
Description
rsRsiSetHarnesssParameterValue(rsiId, harnessName, parameterName, parameterValue)
sets the value of harness parameter parameterName in the file
identified by rsiId to parameterValue
Currently valid harness parameters for modification are:
| Name | Description |
|---|---|
| SampleRate | The sample rate specified for the harness. A negative value means the harness uses the same sample rate as the model. |
rsiId is the identifier of an .rsi file previously opened by rsRsiOpen. rsRsiSave must be called to save modifications to .rsi file in order for them to be used by subsequent calls to rsSimOpen or rsTester. Updates to .rsi file are not propagated to any running Simulator or Tester sessions.