Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbDiagTroubleCodeSpecialDataGroups"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbDiagTroubleCodeSpecialDataGroups'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbDiagTroubleCodeSpecialDa...")
 
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbDiagTroubleCodeSpecialDataGroups'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbDiagTroubleCodeSpecialDataGroups'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbDiagTroubleCodeSpecialDataGroups | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbDiagTroubleCodeSpecialDataGroups | Gets the special data groups of the [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbDiagTroubleCode 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.GetDbDiagTroubleCodeSpecialDataGroups(DbDiagTroubleCodeTerm dbDiagTroubleCode);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbDiagTroubleCodeSpecialDataGroups''' returns the special data groups defined for the corresponding DTC in the project's data bases as a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbSpecialDataGroup|DbSpecialDataGroup]] objects. 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 MCDDbDiagTroubleCode::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]] objects for the corresponding DTC.}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| DbDiagTroubleCode | [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]] | [[Term]] | - | [1..1] |The element addresses the '''DbDiagTroubleCode''' (MCDDbDiagTroubleCode) which 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
 +
 
 +
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;
 +
DiagCom.Result Result;
 +
DiagCom.Response Response;
 +
DiagCom.Parameter Parameter;
 +
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
[#MetaData(RequestPdu), <#Data>19 02 0C</#Data>]
−
// ...
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDTCInforReporDTCByConfiAndPendiStatu"), {}, {Resp_ReadDTCInforReporDTCByStatuMask.Expected = true}, Result, NULL, false, false);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
Response = DiagCom.GetFirstResponse(Result);
 +
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DTCAndStatuRecor", "STRUC_DTCAndStatuRecor", "Param_DTCUDS"});
 +
DbDiagTroubleCode = DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode(Parameter);
 +
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbDiagTroubleCodeSpecialDataGroups(DbDiagTroubleCode);
 
</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.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode|GetParameterDbDiagTroubleCode]]

Latest revision as of 09:11, 2 November 2018

Classification

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

OTL Syntax

ListTerm DiagDataBrowsingPlus.GetDbDiagTroubleCodeSpecialDataGroups(DbDiagTroubleCodeTerm dbDiagTroubleCode);

Description

GetDbDiagTroubleCodeSpecialDataGroups returns the special data groups defined for the corresponding DTC in the project's data bases as a list of DbSpecialDataGroup objects. An empty list will be delivered if no DbSDGs available in the ODX data.

Icons Note.png The appropriate MVCI system operation is MCDDbDiagTroubleCode::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 objects for the corresponding DTC.

Properties

Name Data Type Class Default Cardinality Description
DbDiagTroubleCode DbDiagTroubleCode Term - [1..1] The element addresses the DbDiagTroubleCode (MCDDbDiagTroubleCode) which special data groups shall be returned.

OTL Examples

/// Local Declarations

List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;
DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;

/// Flow

[#MetaData(RequestPdu), <#Data>19 02 0C</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDTCInforReporDTCByConfiAndPendiStatu"), {}, {Resp_ReadDTCInforReporDTCByStatuMask.Expected = true}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DTCAndStatuRecor", "STRUC_DTCAndStatuRecor", "Param_DTCUDS"});
DbDiagTroubleCode = DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode(Parameter);
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbDiagTroubleCodeSpecialDataGroups(DbDiagTroubleCode);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetParameterByPath
GetParameterDbDiagTroubleCode

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