Difference between revisions of "Extensions.DiagDataBrowsingPlus.IsDbParameterConstant"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''IsDbParameterConstant'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | IsDbParameterConstant | UPDATING... | [[Term]...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''IsDbParameterConstant'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''IsDbParameterConstant'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | IsDbParameterConstant | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | IsDbParameterConstant| Checks the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] whether if it is constant or not| [[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);
+
BooleanTerm= DiagDataBrowsingPlus.IsDbParameterConstant(DbParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''IsDbParameterConstant''' returns True if the parameter is of ODX type CODED-CONST or PHYS-CONST otherwise False.
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 MCDDbParameter::isConstant}}
{{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.SimpleDataType.Boolean|Boolean]] | Returns True if the parameter is of ODX type CODED-CONST or PHYS-CONST
 +
otherwise False.}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| dbParameter | [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | - | [1..1] |The element addresses the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] (MCDDbParameter) which shall be checked whether if it is constant or not.}}
 
|}
 
|}
-->
 
  
 
== 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;
 +
Boolean MyBoolean;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
[#MetaData(RequestPdu), <#Data>22 2A 19</#Data>]
// ...
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "DiagnServi_ReadDataByIdentMeasuValue"), {Param_RecorDataIdent = "stall current measurement value"}, {}, Result, NULL, false, false);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
Response = DiagCom.GetFirstResponse(Result);
 +
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DataRecor", "Param_StallCurreMeasuValue", "Case_MeasuValue", "Param_Ruhes"});
 +
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
 +
MyBoolean= DiagDataBrowsingPlus.IsDbParameterConstant(DbParameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]]<br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetParameterDbParameter|GetParameterDbParameter]]

Revision as of 03:00, 14 September 2018

Classification

Name IsDbParameterConstant
Short Description Checks the DbParameter whether if it is constant or not
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm= DiagDataBrowsingPlus.IsDbParameterConstant(DbParameterTerm);

Description

IsDbParameterConstant returns True if the parameter is of ODX type CODED-CONST or PHYS-CONST otherwise False.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbParameter::isConstant

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
Boolean Returns True if the parameter is of ODX type CODED-CONST or PHYS-CONST

otherwise False.

Properties

Name Data Type Class Default Cardinality Description
dbParameter DbParameter Term - [1..1] The element addresses the DbParameter (MCDDbParameter) which shall be checked whether if it is constant or not.

OTL Examples

DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
Boolean MyBoolean;

/// Flow

[#MetaData(RequestPdu), <#Data>22 2A 19</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "DiagnServi_ReadDataByIdentMeasuValue"), {Param_RecorDataIdent = "stall current measurement value"}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DataRecor", "Param_StallCurreMeasuValue", "Case_MeasuValue", "Param_Ruhes"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
MyBoolean= DiagDataBrowsingPlus.IsDbParameterConstant(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetFirstResponse
GetParameterByPath
GetParameterDbParameter