Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbEcuVariantList"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbEcuVariantList'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbEcuVariantList | UPDATING... | Term |...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbEcuVariantList'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbEcuVariantList'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbEcuVariantList | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbEcuVariantList | Gets the names of all ECU variants for a given logical link | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbEcuVariant related terms]] | [[Core.Actions.Throw.Exception.UnknownTargetException|UnknownTargetException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
−
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.CloseComChannel(ComChannelVariable);
+
ListTerm = DiagDataBrowsingPlus.GetDbEcuVariantList(StringTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbEcuVariantList''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] of [[Core.DataTypes.SimpleDataType.String|strings]] which represents the names of all ECU variants for a given logical link. The identifier shall point to a base variant. If a base variant has no associated ECU variants, an empty [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] shall be returned. Furthermore, in case the communication channel points to a protocol or functional group, an exception shall
−
OTX CloseComChannel activity is used for the [[Diagnosis Runtime System]] to announce that an open communication channel that all relevant resources can be released and closed.
+
be thrown.
−
{{ComChannelMemoryUsageNote}}
+
 
−
{{Important|Please note that the use of a shared '''ComChannel''' can bring the OTX runtime system in an undefined state and that is this case is not validated at design time!}}
+
{{Note|NOTE — The appropriate MVCI system operation is MCDDbLogicalLink::getDbLocation::getDbECU::getDbEcuVariants}}
−
-->
+
 
 +
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | Returns a list of [[Core.DataTypes.SimpleDataType.String|strings]] which represents the names of all ECU variants for a given logical link.}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie1| identifier | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1..1] |This element represents a string identifying the communication channel which provides the data. The identifier can be retrieved by the Term [[Extensions.DiagDataBrowsing.GetComChannelList|data:GetComChannelList]].}}
 
|}
 
|}
−
-->
 
  
 
== OTL Examples ==
 
== OTL Examples ==
−
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.ComChannel myComCannel;
+
List<String> List_String;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
List_String = DiagDataBrowsingPlus.GetDbEcuVariantList("LL_CentrElectUDS");
−
// ...
 
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsing.GetComChannelList|GetComChannelList]]

Revision as of 08:29, 11 September 2018

Classification

Name GetDbEcuVariantList
Short Description Gets the names of all ECU variants for a given logical link
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbEcuVariant related terms
Exceptions UnknownTargetException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm = DiagDataBrowsingPlus.GetDbEcuVariantList(StringTerm);

Description

GetDbEcuVariantList returns a List of strings which represents the names of all ECU variants for a given logical link. The identifier shall point to a base variant. If a base variant has no associated ECU variants, an empty List shall be returned. Furthermore, in case the communication channel points to a protocol or functional group, an exception shall be thrown.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbLogicalLink::getDbLocation::getDbECU::getDbEcuVariants

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 Returns a list of strings which represents the names of all ECU variants for a given logical link.

Properties

Name Data Type Class Default Cardinality Description
identifier String Term - [1..1] This element represents a string identifying the communication channel which provides the data. The identifier can be retrieved by the Term data:GetComChannelList.

OTL Examples

List<String> List_String;

/// Flow

List_String = DiagDataBrowsingPlus.GetDbEcuVariantList("LL_CentrElectUDS");

See also

GetComChannel
GetComChannelList

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagDataBrowsingPlus.GetDbEcuVariantList&oldid=6341"