Difference between revisions of "Extensions.DiagDataBrowsing.GetEcuVariantList"
Jump to navigation
Jump to search
m (Hb moved page GetEcuVariantList to Extensions.DiagDataBrowsing.GetEcuVariantList: #3153) |
|||
| (9 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:DiagDataBrowsing]] | + | {{DISPLAYTITLE:OTX '''GetEcuVariantList'''}}[[Category:DiagDataBrowsing]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetEcuVariantList | Return list of names of all ECU variants of a communication channel | [[Term]] | [[DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[DiagDataBrowsing terms]] | [[TypeMismatchException]] | - }} | + | {{ClassificationActivity | GetEcuVariantList | Return list of names of all ECU variants of a communication channel | [[Term]] | [[Extensions.DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[Extensions.DiagDataBrowsing#Terms|DiagDataBrowsing terms]] | [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]] | - }} |
== 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.GetEcuVariantList(ComChannelTerm ComChannel); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''GetEcuVariantList''' | + | '''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. |
| − | {{TermReturnValue| [[List]] | Return list of names of all ECU variants of a communication channel}} | + | If the communication channel belongs to the category PROTOCOL or FUNCTIONAL_GROUP, the [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]] exception will be thrown. |
| + | |||
| + | {{Note|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.}} | ||
| + | |||
| + | {{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | Return list of names of all ECU variants of a communication channel}} | ||
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | This element represents the communication channel which provides the data.}} |
|} | |} | ||
== 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; | ||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | /// Flow |
| + | |||
| + | ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false); | ||
List1 = DiagDataBrowsing.GetEcuVariantList(ComChannel1); | List1 = DiagDataBrowsing.GetEcuVariantList(ComChannel1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetComChannelList]] <br/> | + | [[Extensions.DiagDataBrowsing.GetComChannelList|GetComChannelList]] <br/> |
| − | [[GetDiagServiceList]] <br/> | + | [[Extensions.DiagDataBrowsing.GetDiagServiceList|GetDiagServiceList]] <br/> |
| − | [[GetRequestParameterList]] <br/> | + | [[Extensions.DiagDataBrowsing.GetRequestParameterList|GetRequestParameterList]] <br/> |
| − | [[GetResponseParameterList]] <br/> | + | [[Extensions.DiagDataBrowsing.GetResponseParameterList|GetResponseParameterList]] <br/> |
| − | [[GetAllowedParameterValueList]] | + | [[Extensions.DiagDataBrowsing.GetAllowedParameterValueList|GetAllowedParameterValueList]] |
Latest revision as of 10:32, 12 September 2019
Contents
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.
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.
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
