Difference between revisions of "Extensions.DiagCom.GetComChannelEcuVariantName"
Jump to navigation
Jump to search
m (Hb moved page GetComChannelEcuVariantName to Extensions.DiagCom.GetComChannelEcuVariantName: #3153) |
|||
| (9 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[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 == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | StringTerm | + | StringTerm DiagCom.GetComChannelEcuVariantName(ComChannelTerm comChannel); |
</syntaxhighlight> | </syntaxhighlight> | ||
== 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.DiagCom.IdentifyAndSelectVariant|IdentifyAndSelectVariant]] action. In case the base variant is selected, an empty string will be returned. | |
| − | {{TermReturnValue| [[String]] | Returns the name of the ECU variant. }} | + | {{Note|In case a MVCI/ODX system is used the term will return the '''SHORT-NAME''' of the '''MCDDbEcuVariant''' associated with the logical link represented by the '''ComChannel'''.}} |
| + | |||
| + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the name of the ECU variant.}} | ||
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' yields the handle of the communication channel of which the identifier will 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 | + | /// Local Declarations |
| − | String | + | |
| + | DiagCom.ComChannel ComChannel1; | ||
| + | String EcuVariantName1 = ""; | ||
| + | |||
| + | /// Flow | ||
| − | + | ComChannel1 = DiagCom.GetComChannel("LL_EnginContrModul1UDS", "", false); | |
| − | + | EcuVariantName1 = DiagCom.GetComChannelEcuVariantName(ComChannel1); | |
| − | |||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetComChannelIdentifierFromResponse]] <br/> | + | [[Extensions.DiagCom.GetComChannelIdentifierFromResponse|GetComChannelIdentifierFromResponse]] <br/> |
| − | [[GetComChannel]] <br/> | + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> |
| − | [[IsVariant]] | + | [[Extensions.DiagCom.IsVariant|IsVariant]] |
Latest revision as of 12:06, 12 September 2019
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 comChannel);
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 will be returned.
In case a MVCI/ODX system is used the term will return the SHORT-NAME of the MCDDbEcuVariant associated with the logical link represented by 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 |
| 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 will be returned. |
OTL Examples
/// Local Declarations
DiagCom.ComChannel ComChannel1;
String EcuVariantName1 = "";
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_EnginContrModul1UDS", "", false);
EcuVariantName1 = DiagCom.GetComChannelEcuVariantName(ComChannel1);
