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

Sets the TestResult by actual numeric value within a defined tolerance range More...

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

Public Attributes

NumericTerm actualValue
 The actual value which shall be evaluated whether it is within the defined tolerance range. More...
 
NumericTerm lowerLimit
 The lower limit of the tolerance range. More...
 
TestResultStateVariable testResultState
 This optional element represents the TestResultState variable which shall receive the state of the evaluation. More...
 
NumericTerm upperLimit
 The upper limit of the tolerance range. 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 actual numeric value within a defined tolerance range

The SetToleranceTestResult activity to sets the TestResult of a TestResultContainer within a TestResultSession by evaluating whether an actual numeric value is within a defined tolerance range. It is possible to evaluate the actual value only against one limit.

The SetToleranceTestResult action has a special design. To compare an actualValue the author has the choice:

  • either to set the lower limit or the upper limit or
  • to set both limits. Like this, it is guaranteed that there is at least one limit which can be compared with the actualValue.
    The behavior is based on the IsGreatorOrEqual and IsLessOrEqual terms of the OTX Core, please refer to ISO 13209-2. It inherits its basic members from the abstract type SetTestResult.
    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.
    Core.Exceptions.OutOfBoundsException
Checker rules
CheckerRule.TestResultHandling_Chk003 - correct element types for properties map
CheckerRule.TestResultHandling_Chk006 - limit definition for SetToleranceTestResult
Syntax
TestResultHandling.SetToleranceTestResult(TestResultSessionTerm testResultSession, TestResultContainerTerm testResultContainer, NumericTerm actualValue, NumericTerm lowerLimit = NULL, NumericTerm upperLimit = NULL, TestResultStateVariable testResultState = NULL, TestResultSeverityTerm severity = @TestResultSeverity:TRACK, StringTerm description = "", MapTerm properties = NULL);
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
NumericTerm actualValue
The actual value which shall be evaluated whether it is within the defined tolerance range.
Definition: TestResultHandling.cs:1102
NumericTerm lowerLimit
The lower limit of the tolerance range.
Definition: TestResultHandling.cs:1122
NumericTerm upperLimit
The upper limit of the tolerance range.
Definition: TestResultHandling.cs:1132
TestResultStateVariable testResultState
This optional element represents the TestResultState variable which shall receive the state of the ev...
Definition: TestResultHandling.cs:1112
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.SetToleranceTestResult(TestResultSession1, TestResultContainer1, @TestResultSeverity:DEBUG, "abcdef", NULL, 10, TestResultState1, 0, 3);
TestResultHandling.CloseTestResultSession(TestResultSession1);
@ NOT_TESTED
The TestResultContainer has not been tested yet.This is the most critical state.

Member Data Documentation

◆ actualValue

NumericTerm OpenTestSystem.Otx.Extensions.TestResultHandling.Actions.SetToleranceTestResult.actualValue

The actual value which shall be evaluated whether it is within the defined tolerance range.

◆ lowerLimit

NumericTerm OpenTestSystem.Otx.Extensions.TestResultHandling.Actions.SetToleranceTestResult.lowerLimit

The lower limit of the tolerance range.

◆ testResultState

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

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

◆ upperLimit

NumericTerm OpenTestSystem.Otx.Extensions.TestResultHandling.Actions.SetToleranceTestResult.upperLimit

The upper limit of the tolerance range.