OTX Reference  
OpenTestSystem.Otx.Extensions.TestResultHandling.Actions.SetDtcTestResult Class Reference

Sets the TestResult by a list of diagnostic trouble codes (DTC’s) More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.TestResultHandling.Actions.SetDtcTestResult:
Inheritance graph

Public Attributes

ListTerm diagnosticTroubleCodes
 A list of DTC's which shall be evaluated. The elements of the list shall be only of otx:CountableType. More...
 
ListTerm ignoredDiagnosticTroubleCodes
 An optional list of DTC's which shall be ignored for the evaluation. The elements of the list shall be only of otx:CountableType. More...
 
TestResultStateVariable testResultState
 This optional element represents the TestResultState variable which shall receive the state of the evaluation. More...
 
- Public Attributes inherited from OpenTestSystem.Otx.Extensions.TestResultHandling.Actions.SetTestResult
StringTerm description
 This optional element can be used for a textual description of the test result. More...
 
MapTerm properties
 This optional element can be used for setting properties of the test result (e.g. a print condition, an identifier for forwarding the result value to a downstream IT system). The keys and values of the map shall be only of otx:CountableType. More...
 
TestResultSeverityTerm severity
 This element represents the TestResultSeverity of the test result. More...
 
TestResultContainerTerm testResultContainer
 The TestResultContainer which shall receive the test result. More...
 
TestResultSessionTerm testResultSession
 The TestResultSession in which the test results are to be handled. More...
 
- Public Attributes inherited from OpenTestSystem.Otx.Core.Actions.ActionRealisation
OtxLink validFor
 Cardinality [0..1]
Validity of ActionRealisation. More...
 

Detailed Description

Sets the TestResult by a list of diagnostic trouble codes (DTC’s)

The SetDtcTestResult activity to sets the result of a TestResultContainer within a TestResultSession by evaluating a list of diagnostic trouble codes (DTC’s). It is possible to define DTC's which are to be ignored for the evaluation. If a DTC exists in the diagnosticTroubleCodes list which is not included in the ignoredDiagnosticTroubleCodes list, the TestResultState shall be NOT_OK.

Exceptions
Exceptions.TestResultContainerExceptionIf the TestResultContainer is a parent TestResultContainer with child TestResultContainers.
Exceptions.TestResultExceptionIf a test result value element is not valid for the test result handling framework, e.g. the data size of the actual value is too large.
Checker rules
CheckerRule.TestResultHandling_Chk001 - type safe list comparison
CheckerRule.TestResultHandling_Chk002 - correct list type for DTC's list
CheckerRule.TestResultHandling_Chk003 - correct element types for properties map
Syntax
TestResultHandling.SetDtcTestResult(TestResultSessionTerm testResultSession, TestResultContainerTerm testResultContainer, ListTerm diagnosticTroubleCodes, ListTerm ignoredDiagnosticTroubleCodes = NULL, TestResultStateVariable testResultState = NULL, TestResultSeverityTerm severity = @TestResultSeverity:TRACK, StringTerm description = "", MapTerm properties = NULL);
ListTerm ignoredDiagnosticTroubleCodes
An optional list of DTC's which shall be ignored for the evaluation. The elements of the list shall b...
Definition: TestResultHandling.cs:1498
ListTerm diagnosticTroubleCodes
A list of DTC's which shall be evaluated. The elements of the list shall be only of otx:CountableType...
Definition: TestResultHandling.cs:1488
TestResultStateVariable testResultState
This optional element represents the TestResultState variable which shall receive the state of the ev...
Definition: TestResultHandling.cs:1508
TestResultSessionTerm testResultSession
The TestResultSession in which the test results are to be handled.
Definition: TestResultHandling.cs:883
TestResultSeverityTerm severity
This element represents the TestResultSeverity of the test result.
Definition: TestResultHandling.cs:905
MapTerm properties
This optional element can be used for setting properties of the test result (e.g. a print condition,...
Definition: TestResultHandling.cs:925
StringTerm description
This optional element can be used for a textual description of the test result.
Definition: TestResultHandling.cs:915
TestResultContainerTerm testResultContainer
The TestResultContainer which shall receive the test result.
Definition: TestResultHandling.cs:893
Examples
// Local Declarations
TestResultHandling.TestResultSession TestResultSession1;
TestResultHandling.TestResultContainer TestResultContainer1;
TestResultHandling.TestResultState TestResultState1 = @TestResultState:NOT_TESTED;
// Flow
TestResultSession1 = TestResultHandling.GetTestResultSession("emotive", "244");
TestResultContainer1 = TestResultHandling.GetTestResultContainerByName(TestResultCon2);
TestResultHandling.SetDtcTestResult(TestResultSession1, TestResultContainer1, NULL, NULL, NULL, {""}, NULL, TestResultState1);
TestResultHandling.CloseTestResultSession(TestResultSession1);
@ NOT_TESTED
The TestResultContainer has not been tested yet.This is the most critical state.

Member Data Documentation

◆ diagnosticTroubleCodes

ListTerm OpenTestSystem.Otx.Extensions.TestResultHandling.Actions.SetDtcTestResult.diagnosticTroubleCodes

A list of DTC's which shall be evaluated. The elements of the list shall be only of otx:CountableType.

◆ ignoredDiagnosticTroubleCodes

ListTerm OpenTestSystem.Otx.Extensions.TestResultHandling.Actions.SetDtcTestResult.ignoredDiagnosticTroubleCodes

An optional list of DTC's which shall be ignored for the evaluation. The elements of the list shall be only of otx:CountableType.

◆ testResultState

TestResultStateVariable OpenTestSystem.Otx.Extensions.TestResultHandling.Actions.SetDtcTestResult.testResultState

This optional element represents the TestResultState variable which shall receive the state of the evaluation.