Extensions.DiagDataBrowsing.GetEcuVariantList

From emotive
Jump to navigation Jump to search

Classification

Name GetEcuVariantList
Short Description Return list of names of all ECU variants of a communication channel
Class Term
Extension OTX DiagDataBrowsing extension
Group DiagDataBrowsing terms
Exceptions TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm DiagDataBrowsing.GetEcuVariantList(ComChannelTerm ComChannel);

Description

GetEcuVariantList will return a list of strings which represents the names of all ECU variants for a given communication channel. The channel will either point to a base variant or an ECU variant – in both cases, the names of the ECU variants of the base variant will be returned. If a base variant has no associated ECU variants, an empty list will be returned.

If the communication channel belongs to the category PROTOCOL or FUNCTIONAL_GROUP, the TypeMismatchException exception will be thrown.

Icons Note.png NOTE — In the case of a MVCI/ODX based system, the equivalent of a variant name will be the SHORT-NAME of an ECU-VARIANT.

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
List Return list of names of all ECU variants of a communication channel

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [1] This element represents the communication channel which provides the data.

OTL Examples

/// Local Declarations

List<String> List1;
DiagCom.ComChannel ComChannel1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false);
List1 = DiagDataBrowsing.GetEcuVariantList(ComChannel1);

See also

GetComChannelList
GetDiagServiceList
GetRequestParameterList
GetResponseParameterList
GetAllowedParameterValueList