Difference between revisions of "Extensions.DiagCom.GetDiagServiceListBySemantic"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''GetDiagServiceListBySemantic'''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX '''GetDiagServiceListBySemantic'''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetDiagServiceListBySemantic | | + | {{ClassificationActivity | GetDiagServiceListBySemantic | Returns a list of Diagnostic Services with the same semantic attribute | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|DiagService related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The '''GetDiagServiceListBySemantic''' term | + | The '''GetDiagServiceListBySemantic''' term returns a complete list of all [[Extensions.DiagCom.DiagService|DiagService]] handles which have the same semantic. This is required in case more than one service with the same semantic attribute value exists within the data set associated with the [[Extensions.DiagCom.ComChannel|ComChannel]]. |
| − | {{TermReturnValue| [[Core.DataTypes.ComplexDataType | + | {{TermReturnValue| [[Core.DataTypes.ComplexDataType.List|List]] | List of of all [[Extensions.DiagCom.DiagService|DiagService]] handles.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' that shall be queried for all the services with the given semantic.}} |
| − | {{TableRowPropertie2| Semantic | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | | + | {{TableRowPropertie2| Semantic | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The semantic value of the '''DiagServices''' to be returned (eg: "DEFAULT_FAULTREAD" or "IDENTIFICATION").}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | |||
List<DiagCom.DiagService> List1; | List<DiagCom.DiagService> List1; | ||
| + | DiagCom.ComChannel ComChannel1; | ||
| − | + | /// Flow | |
| − | List1 = DiagCom.GetDiagServiceListBySemantic( | + | |
| + | ComChannel1 = DiagCom.GetComChannel("LL_AllUDSSyste", "", false); | ||
| + | List1 = DiagCom.GetDiagServiceListBySemantic(ComChannel1, "CALIBRATIONREAD"); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | |||
[[Extensions.DiagCom.GetDiagServiceFromResult|GetDiagServiceFromResult]] <br/> | [[Extensions.DiagCom.GetDiagServiceFromResult|GetDiagServiceFromResult]] <br/> | ||
[[Extensions.DiagCom.GetDiagServiceFromException|GetDiagServiceFromException]] <br/> | [[Extensions.DiagCom.GetDiagServiceFromException|GetDiagServiceFromException]] <br/> | ||
Revision as of 03:11, 12 October 2018
Contents
Classification
| Name | GetDiagServiceListBySemantic |
| Short Description | Returns a list of Diagnostic Services with the same semantic attribute |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | DiagService related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
ListTerm = DiagCom.GetDiagServiceListBySemantic(ComChannelTerm, StringTerm);Description
The GetDiagServiceListBySemantic term returns a complete list of all DiagService handles which have the same semantic. This is required in case more than one service with the same semantic attribute value exists within the data set associated with the ComChannel.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| List | List of of all DiagService handles. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ComChannel | ComChannel | Term | - | [1] | The ComChannelTerm that shall be queried for all the services with the given semantic. |
| Semantic | String | Term | - | [1] | The semantic value of the DiagServices to be returned (eg: "DEFAULT_FAULTREAD" or "IDENTIFICATION"). |
OTL Examples
List<DiagCom.DiagService> List1;
DiagCom.ComChannel ComChannel1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_AllUDSSyste", "", false);
List1 = DiagCom.GetDiagServiceListBySemantic(ComChannel1, "CALIBRATIONREAD");See also
GetDiagServiceFromResult
GetDiagServiceFromException
GetDiagServiceName
ExecuteDiagService
GetComChannel
