Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbResponseDbSpecialDataGroups"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbResponseDbSpecialDataGroups'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbResponseDbSpecialDataGroups|...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbResponseDbSpecialDataGroups'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbResponseDbSpecialDataGroups'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbResponseDbSpecialDataGroups| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbResponseDbSpecialDataGroups| Gets the special data groups of the [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|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.GetDbResponseDbSpecialDataGroups(DbResponseTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbResponseDbSpecialDataGroups''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbSpecialDataGroup|DbSpecialDataGroup]] (SDG) of the [[Extensions.DiagDataBrowsingPlus.DbResponse|DbResponse]]. An empty list can be returned if no SDG are available.
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 MCDDbResponse::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) of the [[Extensions.DiagDataBrowsingPlus.DbResponse|DbResponse]].}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| dbResponse| [[Extensions.DiagDataBrowsingPlus.DbResponse|DbResponse]] | [[Term]] | - | [1..1] |The element addresses the '''DbResponse''' 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;
+
DiagCom.Result Result;
 +
DiagCom.Response Response;
 +
DiagDataBrowsingPlus.DbResponse DbResponse;
 +
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
// ...
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, Result, NULL, false, false);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
Response = DiagCom.GetFirstResponse(Result);
 +
DbResponse = DiagDataBrowsingPlus.GetResponseDbResponse(Response);
 +
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbResponseDbSpecialDataGroups(DbResponse);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetResponseDbResponse|GetResponseDbResponse]]

Revision as of 06:19, 17 September 2018

Classification

Name GetDbResponseDbSpecialDataGroups
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.GetDbResponseDbSpecialDataGroups(DbResponseTerm);

Description

GetDbResponseDbSpecialDataGroups returns a list of DbSpecialDataGroup (SDG) of the DbResponse. An empty list can be returned if no SDG are available.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbResponse::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) of the DbResponse.

Properties

Name Data Type Class Default Cardinality Description
dbResponse DbResponse Term - [1..1] The element addresses the DbResponse which SDGs shall be returned.

OTL Examples

DiagCom.Result Result;
DiagCom.Response Response;
DiagDataBrowsingPlus.DbResponse DbResponse;
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;

/// Flow

[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
DbResponse = DiagDataBrowsingPlus.GetResponseDbResponse(Response);
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbResponseDbSpecialDataGroups(DbResponse);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetResponseDbResponse