Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbResponseDbParameters"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbResponseDbParameters'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbResponseDbParameters| UPDATING... |...")
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbResponseDbParameters'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbResponseDbParameters'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbResponseDbParameters| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbResponseDbParameters| Gets the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] of the [[Extensions.DiagDataBrowsingPlus.DbResponse|DbResponse]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbResponse 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);
+
ListTerm DiagDataBrowsingPlus.GetDbResponseDbParameters(DbResponseTerm dbResponse);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbResponseDbParameters''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] objects which represents the MCDDbResponseParameters for the given [[Extensions.DiagDataBrowsingPlus.DbResponse|DbResponse]]. An empty list can be returned, if no response parameters are defined for the response in the project's data base.
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 MCDDbResponse::getDbResponseParameters}}
{{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.ComplexDataType.ContainerDataType.List|List]] | Returns a list of [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] objects which represents the MCDDbResponseParameters for the given [[Extensions.DiagDataBrowsingPlus.DbResponse|DbResponse]].}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| DbResponse| [[Extensions.DiagDataBrowsingPlus.DbResponse|DbResponse]]| [[Term]] | - | [1..1] |The element represents the '''DbResponse''' which [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] shall be returnd.}}
 
|}
 
|}
-->
 
  
 
== 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
 +
 
 +
DiagCom.Result Result;
 +
DiagCom.Response Response;
 +
DiagDataBrowsingPlus.DbResponse DbResponse;
 +
List<DiagDataBrowsingPlus.DbParameter> List_DbParameter;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
// ...
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, Result, NULL, false, false);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
Response = DiagCom.GetFirstResponse(Result);
 +
DbResponse = DiagDataBrowsingPlus.GetResponseDbResponse(Response);
 +
List_DbParameter = DiagDataBrowsingPlus.GetDbResponseDbParameters(DbResponse);
 
</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.DiagDataBrowsingPlus.GetResponseDbResponse|GetResponseDbResponse]]

Latest revision as of 08:50, 2 November 2018

Classification

Name GetDbResponseDbParameters
Short Description Gets the DbParameter of the DbResponse
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbResponse related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm DiagDataBrowsingPlus.GetDbResponseDbParameters(DbResponseTerm dbResponse);

Description

GetDbResponseDbParameters returns a list of DbParameter objects which represents the MCDDbResponseParameters for the given DbResponse. An empty list can be returned, if no response parameters are defined for the response in the project's data base.

Icons Note.png The appropriate MVCI system operation is MCDDbResponse::getDbResponseParameters

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
List Returns a list of DbParameter objects which represents the MCDDbResponseParameters for the given DbResponse.

Properties

Name Data Type Class Default Cardinality Description
DbResponse DbResponse Term - [1..1] The element represents the DbResponse which DbParameter shall be returnd.

OTL Examples

/// Local Declarations

DiagCom.Result Result;
DiagCom.Response Response;
DiagDataBrowsingPlus.DbResponse DbResponse;
List<DiagDataBrowsingPlus.DbParameter> List_DbParameter;

/// Flow

[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
DbResponse = DiagDataBrowsingPlus.GetResponseDbResponse(Response);
List_DbParameter = DiagDataBrowsingPlus.GetDbResponseDbParameters(DbResponse);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetResponseDbResponse