sltest.harness.set

Change test harness property

Syntax

sltest.harness.set(harnessOwner,harnessName,Name,Value)

Description

sltest.harness.set(harnessOwner,harnessName,Name,Value) changes a property, specified by one Name,Value pair argument, for the test harness harnessName owned by the model or component harnessOwner.

Examples

Change the Name of a Test Harness

This example shows how to change the name of a test harness using sltest.harness.set.

Create a Test Harness

Load the f14 model and create a test harness for the Controller subsystem.

load_system('f14')
sltest.harness.create('f14/Controller','Name','Harness1')

Change the Test Harness Name

Change the name from Harness1 to ControllerHarness.

sltest.harness.set('f14/Controller','Harness1','Name','ControllerHarness')

Close the Model

close_system('f14',0)

Input Arguments

harnessOwner — Model or component

character vector | double

Model or component handle, or path, specified as a character vector or double

Example: 1.9500e+03

Example: 'model_name'

Example: 'model_name/Subsystem'

harnessName — Harness name

character vector

The name of the harness, specified as a character vector.

Example: 'harness_name'

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Name','updated_harness' specifies a new harness name 'updated_harness'.

Name — New harness name

character vector

The new name for the harness, specified as the comma-separated pair consisting of 'Name' and a valid MATLAB file name.

Example: 'Name','new_harness_name'

Description — New harness description

character vector

The new description for the harness, specified by the comma-separated pair consisting of 'Description' and a character vector.

Example: 'Description','An updated test harness'

SynchronizationMode — Specifies the synchronization behavior of the component under test

'SyncOnOpenAndClose' (default) | 'SyncOnOpen' | 'SyncOnPushRebuildOnly'

Option to specify when the component under test synchronizes the main model and the test harness. Subsystem model test harnesses are always synchronized with their underlying model.

• 'SyncOnOpenAndClose' rebuilds the component under test from the main model when the test harness opens, and pushes changes from the component under test to the main model when the test harness closes.

• 'SyncOnOpen' rebuilds the component under test from the main model when the test harness opens. It does not push changes from the component under test to the main model when the test harness closes.

• 'SyncOnPushRebuildOnly' rebuilds and pushes changes only when you manually initiate rebuild or push for the entire test harness. For more information, see Synchronize Changes Between Test Harness and Model.

Example: 'SynchronizationMode','SyncOnOpen'

Data Types: char

RebuildOnOpen — Sets the harness rebuild command to execute when the harness opens

false (default) | true

Option to have the harness rebuild when it opens, specified as the comma-separated pair consisting of 'UseDefaultName' and false or true.

Example: 'RebuildOnOpen',true

Data Types: logical

ExistingBuildFolder — Path to folder of existing generated code verified using SIL/PIL

string | character vector

Path to main build folder of existing generated code verified using SIL/PIL, specified as a string or character vector. If you specify a build folder, the existing code in that folder is used, which enables faster harness creation time. If you do not specify a build folder, the code is regenerated. You cannot set a default value for this property in an sl_customization file or using sltest.harness.setHarnessCreateDefaults.

Example: 'ExistingBuildFolder','C:\TestMdl\SILHarness\Amplifier_ert_rtw'

Data Types: string | char

RebuildModelData — Sets configuration set and model workspace entries to be updated during the test harness rebuild

false (default) | true

Option to have the configuration set and model workspace entries updated during test harness rebuild, specified as the comma-separated pair consisting of 'RebuildModelData' and true or false. This option is set to true for Subsystem model test harnesses.

Example: 'RebuildModelData',true

Data Types: logical

RebuildWithoutCompile — Sets the harness to rebuild without compiling the main model

false (default) | true

Option to rebuild the harness without compiling the main model, in which cached information from the most recent compile is used to update the test harness workspace, and conversion subsystems are not updated, specified as the comma-separated pair consisting of 'RebuildWithoutCompile' and true or false.

Example: 'RebuildWithoutCompile',true

PostRebuildCallback — Harness customization after rebuild

character vector

Use a post rebuild callback function to customize a test harness. The post rebuild callback function executes after the harness rebuild. For more information, see Customize Test Harnesses.

Example: 'PostRebuildCallback','HarnessCustomization'

FunctionInterfaceName — Name of the function interface to associate to the harness

string | character vector

Name of the function interface to associate with the harness, specified as a string or character vector. This option applies only to reusable library components with function interfaces.

Example: 'FunctionInterfaceName','double_RLS'

Version History

Introduced in R2015a