Difference between revisions of "Extensions.DiagDataBrowsing.GetComChannelList"
Jump to navigation
Jump to search
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | '''GetComChannelList''' | + | '''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 shall be returned which belong to the given category. | ||
| + | |||
| + | {{Note|NOTE — In the case of a MVCI/ODX based system, the equivalent of a communication channel identifier shall be the SHORT-NAME of a LOGICAL-LINK.}} | ||
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | Return list of labels of all communication channels}} | {{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | Return list of labels of all communication channels}} | ||
Revision as of 04:24, 26 September 2018
Contents
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(ComChannelCategories);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 shall be returned which belong to the given category.
NOTE — In the case of a MVCI/ODX based system, the equivalent of a communication channel identifier shall be the SHORT-NAME of a LOGICAL-LINK.
Return Value
The Term returns the value, see table below.
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 | Value | - | [0..1] | This optional attribute are the categories into which the returned list will be filtered. |
OTL Examples
List<String> List1;
List1 = DiagDataBrowsing.GetComChannelList(@ComChannelCategories:BASE_VARIANT);See also
GetEcuVariantList
GetDiagServiceList
GetRequestParameterList
GetResponseParameterList
GetAllowedParameterValueList
