Difference between revisions of "Extensions.DiagDataBrowsing.GetComChannelList"
Jump to navigation
Jump to search
| (10 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{DISPLAYTITLE:OTX'''GetComChannelList'''}}[[Category:DiagDataBrowsing]] | + | {{DISPLAYTITLE:OTX '''GetComChannelList'''}}[[Category:DiagDataBrowsing]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetComChannelList | Return list of labels of all communication channels | [[Term]] | [[DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[DiagDataBrowsing terms]] | - | - }} | + | {{ClassificationActivity | GetComChannelList | Return list of labels of all communication channels | [[Term]] | [[Extensions.DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[Extensions.DiagDataBrowsing#Terms|DiagDataBrowsing terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ListTerm | + | ListTerm DiagDataBrowsing.GetComChannelList(ComChannelCategoriesTerm Category); |
</syntaxhighlight> | </syntaxhighlight> | ||
== 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 will 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 will 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}} | ||
| Line 16: | Line 20: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Category | [[Extensions.DiagDataBrowsing.ComChannelCategory|ComChannelCategory]] | [[Term]] | - | [0..1] | This optional element specifies the category according to which the com channels will be filtered.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
List<String> List1; | List<String> List1; | ||
| + | |||
| + | /// Flow | ||
List1 = DiagDataBrowsing.GetComChannelList(@ComChannelCategories:BASE_VARIANT); | List1 = DiagDataBrowsing.GetComChannelList(@ComChannelCategories:BASE_VARIANT); | ||
Latest revision as of 10:32, 12 September 2019
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(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.
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.
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
