Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbDiagTroubleCodeDTCText"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbDiagTroubleCodeDTCText'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbDiagTroubleCodeDTCText | UPDATING....")
 
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbDiagTroubleCodeDTCText'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbDiagTroubleCodeDTCText'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbDiagTroubleCodeDTCText | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbDiagTroubleCodeDTCText | Gets the DTC text 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);
+
StringTerm DiagDataBrowsingPlus.GetDbDiagTroubleCodeDTCText(DbDiagTroubleCodeTerm dbDiagTroubleCode);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbDiagTroubleCodeDTCText''' returns the DTC text of [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]].
−
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::getUnicodeDTCText}}
−
{{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.SimpleDataType.String|String]] | Returns the display trouble code of the [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]].}}
  
 
== 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 DTC text 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
 +
 
 +
String MyString;
 +
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);
 +
MyString = DiagDataBrowsingPlus.GetDbDiagTroubleCodeDTCText(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 GetDbDiagTroubleCodeDTCText
Short Description Gets the DTC text of the DbDiagTroubleCode
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbDiagTroubleCode related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetDbDiagTroubleCodeDTCText(DbDiagTroubleCodeTerm dbDiagTroubleCode);

Description

GetDbDiagTroubleCodeDTCText returns the DTC text of DbDiagTroubleCode.

Icons Note.png The appropriate MVCI system operation is MCDDbDiagTroubleCode::getUnicodeDTCText

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 DTC text shall be returned.

OTL Examples

/// Local Declarations

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.GetDbDiagTroubleCodeDTCText(DbDiagTroubleCode);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetParameterByPath
GetParameterDbDiagTroubleCode

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