Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbTableDbTableRows"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbTableDbTableRows'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbTableDbTableRows | UPDATING... | [[Term]...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbTableDbTableRows'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbTableDbTableRows'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbTableDbTableRows | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbTableDbTableRows| Gets the table rows of the [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] | [[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);
+
MapTerm = DiagDataBrowsingPlus.GetDbTableDbTableRows(DbTableTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbTableDbTableRows''' returns all table rows contained in this table as a [[Core.DataTypes.ComplexDataType.ContainerDataType.Map|Map]]<[[Core.DataTypes.SimpleDataType.String|String]],[[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]]>. The key of the map contains the value of the key associated with the MCDDbTableParameter in the corresponding MCDDbTable. The value contains the related MCDDbTableParameter. The length of the map is zero, if no MCDDbTableParameter is available for this table.
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 MCDDbTable::getDbTableRows[]::getKey::getValueAsString; MCDDbTable::getDbTableRows}}
{{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 all table rows contained in this table as a [[Core.DataTypes.ComplexDataType.ContainerDataType.Map|Map]]<[[Core.DataTypes.SimpleDataType.String|String]],[[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]]>.}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| dbTable|[[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] | [[Term]] | - | [1..1] |The element addresses the '''DbTable''' (MCDDbTable) which table rows 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.DbSubComponent> List_DbSubComponent;
 +
List<DiagDataBrowsingPlus.DbTable> List_DbTable;
 +
Map<String, DbParameter> Map_DbParameter;
  
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]);
 +
Map_DbParameter = DiagDataBrowsingPlus.GetDbTableDbTableRows(List_DbTable[0]);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbSubComponents|GetDbComChannelDbSubComponents]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbTables|GetDbSubComponentDbTables]]

Revision as of 04:53, 19 September 2018

Classification

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

OTL Syntax

MapTerm = DiagDataBrowsingPlus.GetDbTableDbTableRows(DbTableTerm);

Description

GetDbTableDbTableRows returns all table rows contained in this table as a Map<String,DbParameter>. The key of the map contains the value of the key associated with the MCDDbTableParameter in the corresponding MCDDbTable. The value contains the related MCDDbTableParameter. The length of the map is zero, if no MCDDbTableParameter is available for this table.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbTable::getDbTableRows[]::getKey::getValueAsString; MCDDbTable::getDbTableRows

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 all table rows contained in this table as a Map<String,DbParameter>.

Properties

Name Data Type Class Default Cardinality Description
dbTable DbTable Term - [1..1] The element addresses the DbTable (MCDDbTable) which table rows shall be returned.

OTL Examples

DiagDataBrowsingPlus.DbComChannel DbComChannel;
List<DiagDataBrowsingPlus.DbSubComponent> List_DbSubComponent;
List<DiagDataBrowsingPlus.DbTable> List_DbTable;
Map<String, DbParameter> Map_DbParameter;

/// Flow

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

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbSubComponents
GetDbSubComponentDbTables