Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbTableKeys"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbTableKeys'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbTableKeys | UPDATING... | Term | Extensio...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbTableKeys'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbTableKeys'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbTableKeys | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbTableKeys| Gets the keys 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);
+
ListTerm = DiagDataBrowsingPlus.GetDbTableKeys(DbTableTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbTableKeys''' returns the key values of all table rows in this table as a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Core.DataTypes.SimpleDataType.String|Strings]] . The returned 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 MCDDbTable::getKeys}}
−
{{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 the key values of all table rows in this table as a list of [[Core.DataTypes.SimpleDataType.String|Strings]].}}
  
 
== 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 keys 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;
 +
List<String> List_String;
  
−
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]);
 +
List_String = DiagDataBrowsingPlus.GetDbTableKeys(List_DbTable[0]);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbTables|GetDbComChannelDbTables]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbSubComponents|GetDbComChannelDbSubComponents]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbTables|GetDbSubComponentDbTables]]

Revision as of 06:22, 19 September 2018

Classification

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

OTL Syntax

ListTerm = DiagDataBrowsingPlus.GetDbTableKeys(DbTableTerm);

Description

GetDbTableKeys returns the key values of all table rows in this table as a list of Strings . The returned list can be empty.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbTable::getKeys

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 the key values of all table rows in this table as a list of Strings.

Properties

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

OTL Examples

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

/// Flow

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

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbTables
GetDbComChannelDbSubComponents
GetDbSubComponentDbTables

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