Difference between revisions of "Extensions.DiagCom.GetFirstResult"

From emotive
Jump to navigation Jump to search
 
(2 intermediate revisions by one other user not shown)
Line 5: Line 5:
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
/// Local Declarations
+
ResultTerm DiagCom.GetFirstResult(DiagServiceTerm diagService);
DiagCom.Result ResultVariable;
 
/// Flow
 
ResultVariable = DiagCom.GetFirstResult(DiagServiceTerm);
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 19: Line 16:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie2| DiagService | [[Extensions.DiagCom.DiagService|DiagService]] | [[Term]] | - | [1] | Represents the '''DiagService''' object of which the first '''Result''' shall be returned.}}
+
{{TableRowPropertie2| DiagService | [[Extensions.DiagCom.DiagService|DiagService]] | [[Term]] | - | [1] | Represents the '''DiagService''' object of which the first '''Result''' will be returned.}}
 
|}
 
|}
  

Latest revision as of 10:12, 12 September 2019

Classification

Name GetFirstResult
Short Description Gets the first result of a service execution
Class Term
Extension OTX DiagCom extension
Group Result related terms
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ResultTerm DiagCom.GetFirstResult(DiagServiceTerm diagService);

Description

The GetFirstResult term returns the first result of a service execution, irrespective of whether there exists more than one result. The term accepts a DiagServiceTerm argument and returns a Result object.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Result The first result of the service execution.

Properties

Name Data Type Class Default Cardinality Description
DiagService DiagService Term - [1] Represents the DiagService object of which the first Result will be returned.

Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
DiagCom.Result Result1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu");
DiagCom.SetRepetitionTime(DiagService1, 5);
DiagCom.StartRepeatedExecution(DiagService1);
EventHandling.Sleep(50);
DiagCom.StopRepeatedExecution(DiagService1);
Result1 = DiagCom.GetFirstResult(DiagService1);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
SetRepetitionTime
StartRepeatedExecution
StopRepeatedExecution
GetAllResults
ExecuteDiagService