Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetParameterDbParameter"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetParameterDbParameter'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetParameterDbParameter | UPDATING... | T...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetParameterDbParameter'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetParameterDbParameter'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetParameterDbParameter | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetParameterDbParameter| Gets the corresponding data base object (MCDDbParameter) of the [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbParameter 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);
+
DbParameterTerm = DiagDataBrowsingPlus.GetParameterDbParameter(ParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetParameterDbParameter''' returns the corresponding data base object (MCDDbParameter) which was used to create this diag:[[Extensions.DiagCom.Parameter|parameter]] (MCDParameter).
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|NOTE — The appropriate MVCI system operation is MCDParameter::getDbObject}}
{{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.DbParameter|DbParameter]] | Returns the DbParameter of the diag:[[Extensions.DiagCom.Parameter|parameter]].}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1..1] |The element addresses the diag:[[Extensions.DiagCom.Parameter|Parameter]] (MCDParameter) which corresponding data base object (MCDDbParameter) 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.Result Result;
 +
DiagCom.Response Response;
 +
DiagCom.Parameter Parameter;
 +
DiagDataBrowsingPlus.DbParameter DbParameter;
 +
DiagDataBrowsingPlus.DbTable DbTable;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
[#MetaData(RequestPdu), <#Data>22 04 3E</#Data>]
// ...
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentCalibData"), {Param_RecorDataIdent = "Theftprotection Showroom Mode"}, {}, Result, NULL, false, false);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
Response = DiagCom.GetFirstResponse(Result);
 +
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DataRecor"});
 +
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
 
</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.GetRequest|GetRequest]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagCom.GetParameterBySemantic|GetParameterBySemantic]] <br/>

Revision as of 02:47, 14 September 2018

Classification

Name GetParameterDbParameter
Short Description Gets the corresponding data base object (MCDDbParameter) of the Parameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

DbParameterTerm = DiagDataBrowsingPlus.GetParameterDbParameter(ParameterTerm);

Description

GetParameterDbParameter returns the corresponding data base object (MCDDbParameter) which was used to create this diag:parameter (MCDParameter).

Icons Note.png NOTE — The appropriate MVCI system operation is MCDParameter::getDbObject

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
DbParameter Returns the DbParameter of the diag:parameter.

Properties

Name Data Type Class Default Cardinality Description
parameter Parameter Term - [1..1] The element addresses the diag:Parameter (MCDParameter) which corresponding data base object (MCDDbParameter) shall be returned.

OTL Examples

DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
DiagDataBrowsingPlus.DbTable DbTable;

/// Flow

[#MetaData(RequestPdu), <#Data>22 04 3E</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentCalibData"), {Param_RecorDataIdent = "Theftprotection Showroom Mode"}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DataRecor"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterBySemantic