Difference between revisions of "Extensions.DiagCom.GetComChannelEcuVariantName"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''GetComChannelEcuVariantName '''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX '''GetComChannelEcuVariantName '''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetComChannelEcuVariantName | | + | {{ClassificationActivity | GetComChannelEcuVariantName | Returns the name of the ECU variant associated | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|ComChanel related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | + | The '''GetComChannelEcuVariantName''' term accepts a handle of a communication channel and returns the name of the ECU variant associated with that channel. For instance, this term can be used to determine the identified ECU variant after having used the [[Extensions.DiagComIdentifyAndSelectVariant|IdentifyAndSelectVariant]] action. In case the base variant is selected, an empty string shall be returned. | |
| − | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the name of the ECU variant. }} | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the name of the ECU variant.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' yields the handle of the communication channel of which the identifier shall be returned.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | DiagCom.ComChannel | + | DiagCom.ComChannel ComChannel1; |
| − | String | + | String EcuVariantName1 = ""; |
| − | + | /// Flow | |
| − | + | ||
| − | + | ComChannel1 = DiagCom.GetComChannel("LL_EnginContrModul1UDS", "", false); | |
| + | EcuVariantName1 = DiagCom.GetComChannelEcuVariantName(ComChannel1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 11:52, 11 October 2018
Contents
Classification
| Name | GetComChannelEcuVariantName |
| Short Description | Returns the name of the ECU variant associated |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | ComChanel related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
StringTerm = DiagCom.GetComChannelEcuVariantName(ComChannelTerm);
Description
The GetComChannelEcuVariantName term accepts a handle of a communication channel and returns the name of the ECU variant associated with that channel. For instance, this term can be used to determine the identified ECU variant after having used the IdentifyAndSelectVariant action. In case the base variant is selected, an empty string shall be returned.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| String | Returns the name of the ECU variant. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ComChannel | ComChannel | Term | - | [1] | The ComChannelTerm yields the handle of the communication channel of which the identifier shall be returned. |
OTL Examples
DiagCom.ComChannel ComChannel1;
String EcuVariantName1 = "";
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_EnginContrModul1UDS", "", false);
EcuVariantName1 = DiagCom.GetComChannelEcuVariantName(ComChannel1);
