Difference between revisions of "Extensions.DiagCom.GetComChannelEcuVariantName"

From emotive
Jump to navigation Jump to search
Line 5: Line 5:
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
/// Local Declarations
 
String StringVariable = "";
 
String StringVariable = "";
 +
/// Flow
 
StringVariable = DiagCom.GetComChannelEcuVariantName(ComChannelTerm);
 
StringVariable = DiagCom.GetComChannelEcuVariantName(ComChannelTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 24: Line 26:
 
== 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.ComChannel ComChannel1;
 
DiagCom.ComChannel ComChannel1;
 
String EcuVariantName1 = "";
 
String EcuVariantName1 = "";

Revision as of 12:05, 23 October 2018

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

/// Local Declarations
String StringVariable = "";
/// Flow
StringVariable = 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.

Icons Note.png In case a MVCI/ODX system is used the term shall 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.

Icons Note.png 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

/// Local Declarations

DiagCom.ComChannel ComChannel1;
String EcuVariantName1 = "";

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_EnginContrModul1UDS", "", false);
EcuVariantName1 = DiagCom.GetComChannelEcuVariantName(ComChannel1);

See also

GetComChannelIdentifierFromResponse
GetComChannel
IsVariant