Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbDiagTroubleCodeDisplayTroubleCode"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbDiagTroubleCodeDisplayTroubleCode'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbDiagTroubleCodeDisplayTroubleCode'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbDiagTroubleCodeDisplayTroubleCode | Gets the display trouble code of the [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbDiagTroubleCode related terms]] | NONE | - }}
+
{{ClassificationActivity | GetDbDiagTroubleCodeDisplayTroubleCode | Gets the display trouble code of the [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbDiagTroubleCode related terms]] | NONE | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
BooleanTerm = DiagDataBrowsingPlus.IsDbDiagServiceRepetitive(DbDiagServiceTerm);
+
StringTerm = DiagDataBrowsingPlus.GetDbDiagTroubleCodeDisplayTroubleCode(DbDiagTroubleCodeTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
'''GetDbDiagTroubleCodeDisplayTroubleCode''' returns True if MVCI-Server returns eREPEATED in getRepetitionMode otherwise False. If getRepetitionMode is not supported and [[Extensions.DiagDataBrowsingPlus.NotSupportedException|NotSupportedException]] shall be thrown.
+
'''GetDbDiagTroubleCodeDisplayTroubleCode''' returns the display trouble code of [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]].
  
{{Note|NOTE — The appropriate MVCI system operation is MCDDbDataPrimitive::getRepetitionMode}}
+
{{Note|NOTE — The appropriate MVCI system operation is MCDDbDiagTroubleCode::getDisplayTroubleCode}}
  
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns True if MVCI-Server returns eREPEATED in getRepetitionMode otherwise False.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the display trouble code of the [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]].}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| DbDiagService | [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] | [[Term]] | - | [1..1] | The element addresses the [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] which is checked whether it is repetitive or not.}}
+
{{TableRowPropertie1| dbDiagTroubleCode | [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]] | [[Term]] | - | [1..1] |The element addresses the [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]] (MCDDbDiagTroubleCode) which display trouble code shall be returned.}}
 
|}
 
|}
  
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DiagCom.ComChannel ComChannel;
+
String MyString;
DiagCom.DiagService DiagService;
+
DiagCom.Result Result;
DiagDataBrowsingPlus.DbDiagService DbDiagService;
+
DiagCom.Response Response;
Boolean MyBoolean = false;
+
DiagCom.Parameter Parameter;
 +
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;
 +
 
  
 
/// Flow
 
/// Flow
  
ComChannel = DiagCom.GetComChannel("LL_GatewUDS", NULL, false);
+
[#MetaData(RequestPdu), <#Data>19 02 0C</#Data>]
DiagService = DiagCom.CreateDiagServiceByName(ComChannel, "DiagnServi_ReadDataByIdentActuaTestStatu");
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDTCInforReporDTCByConfiAndPendiStatu"), {}, Resp_ReadDTCInforReporDTCByStatuMask.Expected = true}, Result, NULL, false, false);
DbDiagService = DiagDataBrowsingPlus.GetDiagServiceDbDiagService(DiagService);
+
Response = DiagCom.GetFirstResponse(Result);
MyBoolean = DiagDataBrowsingPlus.IsDbDiagServiceRepetitive(DbDiagService);
+
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DTCAndStatuRecor", "STRUC_DTCAndStatuRecor", "Param_DTCUDS"});
 +
DbDiagTroubleCode = DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode(Parameter);
 +
MyString = DiagDataBrowsingPlus.GetDbDiagTroubleCodeDisplayTroubleCode(DbDiagTroubleCode);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 40: Line 44:
 
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]] <br/>
+
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
+
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbDiagServices|GetDbComChannelDbDiagServices]]
+
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode|GetParameterDbDiagTroubleCode]]

Revision as of 06:46, 11 September 2018

Classification

Name GetDbDiagTroubleCodeDisplayTroubleCode
Short Description Gets the display trouble code of the DbDiagTroubleCode
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbDiagTroubleCode related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm = DiagDataBrowsingPlus.GetDbDiagTroubleCodeDisplayTroubleCode(DbDiagTroubleCodeTerm);

Description

GetDbDiagTroubleCodeDisplayTroubleCode returns the display trouble code of DbDiagTroubleCode.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbDiagTroubleCode::getDisplayTroubleCode

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
String Returns the display trouble code of the DbDiagTroubleCode.

Properties

Name Data Type Class Default Cardinality Description
dbDiagTroubleCode DbDiagTroubleCode Term - [1..1] The element addresses the DbDiagTroubleCode (MCDDbDiagTroubleCode) which display trouble code shall be returned.

OTL Examples

String MyString;
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);
MyString = DiagDataBrowsingPlus.GetDbDiagTroubleCodeDisplayTroubleCode(DbDiagTroubleCode);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetParameterByPath
GetParameterDbDiagTroubleCode