Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbDiagServiceDbSpecialDataGroups"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbDiagServiceDbSpecialDataGroups'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbDiagServiceDbSpecialDataGr...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbDiagServiceDbSpecialDataGroups'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbDiagServiceDbSpecialDataGroups'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbDiagServiceDbSpecialDataGroups| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbDiagServiceDbSpecialDataGroups| Gets the special data groups of the [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbSpecialDataGroup 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.GetDbDiagServiceDbSpecialDataGroups(DbDiagServiceTerm dbDiagService);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbDiagServiceDbSpecialDataGroups''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbSpecialDataGroup|DbSpecialDataGroup]] (SDG) for the corresponding [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] in the project's data bases. An empty list will be delivered if no DbSDGs available in the ODX data.
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 MCDDbDataPrimitive::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 [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbSpecialDataGroup|DbSpecialDataGroup]] (SDG) for the corresponding [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] in the project's data bases.}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| DbDiagService| [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] | [[Term]] | - | [1..1] |The element addresses the '''DbDiagService''' whose special data groups 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
 +
 
 +
DiagCom.DiagService DiagService;
 +
DiagDataBrowsingPlus.DbDiagService DbDiagService;
 +
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
DiagService = DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDTCInforReporDTCByStatuMask");
// ...
+
DbDiagService = DiagDataBrowsingPlus.GetDiagServiceDbDiagService(DiagService);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbDiagServiceDbSpecialDataGroups(DbDiagService);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDiagServiceDbDiagService|GetDiagServiceDbDiagService]]

Latest revision as of 08:49, 2 November 2018

Classification

Name GetDbDiagServiceDbSpecialDataGroups
Short Description Gets the special data groups of the DbDiagService
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbSpecialDataGroup related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm DiagDataBrowsingPlus.GetDbDiagServiceDbSpecialDataGroups(DbDiagServiceTerm dbDiagService);

Description

GetDbDiagServiceDbSpecialDataGroups returns a list of DbSpecialDataGroup (SDG) for the corresponding DbDiagService in the project's data bases. An empty list will be delivered if no DbSDGs available in the ODX data.

Icons Note.png The appropriate MVCI system operation is MCDDbDataPrimitive::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 (SDG) for the corresponding DbDiagService in the project's data bases.

Properties

Name Data Type Class Default Cardinality Description
DbDiagService DbDiagService Term - [1..1] The element addresses the DbDiagService whose special data groups shall be returned.

OTL Examples

/// Local Declarations

DiagCom.DiagService DiagService;
DiagDataBrowsingPlus.DbDiagService DbDiagService;
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;

/// Flow

DiagService = DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDTCInforReporDTCByStatuMask");
DbDiagService = DiagDataBrowsingPlus.GetDiagServiceDbDiagService(DiagService);
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbDiagServiceDbSpecialDataGroups(DbDiagService);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetDiagServiceDbDiagService