setProperty

Class: sltest.testmanager.TestCase
Package: sltest.testmanager

Set test case property

expand all in page

Syntax

setProperty(tc,Name,Value)

Description

setProperty(tc,Name,Value) sets a test case property.

Input Arguments

expand all

`tc` — Test case
`sltest.testmanager.TestCase` object

Test case to set property, specified as an sltest.testmanager.TestCase object.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'StopTime',100

`'Model'` — System Under Test model name
empty character vector (default)

The model name in the System Under Test section, specified as a character vector.

Example: 'sldemo_absbrake'

`'SimulationMode'` — Simulation mode
empty character vector (default) | `'Normal'` | `'Accelerator'` | `'Rapid Accelerator'` | `'Software-in-the-Loop (SIL)'` | `'Processor-in-the-Loop (PIL)'`

The simulation mode of the model or harness, specified as a character vector. To return to the default model settings, specify an empty character vector, ''.

Example: 'SimulationMode','Rapid Accelerator'

`'OverrideSILPILMode'` — Override SIL or PIL mode
`false` (default) | `true`

Override SIL/PIL simulation mode of model blocks to Normal simulation mode, specified as a logical. If this property is true, the associated check box in the Simulation Settings Overrides section of the Test Manager is selected.

`'OverrideStartTime'` — Override model start time
`false` (default) | `true`

Indicate if the test case overrides the model start time, specified as true or false.

`'StartTime'` — Model start time
`0` (default) | scalar

Model start time, specified as a scalar value.

`'OverrideStopTime'` — Override model stop time
`false` (default) | `true`

Indicate if the test case overrides the model stop time, specified as true or false.

`'StopTime'` — Model stop time
`10` (default) | scalar

Model stop time, specified as a scalar value.

`'OverrideInitialState'` — Override model initial state
`false` (default) | `true`

Indicate if the test case overrides the model initial state, specified as true or false.

`'InitialState'` — Model initial state
empty character vector (default)

Model initial state from a workspace variable, specified as a character vector.

`'HarnessName'` — Test harness name
empty character vector (default)

Name of a test harness to use in the System Under Test section, specified as a character vector.

`'HarnessOwner'` — Test harness owner name
empty character vector (default)

Name of the test harness owner, specified as a character vector.

`'UseSignalBuilderGroup'` — Override Signal Builder group
`false` (default) | `true`

Indicate if the test case overrides the model and uses a different Signal Builder group in the Inputs section, specified as true or false.

`'SignalBuilderGroup'` — Signal Builder group name
empty character vector (default)

Signal Builder group name, specified as a character vector. To return to the default model settings, specify an empty character vector, ''.

`'OverrideModelOutputSettings'` — Override model output settings
`false` (default) | `true`

Indicate if the test case overrides the model settings under the Outputs section, specified as true or false.

`'SaveOutput'` — Override saving output
`false` (default) | `true`

Indicate if the test case overrides saving model output, specified as true or false.

`'SaveState'` — Save output state values
`false` (default) | `true`

Indicate if the test case is set to save output state values, specified as true or false.

`'SignalLogging'` — Log signals
`true` (default) | `false`

Indicate if the test case is set to log signals marked for logging in the model, specified as true or false.

`'DSMLogging'` — Log Data Store variables
`true` (default) | `false`

Indicate if the test case is set to log Data Store variables, specified as true or false.

`'SaveFinalState'` — Save final state
`false` (default) | `true`

Indicate if the test case is set to store final state values, specified as true or false.

`'SimulationIndex'` — Equivalence test case simulation
`1` (default) | `2`

Simulation number that the property applies to, specified as an integer, 1 or 2. This setting applies to the simulation test case.

`'ConfigSetOverrideSetting'` — Configuration setting override
`1` (default) | `2` | `3`

Override the configuration settings, specified as an integer.

1 — No override
2 — Use a named configuration set in the model
3 — Use a configuration set specified in a file

`'ConfigSetName'` — Configuration set name
empty character vector (default)

Name of the configuration setting in a model, specified as a character vector.

`'ConfigSetVarName'` — Configuration set variable name
empty character vector (default)

Variable name in a configuration set file, specified as a character vector.

`'ConfigSetFileLocation'` — Configuration set file path
empty character vector (default)

File name and path of the configuration set, specified as a character vector.

`'PreloadCallback'` — Pre-load callback script
character vector

Pre-load callback script, specified as a character vector.

`'PostloadCallback'` — Post-load callback script
character vector

Post-load callback script, specified as a character vector.

`'CleanupCallback'` — Cleanup callback script
character vector

Test-case level cleanup callback script, specified as a character vector. The function deletes any existing callback script and replaces it with the specified character vector.

Example: 'clear a % clear value from workspace'

