<< Click here to display Table of Contents >>

Reactive Code

Contents

The objects in the Reactive Code API are for use with Reactive Scenarios and TestCases.

Reactive Code is supported in releases 3.40 and higher.

Objects for Scenario API

Scenario Object

Example:

Scenario.Stop();

Methods
Stop()	Stops the Scenario and all its TestCases. Any running TestCases are stopped immediately, even if they are not complete.
Properties
PassFailState Note: To use the PassFailState in Reactive Code, Pass/Fail Analysis must be set to On-the-Fly in the Project Settings.	Returns the pass/fail state of the Scenario. Possible enumerated values are: •ScenarioPassFailState.IsPassing •ScenarioPassFailState.IsFailing •ScenarioPassFailState.Unknown

The Scenario tab of the Reactive Code dialog also includes an Insert Breakpoint construct that can be used for debugging reactive code.

RC-breakpoint

Objects for TestCase API

TestCase Object

The TestCase object is used in the Reactive TestCase API. Example:

status = TestCasePassFailState;

Methods
Stop()	Stops the TestCase and marks it complete. Scenario execution continues.
Properties
TestCasePassFailState Note: To use the TestCasePassFailState in Reactive Code, Pass/Fail Analysis must be set to On-the-Fly in the Project Settings.	Returns the pass/fail state of the TestCase. Possible enumerated values are: •TestCasePassFailState.IsPassing •TestCasePassFailState.IsFailing •TestCasePassFailState.Unknown
time	In the Test Complete code tab, returns the time the TestCase completed, in milliseconds. In the Tick tab, returns the current time, in milliseconds.
UserData	Returns the object passed in from the Scenario. This is a data only object. Possible types are numerics, byte arrays, Booleans, .Net objects

Common API Objects

<TestCase> Object

Example:

Veh_Speed_RPM.Start(5);

Methods
Start()	Starts the TestCase
Start(object UserData)	Starts the TestCase with the specified UserData object. Possible types are numerics, byte arrays, Boolean's, .Net objects
Start(object UserData, string)	Starts the TestCase with the specified UserData object and a comment string. If included, the comment string is displayed in the title bar of the TestCase as shown here: Three Jobs with Comment Strings Marked
Stop()	Stops the TestCase
Properties
Description	Returns the TestCase Description from the TestCase properties.
Duration	Returns the Test Duration from the TestCase properties in milliseconds.
ExecutionState	Returns the execution state of the TestCase (Completed, IsRunning, NotRun)
Name	Returns the TestCase Name from the TestCase properties.
PassFailState Note: To use the PassFailState in Reactive Code, Pass/Fail Analysis must be set to On-the-Fly in the Project Settings.	Returns the pass/fail state of the TestCase. Possible enumerated values are: •TestCasePassFailState.Passed •TestCasePassFailState.Failed •TestCasePassFailState.IsPassing •TestCasePassFailState.IsFailing •TestCasePassFailState.Unknown

Example: Branching

This example shows branching in a Scenario based on the results of a TestCase. This code is from the TestCase Complete tab of a Reactive Scenario. See Reactive Variants sample.

if(TestCaseA.PassFailState == TestCasePassFailState.Passed) {

TestCaseB.Start(1, "Passed");

Scenario.Stop(); }

if(TestCaseA.PassFailState == TestCasePassFailState.Failed) {

TestCaseC.Start(1, "Failed");

Scenario.Stop(); }

else {

TestCaseB.Start(1, "Unknown");

Scenario.Stop(); }

<NumericSignal> Object

Used for both continuous and discrete numeric Signals.

Example:

if(UserPedalPercent.Value <0) UserPedalPercent.Value = 0;

Method
SetNull()*	Sets the value of the input Signal to null at the current time.
SetExpectedNull()**	Sets the expected value of the Signal to null at the current time. (This method is available for Response Signals only and only if the Signal is reactive.)
Properties
Value*	Gets or sets the current value of the Signal. (In TestCases, this value can only be set if the signal is reactive i.e. not predefined like traditional stimulus Signals.)
ExpectedValue**	Gets or sets the current expected value (This property is available for Response Signals only. You can only write if the Signal is checked.)
HasValue	Read-only Boolean value. True if the Signal has a value at the current time.
HasExpectedValue	Read-only Boolean value. True if the Signal has an expected value at the current time. This property is available for Response Signals only.

* Setting the value is only available to stimulus Signals.

** Setting the expected value is only available for Signals not in the TestCase or in the TestCase and reactive.

<MessageSignal> Object

Example:

MessageSignal.Value = new byte[] {1,2,3,4};

Properties
ExpectedValue**	Gets or sets the current expected value of the message. (This property is available for Response Signals only in the TestCase API. You can only write if the Signal is checked.)
HasExpectedValue	Read-only Boolean value. True if the Signal has a value at the current time. This property is available for Response Signals only.
Has Value	Read-only Boolean value. True if the Signal has an expected value at the current time.
Value*	Gets or sets the current actual value of the message Signal
<FieldName>	Returns an object representing the message field
<FieldName>.Value*	Gets or sets the current actual value of the message field
<FieldName>.ExpectedValue**	Gets or sets the current expected value of the message field (This property is available for Response Signals only. You can only write if the Signal is checked.)

* Setting the value is only available to stimulus Signals not in the TestCase or in the TestCase and reactive.

** Setting the expected value is only available for response Signals not in the TestCase or in the TestCase and reactive.

<TaskSignal> Object

Methods
Transmit(parameters)	Transmits the task transition with the specified parameters

<Constant> Object

Example:

emf = VOLTAGE.Value;

Properties
Value	Gets the current value of the constant. Read only.

Tags Object

Example:

Tags.MyGroup.MyTag.Activate();

API Syntax
Tags.Groups	Returns an iterable collection of the tag groups
Tags.Revert()	Reverts changes made to the object's tags
Tags.<GroupName>	Provides access to a specific tag group
Tags.<GroupName>.ActiveTags	Returns an iterable collection of the group's active tags
Tags.<GroupName>.Tags	Returns an iterable collection of the group's tags
Tags.<GroupName>.<TagName>	Provides access to a specific tag
Tags.<GroupName>.<TagName>.IsActive	True if this tag is active, otherwise false (Readonly)
Tags.<GroupName>.<TagName>.Activate()	Activates the tag and returns a value indicating if the activation was successful. Example: Tags.GainSweep.Low.Activate();
Tags.<GroupName>.<TagName>.Deactivate()	Deactivates this tag and returns a value indicating if the deactivation was successful

Tags refers to the object within the scope of its calling. A Scenario inherits its tags from the project, and there is no carry over once the Scenario is closed. A TestCase inherits its tags from the Scenario, and there is no carry over once the TestCase is finished.

Iterating through groups (deactivate all active tags):

foreach(TagGroupHandler group in Tags.Groups)

{

foreach(TagHandler tag in group.ActiveTags)

{

If(tag.IsActive)

{

tag.Deactivate();

}

Access a specific tag:

Tags.MyGroup.MyTag.Activate();

Iterate through tags (Get reference of a group’s active tag and deactivate it):

TagGroupTagHandler tagHandler = null;

foreach( TagGroupTagHandler tag in Tags.MyGroup.Tags)

{

If(tag.IsActive)

{

tagHandler = tag;

}

If( tagHandler != null )

{

tagHandler.Deactivate();

}

Reactive Code

Iterating through groups (deactivate all active tags):

Access a specific tag:

Iterate through tags (Get reference of a group’s active tag and deactivate it):

Related Topics: