Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbRequestPDUMaxLength"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbRequestPDUMaxLength'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbRequestPDUMaxLength| UPDATING... | ...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbRequestPDUMaxLength'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbRequestPDUMaxLength'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbRequestPDUMaxLength| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbRequestPDUMaxLength| Gets the maximum PDU length 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);
+
IntegerTerm = DiagDataBrowsingPlus.GetDbRequestPDUMaxLength(DbRequestTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbRequestPDUMaxLength''' returns the maximum PDU length of the [[Extensions.DiagDataBrowsingPlus.DbRequest|DbRequest]].
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::getPDUMaxLength}}
 +
 
 +
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | Returns the maximum PDU length 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 maximum PDU length 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;
 +
Integer MyInteger;
  
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);
 +
MyInteger = DiagDataBrowsingPlus.GetDbRequestPDUMaxLength(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:13, 14 September 2018

Classification

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

OTL Syntax

IntegerTerm = DiagDataBrowsingPlus.GetDbRequestPDUMaxLength(DbRequestTerm);

Description

GetDbRequestPDUMaxLength returns the maximum PDU length of the DbRequest.

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::getPDUMaxLength

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
Integer Returns the maximum PDU length of the DbRequest.

Properties

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

OTL Examples

DiagCom.DiagService DiagService;
DiagDataBrowsingPlus.DbDiagService DbDiagService;
DiagDataBrowsingPlus.DbRequest DbRequest;
Integer MyInteger;

/// Flow

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

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetDiagServiceDbDiagService
GetDbDiagServiceDbRequest