Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbTableSpecialDataGroups"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbTableSpecialDataGroups'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbTableSpecialDataGroups| UPDATING.....")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbTableSpecialDataGroups'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbTableSpecialDataGroups'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbTableSpecialDataGroups| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbTableSpecialDataGroups| Gets the SDGs 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.GetDbTableSpecialDataGroups(DbTableTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbTableSpecialDataGroups''' returns the special data groups defined for the corresponding TABLE in the project's data bases as a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbSpecialDataGroup|DbSpecialDataGroup]].
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::getDbSDGs}}
{{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 [[Extensions.DiagDataBrowsingPlus.DbSpecialDataGroup|DbSpecialDataGroup]] for the corresponding TABLE.}}
  
 
== 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 SDGs 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;
 +
List<DiagCom.DiagService> List_DbSpecialDataGroups;
  
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>
+
List_DiagService = DiagDataBrowsingPlus.GetDbTableSpecialDataGroups(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 13:14, 19 September 2018

Classification

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

OTL Syntax

ListTerm = DiagDataBrowsingPlus.GetDbTableSpecialDataGroups(DbTableTerm);

Description

GetDbTableSpecialDataGroups returns the special data groups defined for the corresponding TABLE in the project's data bases as a list of DbSpecialDataGroup.

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

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 DbSpecialDataGroup for the corresponding TABLE.

Properties

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

OTL Examples

DiagDataBrowsingPlus.DbComChannel DbComChannel;
List<DiagDataBrowsingPlus.DbTable> List_DbTable;
List<DiagCom.DiagService> List_DbSpecialDataGroups;

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "AIRBAG");
List_DbTable = DiagDataBrowsingPlus.GetDbComChannelDbTables(DbComChannel);
List_DiagService = DiagDataBrowsingPlus.GetDbTableSpecialDataGroups(List_DbTable[0]);

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbTables
GetDbComChannelDbSubComponents
GetDbSubComponentDbTables