`'PreStartRealTimeApplicationCallback'` — Real-time pre-start callback
character vector

Character vector evaluated before the real-time application is started on the target computer, specified as a character vector. For more information on real-time testing, see Test Models in Real Time.

`'IterationScript'` — Iteration script
character vector

Iteration script evaluated to create test case iterations, specified as a character vector. For more information about test iteration scripts, see Test Iterations.

`'FastRestart'` — Run iterations using fast restart
`false` (default) | `true`

Indicate if the test iterations run using fast restart mode, specified as true or false.

`'SaveBaselineRunInTestResult'` — Save baseline in test result
`false` (default) | `true`

Indicate if the test case saves the baseline used in the test result after test execution, specified as true or false.

`'SaveInputRunInTestResult'` — Save input in test result
`false` (default) | `true`

Enable saving external input run used in test result, specified as true or false.

`'StopSimAtLastTimePoint'` — Stop simulation at last input time
`false` (default) | `true`

Enable stopping the simulation at the final time value of the input, specified as true or false.

`'LoadAppFrom'` — Application location
`1` (default) | `2` | `3`

Location from which to load the application, specified as an integer. This property is available only in real-time test cases.

1 — Model
2 — Target application
3 — Target computer

For more information on real-time testing, see Test Models in Real Time.

`'TargetComputer'` — Target computer name
character vector

Name of the target computer, specified as a character vector. This property is available only in real-time test cases. For more information on real-time testing, see Test Models in Real Time.

`'TargetApplication'` — Target application name and path
character vector

Name and path of the target application, specified as a character vector. This property is available only in real-time test cases. For more information on real-time testing, see Test Models in Real Time.

Examples

expand all

Set Model as System Under Test

% Create the test file, test suite, and test case structure
tf = sltest.testmanager.TestFile('API Test File');
ts = createTestSuite(tf,'API Test Suite');
tc = createTestCase(ts,'baseline','Baseline API Test Case');

% Remove the default test suite
tsDel = getTestSuiteByName(tf,'New Test Suite 1');
remove(tsDel);

% Assign the system under test to the test case
setProperty(tc,'Model','sldemo_absbrake');

Documentation

setProperty

Syntax

Description

Input Arguments

tc — Test case sltest.testmanager.TestCase object

Name-Value Pair Arguments

'Model' — System Under Test model name empty character vector (default)

'SimulationMode' — Simulation mode empty character vector (default) | 'Normal' | 'Accelerator' | 'Rapid Accelerator' | 'Software-in-the-Loop (SIL)' | 'Processor-in-the-Loop (PIL)'

'OverrideSILPILMode' — Override SIL or PIL mode false (default) | true

'OverrideStartTime' — Override model start time false (default) | true

'StartTime' — Model start time 0 (default) | scalar

'OverrideStopTime' — Override model stop time false (default) | true

'StopTime' — Model stop time 10 (default) | scalar

'OverrideInitialState' — Override model initial state false (default) | true

'InitialState' — Model initial state empty character vector (default)

'HarnessName' — Test harness name empty character vector (default)

'HarnessOwner' — Test harness owner name empty character vector (default)

'UseSignalBuilderGroup' — Override Signal Builder group false (default) | true

'SignalBuilderGroup' — Signal Builder group name empty character vector (default)

'OverrideModelOutputSettings' — Override model output settings false (default) | true

'SaveOutput' — Override saving output false (default) | true

'SaveState' — Save output state values false (default) | true

'SignalLogging' — Log signals true (default) | false

'DSMLogging' — Log Data Store variables true (default) | false

'SaveFinalState' — Save final state false (default) | true

'SimulationIndex' — Equivalence test case simulation 1 (default) | 2

'ConfigSetOverrideSetting' — Configuration setting override 1 (default) | 2 | 3

'ConfigSetName' — Configuration set name empty character vector (default)

'ConfigSetVarName' — Configuration set variable name empty character vector (default)

'ConfigSetFileLocation' — Configuration set file path empty character vector (default)

'PreloadCallback' — Pre-load callback script character vector

'PostloadCallback' — Post-load callback script character vector

'CleanupCallback' — Cleanup callback script character vector

'PreStartRealTimeApplicationCallback' — Real-time pre-start callback character vector

'IterationScript' — Iteration script character vector

'FastRestart' — Run iterations using fast restart false (default) | true

'SaveBaselineRunInTestResult' — Save baseline in test result false (default) | true

'SaveInputRunInTestResult' — Save input in test result false (default) | true

'StopSimAtLastTimePoint' — Stop simulation at last input time false (default) | true

'LoadAppFrom' — Application location 1 (default) | 2 | 3

'TargetComputer' — Target computer name character vector

'TargetApplication' — Target application name and path character vector