Difference between revisions of "Extensions.DiagDataBrowsingPlus.IsIntegerParameter"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''IsIntegerParameter'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | IsIntegerParameter| UPDATING... | Term | E...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''IsIntegerParameter'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''IsIntegerParameter'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | IsIntegerParameter| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | IsIntegerParameter| Checks whether the [[Extensions.DiagCom.Parameter|diag:Parameter]] is of data type Integer or not| [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|Parameter 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.IsIntegerParameter(ParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''IsIntegerParameter''' returns True whether the value of this [[Extensions.DiagCom.Parameter|diag:Parameter]] is of data type Integer (INT16, INT32, INT64, INT8, UINT16, UINT32, UINT64, UINT8, DTC, END_OF_PDU, ENVDATA, ENVDATADESC, FIELD, MULTIPLEXER, STRUCTURE, LENGTHKEY, TABLE_ROW). In all other cases it returns 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 MCDParameter::getDataType}}
−
{{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 — This term is introduced to complete the existing terms in the [[Extensions.DiagDataBrowsing|DiagDataBrowsing extension]] (ISO 13209 Part-3 [3]) that uses ParameterTerms. This completion primarily enables a generically interpretation of responses by using runtime parameters without using [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameters]].}}
 +
 
 +
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns True whether the value of this [[Extensions.DiagCom.Parameter|diag:Parameter]] is of data type [[Core.DataTypes.SimpleDataType.Integer|Integer]].}}
  
 
== 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:Parameter'''  (MCDParameter) which is checked whether it is of data type Integer 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.Parameter Parameter;
 +
Boolean MyBoolean;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "SinglJob_WriteFinge")), {"IPA_ProgrDate", "Param_Year"});
−
// ...
+
MyBoolean = DiagDataBrowsingPlus.IsIntegerParameter(Parameter);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</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 07:48, 20 September 2018

Classification

Name IsIntegerParameter
Short Description Checks whether the diag:Parameter is of data type Integer or not
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group Parameter related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm = DiagDataBrowsingPlus.IsIntegerParameter(ParameterTerm);

Description

IsIntegerParameter returns True whether the value of this diag:Parameter is of data type Integer (INT16, INT32, INT64, INT8, UINT16, UINT32, UINT64, UINT8, DTC, END_OF_PDU, ENVDATA, ENVDATADESC, FIELD, MULTIPLEXER, STRUCTURE, LENGTHKEY, TABLE_ROW). In all other cases it returns False.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDParameter::getDataType
Icons Note.png NOTE — This term is introduced to complete the existing terms in the DiagDataBrowsing extension (ISO 13209 Part-3 [3]) that uses ParameterTerms. This completion primarily enables a generically interpretation of responses by using runtime parameters without using DbParameters.

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 whether the value of this diag:Parameter is of data type Integer.

Properties

Name Data Type Class Default Cardinality Description
parameter Parameter Term - [1..1] The element addresses the diag:Parameter (MCDParameter) which is checked whether it is of data type Integer or not.

OTL Examples

DiagCom.Parameter Parameter;
Boolean MyBoolean;

/// Flow

Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "SinglJob_WriteFinge")), {"IPA_ProgrDate", "Param_Year"});
MyBoolean = DiagDataBrowsingPlus.IsIntegerParameter(Parameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterBySemantic

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