Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbRequestDefaultPDU"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbRequestDefaultPDU'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbRequestDefaultPDU| UPDATING... | Term...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbRequestDefaultPDU'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbRequestDefaultPDU'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbRequestDefaultPDU| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbRequestDefaultPDU| Gets the default PDU of the [[Extensions.DiagDataBrowsingPlus.DbRequest|DbRequest]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbRequest related terms]] | [[Extensions.DiagDataBrowsingPlus.NotSupportedException|NotSupportedException]] | - }}
  
 
== 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);
+
ByteFieldTerm = DiagDataBrowsingPlus.GetDbRequestDefaultPDU(DbRequestTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbRequestDefaultPDU''' returns the default PDU of the [[Extensions.DiagDataBrowsingPlus.DbRequest|DbRequest]] as a [[Core.DataTypes.ComplexDataType.ByteField|ByteField]].
−
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}}
+
if the communication primitive does not support the PDU information, the [[Extensions.DiagDataBrowsingPlus.NotSupportedException|NotSupportedException]] exception will be thrown.
−
{{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!}}
+
 
−
-->
+
{{Note|NOTE — The appropriate MVCI system operation is MCDDbRequest::getDefaultPDU}}
 +
 
 +
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | Returns the default PDU of the [[Extensions.DiagDataBrowsingPlus.DbRequest|DbRequest]].}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| dbRequest| [[Extensions.DiagDataBrowsingPlus.DbRequest|DbRequest]] | [[Term]] | - | [1..1] |The element addresses the [[Extensions.DiagDataBrowsingPlus.DbRequest|DbRequest]] which default PDU 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.DiagService DiagService;
 +
DiagDataBrowsingPlus.DbDiagService DbDiagService;
 +
DiagDataBrowsingPlus.DbRequest DbRequest;
 +
ByteField MyByteField;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
DiagService = DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentActuaTestStatu");
−
// ...
+
DbDiagService = DiagDataBrowsingPlus.GetDiagServiceDbDiagService(DiagService);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
DbRequest = DiagDataBrowsingPlus.GetDbDiagServiceDbRequest(DbDiagService);
 +
MyByteField = DiagDataBrowsingPlus.GetDbRequestDefaultPDU(DbRequest);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDiagServiceDbDiagService|GetDiagServiceDbDiagService]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbDiagServiceDbRequest|GetDbDiagServiceDbRequest]] <br/>

Revision as of 07:01, 14 September 2018

Classification

Name GetDbRequestDefaultPDU
Short Description Gets the default PDU of the DbRequest
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbRequest related terms
Exceptions NotSupportedException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ByteFieldTerm = DiagDataBrowsingPlus.GetDbRequestDefaultPDU(DbRequestTerm);

Description

GetDbRequestDefaultPDU returns the default PDU of the DbRequest as a ByteField.

if the communication primitive does not support the PDU information, the NotSupportedException exception will be thrown.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbRequest::getDefaultPDU

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
ByteField Returns the default PDU of the DbRequest.

Properties

Name Data Type Class Default Cardinality Description
dbRequest DbRequest Term - [1..1] The element addresses the DbRequest which default PDU shall be returned.

OTL Examples

DiagCom.DiagService DiagService;
DiagDataBrowsingPlus.DbDiagService DbDiagService;
DiagDataBrowsingPlus.DbRequest DbRequest;
ByteField MyByteField;

/// Flow

DiagService = DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentActuaTestStatu");
DbDiagService = DiagDataBrowsingPlus.GetDiagServiceDbDiagService(DiagService);
DbRequest = DiagDataBrowsingPlus.GetDbDiagServiceDbRequest(DbDiagService);
MyByteField = DiagDataBrowsingPlus.GetDbRequestDefaultPDU(DbRequest);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetDiagServiceDbDiagService
GetDbDiagServiceDbRequest

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