Difference between revisions of "Extensions.DiagCom.GetDiagServiceFromResult"

From emotive
Jump to navigation Jump to search
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''GetDiagServiceFromResult'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDiagServiceFromResult | Diagnostic service, is assigned to the Result object | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[DiagService related terms]] | [[InvalidReferenceException]] | - }}
+
{{ClassificationActivity | GetDiagServiceFromResult | Gets the handle of the Diagnostic service from a Result | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|DiagService related terms]] | [[Core.DataTypes.ComplexDataType.InvalidReferenceException|InvalidReferenceException]] | - }}
  
−
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
GetDiagServiceFromResult(Result resultEcu, DiagService result);
+
DiagServiceTerm DiagCom.GetDiagServiceFromResult(ResultTerm result);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetDiagServiceNameFromResult''' term returns the diagnostic service that is assigned to the [[Result]] object.
+
The '''GetDiagServiceNameFromResult''' term accepts a '''ResultTerm''' and will return the handle of the [[Extensions.DiagCom.DiagService|DiagService]] the Result belongs to.
  
−
{{TermReturnValue| [[DiagService]] | Diagnostics Service.}}
+
{{TermReturnValue| [[Extensions.DiagCom.DiagService|DiagService]] | The handle of the Diagnostic service}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ResultEcu | [[Result]] | [[Term]] | - | [1] | Result object.}}
+
{{TableRowPropertie2| Result | [[Extensions.DiagCom.Result|Result]] | [[Term]] | - | [1] | Specifies the '''Result''' for which the containing '''DiagService''' name will be retrieved.}}
 
|}
 
|}
  
−
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagService result = GetDiagServiceFromResult(resultVariable, "DiagServiceName");
+
/// Local Declarations
 +
 
 +
DiagCom.Result Result1;
 +
DiagCom.DiagService DiagService1;
 +
DiagCom.ComChannel ComChannel1;
 +
 
 +
/// Flow
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false);
 +
[#MetaData(RequestPdu), <#Data>22 F1 A2</#Data>]
 +
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentASAMODXFileVersi"), {}, {}, Result1, NULL, false, false);
 +
DiagService1 = DiagCom.GetDiagServiceFromResult(Result1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[CreateDiagServiceBySemantic]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
−
[[GetDiagServiceListBySemantic]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
−
[[GetDiagServiceFromException]] <br/>
+
[[Extensions.DiagCom.GetDiagServiceListBySemantic|GetDiagServiceListBySemantic]] <br/>
−
[[GetDiagServiceName]] <br/>
+
[[Extensions.DiagCom.GetDiagServiceFromException|GetDiagServiceFromException]] <br/>
−
[[ExecuteDiagService]] <br/>
+
[[Extensions.DiagCom.GetDiagServiceName|GetDiagServiceName]] <br/>
−
[[GetComChannel]]
+
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]]

Latest revision as of 10:11, 12 September 2019

Classification

Name GetDiagServiceFromResult
Short Description Gets the handle of the Diagnostic service from a Result
Class Term
Extension OTX DiagCom extension
Group DiagService related terms
Exceptions InvalidReferenceException
Checker Rules -
Standard Compliant Yes

OTL Syntax

DiagServiceTerm DiagCom.GetDiagServiceFromResult(ResultTerm result);

Description

The GetDiagServiceNameFromResult term accepts a ResultTerm and will return the handle of the DiagService the Result belongs to.

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
DiagService The handle of the Diagnostic service

Properties

Name Data Type Class Default Cardinality Description
Result Result Term - [1] Specifies the Result for which the containing DiagService name will be retrieved.

OTL Examples

/// Local Declarations

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

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false);
[#MetaData(RequestPdu), <#Data>22 F1 A2</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentASAMODXFileVersi"), {}, {}, Result1, NULL, false, false);
DiagService1 = DiagCom.GetDiagServiceFromResult(Result1);

See also

CreateDiagServiceBySemantic
CreateDiagServiceByName
GetDiagServiceListBySemantic
GetDiagServiceFromException
GetDiagServiceName
ExecuteDiagService
GetComChannel

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagCom.GetDiagServiceFromResult&oldid=9674"