Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbTables"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbSubComponentDbTables'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbSubComponentDbTables| UPDATING... |...")
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbSubComponentDbTables'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbSubComponentDbTables'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbSubComponentDbTables| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbSubComponentDbTables| Gets the tables of the [[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|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.GetDbSubComponentDbTables(DbSubComponentTerm subComponent);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbSubComponentDbTables''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] for the [[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]] which is available in ODX. If no elements are available in database, then an empty list will be delivered.
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|The appropriate MVCI system operation is MCDDbSubComponent::getDbTableRowConnectors[n]::getDbTable}}
{{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]] for the [[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]].}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| SubComponent|[[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]] | [[Term]] | - | [1..1] |The element addresses the '''DbSubComponent''' 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;
+
/// Local Declarations
 +
 
 +
DiagDataBrowsingPlus.DbComChannel DbComChannel;
 +
List<DiagDataBrowsingPlus.DbSubComponent> List_DbSubComponent;
 +
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_DbSubComponent = DiagDataBrowsingPlus.GetDbComChannelDbSubComponents(DbComChannel);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
List_DbTable = DiagDataBrowsingPlus.GetDbSubComponentDbTables(List_DbSubComponent[0]);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbSubComponents|GetDbComChannelDbSubComponents]]

Latest revision as of 08:44, 2 November 2018

Classification

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

OTL Syntax

ListTerm DiagDataBrowsingPlus.GetDbSubComponentDbTables(DbSubComponentTerm subComponent);

Description

GetDbSubComponentDbTables returns a list of DbTable for the DbSubComponent which is available in ODX. If no elements are available in database, then an empty list will be delivered.

Icons Note.png The appropriate MVCI system operation is MCDDbSubComponent::getDbTableRowConnectors[n]::getDbTable

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 for the DbSubComponent.

Properties

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

OTL Examples

/// Local Declarations

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

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "AIRBAG");
List_DbSubComponent = DiagDataBrowsingPlus.GetDbComChannelDbSubComponents(DbComChannel);
List_DbTable = DiagDataBrowsingPlus.GetDbSubComponentDbTables(List_DbSubComponent[0]);

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbSubComponents