Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbComChannelDbTables"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbComChannelDbTables'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbComChannelDbTables| UPDATING... | Te...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbComChannelDbTables'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbComChannelDbTables'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbComChannelDbTables| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbComChannelDbTables| Gets the tables of the [[Extensions.DiagDataBrowsingPlus.DbComChannel|DbComChannel]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbTable related terms]] | NONE | - }}
  
 
== 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.GetDbComChannelDbTables(DbComChannelTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbComChannelDbTables''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of all [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] (McdDbTable) referenced by the ComChannel. The list can be empty.
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.
+
 
{{ComChannelMemoryUsageNote}}
+
{{Note|NOTE — The appropriate MVCI system operation is MCDDbLogicalLink::getDbLocation::getDbTables}}
{{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!}}
+
 
-->
+
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | Returns a list of all [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] (McdDbTable) referenced by the ComChannel.}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| dbComChannel| [[Extensions.DiagDataBrowsingPlus.DbComChannel|DbComChannel]] | [[Term]] | - | [1..1] |The element addresses the '''ComChannel''' which tables shall be returned.}}
 
|}
 
|}
-->
 
  
 
== 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;
+
DiagDataBrowsingPlus.DbComChannel DbComChannel;
 +
List<DiagDataBrowsingPlus.DbTable> List_DbTable;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "AIRBAG");
// ...
+
List_DbTable = DiagDataBrowsingPlus.GetDbComChannelDbTables(DbComChannel);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]]

Revision as of 13:06, 17 September 2018

Classification

Name GetDbComChannelDbTables
Short Description Gets the tables of the DbComChannel
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbTable related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm = DiagDataBrowsingPlus.GetDbComChannelDbTables(DbComChannelTerm);

Description

GetDbComChannelDbTables returns a list of all DbTable (McdDbTable) referenced by the ComChannel. The list can be empty.

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

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 all DbTable (McdDbTable) referenced by the ComChannel.

Properties

Name Data Type Class Default Cardinality Description
dbComChannel DbComChannel Term - [1..1] The element addresses the ComChannel which tables shall be returned.

OTL Examples

DiagDataBrowsingPlus.DbComChannel DbComChannel;
List<DiagDataBrowsingPlus.DbTable> List_DbTable;

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "AIRBAG");
List_DbTable = DiagDataBrowsingPlus.GetDbComChannelDbTables(DbComChannel);

See also

GetDbComChannel
GetComChannelDbComChannel