Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbFaultMemoryDiagTroubleCodeByTroubleCode"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbFaultMemoryDiagTroubleCodeByTroubleCode'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbFaultMemoryDiagTr...")
 
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbFaultMemoryDiagTroubleCodeByTroubleCode'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbFaultMemoryDiagTroubleCodeByTroubleCode'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbFaultMemoryDiagTroubleCodeByTroubleCode | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbFaultMemoryDiagTroubleCodeByTroubleCode | Gets the DbDiagTroubleCode (MCDDbDiagTroubleCode) object | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbFaultMemory related terms]] | [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] | - }}
  
 
== 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);
+
DbDiagTroubleCodeTerm DiagDataBrowsingPlus.GetDbFaultMemoryDiagTroubleCodeByTroubleCode(DbFaultMemoryTerm faultMemory, IntegerTerm troubleCode);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbFaultMemoryDiagTroubleCodeByTroubleCode''' returns the [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]] (MCDDbDiagTroubleCode) object which matches given trouble code.  
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 MCDDbFaultMemory::getDbDiagTroubleCodeByTroubleCode}}
{{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| [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]] | Returns the [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]] (MCDDbDiagTroubleCode) object which matches given trouble code.}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie1| FaultMemory | [[Extensions.DiagDataBrowsingPlus.DbFaultMemory|DbFaultMemory]] | [[Term]] | - | [1..1] |The element addresses the '''DbFaultMemory''' which [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]] shall be returned.}}
 +
{{TableRowPropertie2| TroubleCode | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1..1] |The element addresses the trouble code from which the [[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]] object 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
 +
 
 +
DiagDataBrowsingPlus.DbComChannel DbComChannel;
 +
List<DiagDataBrowsingPlus.DbFaultMemory> List_DbFaultMemory;
 +
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
DbComChannel = DiagDataBrowsingPlus.GetDbComChannel("", "LL_GatewUDS");
// ...
+
List_DbFaultMemory = DiagDataBrowsingPlus.GetDbComChannelDbFaultMemories(DbComChannel);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
DbDiagTroubleCode = DiagDataBrowsingPlus.GetDbFaultMemoryDiagTroubleCodeByTroubleCode(List_DbFaultMemory[0], 66051);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbFaultMemories|GetDbComChannelDbFaultMemories]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbFaultMemories|GetDbSubComponentDbFaultMemories]]

Latest revision as of 06:16, 25 September 2019

Classification

Name GetDbFaultMemoryDiagTroubleCodeByTroubleCode
Short Description Gets the DbDiagTroubleCode (MCDDbDiagTroubleCode) object
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbFaultMemory related terms
Exceptions InvalidTypeException
Checker Rules -
Standard Compliant Yes

OTL Syntax

DbDiagTroubleCodeTerm DiagDataBrowsingPlus.GetDbFaultMemoryDiagTroubleCodeByTroubleCode(DbFaultMemoryTerm faultMemory, IntegerTerm troubleCode);

Description

GetDbFaultMemoryDiagTroubleCodeByTroubleCode returns the DbDiagTroubleCode (MCDDbDiagTroubleCode) object which matches given trouble code.

Icons Note.png The appropriate MVCI system operation is MCDDbFaultMemory::getDbDiagTroubleCodeByTroubleCode

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
DbDiagTroubleCode Returns the DbDiagTroubleCode (MCDDbDiagTroubleCode) object which matches given trouble code.

Properties

Name Data Type Class Default Cardinality Description
FaultMemory DbFaultMemory Term - [1..1] The element addresses the DbFaultMemory which DbDiagTroubleCode shall be returned.
TroubleCode Integer Term - [1..1] The element addresses the trouble code from which the DbDiagTroubleCode object shall be returned.

OTL Examples

/// Local Declarations

DiagDataBrowsingPlus.DbComChannel DbComChannel;
List<DiagDataBrowsingPlus.DbFaultMemory> List_DbFaultMemory;
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel("", "LL_GatewUDS");
List_DbFaultMemory = DiagDataBrowsingPlus.GetDbComChannelDbFaultMemories(DbComChannel);
DbDiagTroubleCode = DiagDataBrowsingPlus.GetDbFaultMemoryDiagTroubleCodeByTroubleCode(List_DbFaultMemory[0], 66051);

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbFaultMemories
GetDbSubComponentDbFaultMemories