Extensions.DiagDataBrowsing.GetComChannelList

From emotive
Jump to navigation Jump to search

Classification

Name GetComChannelList
Short Description Return list of labels of all communication channels
Class Term
Extension OTX DiagDataBrowsing extension
Group DiagDataBrowsing terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm DiagDataBrowsing.GetComChannelList(ComChannelCategoriesTerm Category);

Description

GetComChannelList returns a list of strings containing the identifiers of all communication channels described in the diagnostic vehicle information data base.

If the optional attribute category is set, only those communication channel identifiers will be returned which belong to the given category.

Icons Note.png NOTE — In the case of a MVCI/ODX based system, the equivalent of a communication channel identifier will be the SHORT-NAME of a LOGICAL-LINK.

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 labels of all communication channels

Properties

Name Data Type Class Default Cardinality Description
Category ComChannelCategory Term - [0..1] This optional element specifies the category according to which the com channels will be filtered.

OTL Examples

/// Local Declarations

List<String> List1;

/// Flow

List1 = DiagDataBrowsing.GetComChannelList(@ComChannelCategories:BASE_VARIANT);

See also

GetEcuVariantList
GetDiagServiceList
GetRequestParameterList
GetResponseParameterList
GetAllowedParameterValueList