Difference between revisions of "Extensions.DiagDataBrowsingPlus.IsIntegerParameter"

From emotive
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
BooleanTerm = DiagDataBrowsingPlus.IsIntegerParameter(ParameterTerm);
+
BooleanTerm DiagDataBrowsingPlus.IsIntegerParameter(ParameterTerm parameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 11: Line 11:
 
'''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.
 
'''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.
  
{{Note|NOTE — The appropriate MVCI system operation is MCDParameter::getDataType}}
+
{{Note|The appropriate MVCI system operation is MCDParameter::getDataType}}
  
{{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]].}}
+
{{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 [[Extensions.DiagCom.Parameter|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]].}}
 
{{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]].}}
Line 20: Line 20:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{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.}}
+
{{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 ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
/// Local Declarations
 +
 
DiagCom.Parameter Parameter;
 
DiagCom.Parameter Parameter;
 
Boolean MyBoolean;
 
Boolean MyBoolean;

Latest revision as of 08:22, 2 November 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 parameter);

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 The appropriate MVCI system operation is MCDParameter::getDataType
Icons Note.png 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

/// Local Declarations

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