Difference between revisions of "Extensions.DiagCom.CreateDiagServiceByName"
Jump to navigation
Jump to search
| (4 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''CreateDiagServiceByName'''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX '''CreateDiagServiceByName'''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | CreateDiagServiceByName | Creates a diagnostic service | + | {{ClassificationActivity | CreateDiagServiceByName | Creates a handle to a diagnostic service | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|DiagService related terms]] | [[Extensions.DiagCom.UnknownTargetException|UnknownTargetException]] | [[Extensions.DiagCom.DiagComChk100|DiagCom_Chk100]]<br/>[[Extensions.DiagCom.DiagComChk101|DiagCom_Chk101]]<br/>[[Extensions.DiagCom.DiagComChk102|DiagCom_Chk102]] }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | DiagServiceTerm | + | DiagServiceTerm DiagCom.CreateDiagServiceByName(ComChannelTerm comChannel, StringTerm name); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''CreateDiagServiceByName''' term creates a handle to a diagnostic service | + | The '''CreateDiagServiceByName''' term creates a handle to a diagnostic service that can subsequently be used for parameterizing or executing that service. The diagnostic service to be created is identified by its name. The '''CreateDiagServiceByName''' term accepts a '''ComChannelTerm''' and the name of the desired diagnostic service as an '''otx:StringTerm'''. As a result the term returns a DiagService handle. |
| − | {{TermReturnValue| [[ | + | {{Note|In case a MVCI/ODX system is used, the name passed into the '''CreateDiagServiceByName''' term will be the '''SHORT-NAME''' of the associated '''MCDDiagComPrimitive''' object.}} |
| + | |||
| + | {{TermReturnValue| [[Extensions.DiagCom.DiagService|DiagService]] | The handle to a diagnostic service.}} | ||
== 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| Name | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Name | + | {{TableRowPropertie2| Name | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | Name of the to-be-created diagnostic service.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | /// Local Declarations | |
| + | |||
DiagCom.DiagService DiagService1; | DiagCom.DiagService DiagService1; | ||
| + | DiagCom.ComChannel ComChannel1; | ||
| + | |||
| + | /// Flow | ||
| − | + | ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false); | |
| − | DiagService1 = DiagCom.CreateDiagServiceByName( | + | DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_WriteMemorByAddreMCD20001"); |
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 10:08, 12 September 2019
Contents
Classification
| Name | CreateDiagServiceByName |
| Short Description | Creates a handle to a diagnostic service |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | DiagService related terms |
| Exceptions | UnknownTargetException |
| Checker Rules | DiagCom_Chk100 DiagCom_Chk101 DiagCom_Chk102 |
| Standard Compliant | Yes |
OTL Syntax
DiagServiceTerm DiagCom.CreateDiagServiceByName(ComChannelTerm comChannel, StringTerm name);Description
The CreateDiagServiceByName term creates a handle to a diagnostic service that can subsequently be used for parameterizing or executing that service. The diagnostic service to be created is identified by its name. The CreateDiagServiceByName term accepts a ComChannelTerm and the name of the desired diagnostic service as an otx:StringTerm. As a result the term returns a DiagService handle.
In case a MVCI/ODX system is used, the name passed into the CreateDiagServiceByName term will be the SHORT-NAME of the associated MCDDiagComPrimitive object.
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 handle to a diagnostic service. |
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. |
| Name | String | Term | - | [1] | Name of the to-be-created diagnostic service. |
OTL Examples
/// Local Declarations
DiagCom.DiagService DiagService1;
DiagCom.ComChannel ComChannel1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_WriteMemorByAddreMCD20001");See also
CreateDiagServiceBySemantic
GetDiagServiceListBySemantic
GetDiagServiceFromResult
GetDiagServiceFromException
GetDiagServiceName
ExecuteDiagService
GetComChannel
