sltest.testsequence.activateScenario

Set Test Sequence block scenario as active

Since R2020b

Syntax

sltest.testsequence.activateScenario(blockPath,scenarioName)

Description

sltest.testsequence.activateScenario(blockPath,scenarioName) makes the scenarioName scenario in the specified Test Sequence block active so it runs during simulation. Only one scenario is active at a time. You can use activateScenario only if sltest.testsequence.setScenarioControlSource is sltest.testsequence.ScenarioControlSource.Block, which sets the active scenario control to a Test Sequence block instead of a variable in the workspace. Use sltest.testsequence.getScenarioControlSource to view the current scenario control source setting and sltest.testsequence.setScenarioControlSource to change it.

Examples

Activate Test Sequence Scenario

Set the Test Sequence block in the sltestRollRefTestExample model to use scenarios. Then, add another scenario named Scenario_2 and activate Scenario_2 so it runs when the model simulates. The control source is the default, sltest.testsequence.ScenarioControlSource.Block. Close the model without saving it.

openExample('sltestRollRefTestExample');

sltest.testsequence.useScenario...
   ('sltestRollRefTestExample/Test Sequence',...
   'Scenario_1');

sltest.testsequence.addScenario...
   ('sltestRollRefTestExample/Test Sequence',...
   'Scenario_2');

sltest.testsequence.activateScenario...
   ('sltestRollRefTestExample/Test Sequence',...
   'Scenario_2');

close_system(Model,0)

Input Arguments

blockPath — Test Sequence block path or handle

string | character vector

Path to a Test Sequence block, including the block name, specified as a string or character vector. Instead of the block path, you can use a block handle.

Example: 'FanSpeedTestHarness/Test Sequence'

scenarioName — Name of scenario

character vector | string

Name of the scenario, specified as a string or character vector.

Example: 'Name','Scenario_1'

Version History

Introduced in R2020b