Difference between revisions of "Extensions.DiagCom.CreateDiagServiceBySemantic"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''CreateDiagServiceBySemantic'''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX '''CreateDiagServiceBySemantic'''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | CreateDiagServiceBySemantic | Creates a diagnostic service through its semantic attribute | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[DiagService related terms]] | [[ | + | {{ClassificationActivity | CreateDiagServiceBySemantic | Creates a diagnostic service through its semantic attribute | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|DiagService related terms]] | [[Extensions.DiagCom.AmbiguousSemanticException|AmbiguousSemanticException]] | [[Extensions.DiagCom.DiagComChk100|DiagCom_Chk100]]<br/>[[Extensions.DiagCom.DiagComChk101|DiagCom_Chk101]]<br/>[[Extensions.DiagCom.DiagComChk102|DiagCom_Chk102]] }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The '''CreateDiagServiceBySemantic''' term creates a handle to a diagnostic service | + | The '''CreateDiagServiceBySemantic''' term creates a handle to a diagnostic service that can subsequently be used for configuring or executing that service. The diagnostic service to be created is identified by its semantic attribute. The term accepts a '''ComChannelTerm''' and the semantic value as an '''otx:StringTerm'''. As a result the term returns a [[Core.DataTypes.ComplexDataType.DiagService|DiagService]] handle. Please note that using this term can result in an [[Extensions.DiagCom.AmbiguousSemanticException|AmbiguousSemanticException]] in case more than one diagnostic service with the desired semantic attribute value exists within this communication channel. |
| − | {{TermReturnValue| [[ | + | {{Note|The ability to assign a semantic value to a diagnostic service or service parameter allows applications working with diagnostic data to access functionality in a manner more abstract than directly pointing to specific names of services/parameters.}} |
| + | |||
| + | {{TermReturnValue| [[Extensions.DiagCom.DiagService|DiagService]] | The diagnostic service is created through its semantic attribute.}} | ||
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' to which the to-be-created diagnostic service belongs to and will be executed on when the '''ExecuteDiagService''' action is used.}} |
| − | {{TableRowPropertie2| Semantic | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | | + | {{TableRowPropertie2| Semantic | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The semantic value of the to-be-created diagnostic service. (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;"> | ||
| − | |||
DiagCom.DiagService DiagService1; | DiagCom.DiagService DiagService1; | ||
| + | DiagCom.ComChannel ComChannel1; | ||
| + | |||
| + | /// Flow | ||
| − | + | ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false); | |
| − | DiagService1 = DiagCom.CreateDiagServiceBySemantic( | + | DiagService1 = DiagCom.CreateDiagServiceBySemantic(ComChannel1, "DEFAULT-FAULT-READ"); |
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 02:56, 12 October 2018
Contents
Classification
| Name | CreateDiagServiceBySemantic |
| Short Description | Creates a diagnostic service through its semantic attribute |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | DiagService related terms |
| Exceptions | AmbiguousSemanticException |
| Checker Rules | DiagCom_Chk100 DiagCom_Chk101 DiagCom_Chk102 |
| Standard Compliant | Yes |
OTL Syntax
DiagServiceTerm = DiagCom.CreateDiagServiceBySemantic(ComChanneTerm, StringTerm);Description
The CreateDiagServiceBySemantic term creates a handle to a diagnostic service that can subsequently be used for configuring or executing that service. The diagnostic service to be created is identified by its semantic attribute. The term accepts a ComChannelTerm and the semantic value as an otx:StringTerm. As a result the term returns a DiagService handle. Please note that using this term can result in an AmbiguousSemanticException in case more than one diagnostic service with the desired semantic attribute value exists within this communication channel.
The ability to assign a semantic value to a diagnostic service or service parameter allows applications working with diagnostic data to access functionality in a manner more abstract than directly pointing to specific names of services/parameters.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| DiagService | The diagnostic service is created through its semantic attribute. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ComChannel | ComChannel | Term | - | [1] | The ComChannelTerm to which the to-be-created diagnostic service belongs to and will be executed on when the ExecuteDiagService action is used. |
| Semantic | String | Term | - | [1] | The semantic value of the to-be-created diagnostic service. (eg: "DEFAULT_FAULTREAD" or "IDENTIFICATION"). |
OTL Examples
DiagCom.DiagService DiagService1;
DiagCom.ComChannel ComChannel1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
DiagService1 = DiagCom.CreateDiagServiceBySemantic(ComChannel1, "DEFAULT-FAULT-READ");See also
GetDiagServiceListBySemantic
GetDiagServiceFromResult
GetDiagServiceFromException
GetDiagServiceName
ExecuteDiagService
GetComChannel
