Extensions.DiagDataBrowsing.IsBooleanParameter

From emotive
Jump to navigation Jump to search

Classification

Name IsBooleanParameter
Short Description Checks if the parameter is of type Boolean
Class Term
Extension OTX DiagDataBrowsing extension
Group DiagDataBrowsing terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm DiagDataBrowsing.IsBooleanParameter(ParameterTerm Parameter);

Description

IsBooleanParameter will return TRUE if and only if the given parameter represents a Boolean value according to its definition in the diagnostic data base.

Icons Note.png NOTE — In the case of a MVCI/ODX based system, it returns True whether the value of this parameter is of one of the following MCDDataType: eA_BOOLEAN.

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 exactly then the specified parameter is a Booelan value as defined in the diagnostic database

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] The element addresses the name of the request or response parameter to be type-tested.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
DiagCom.Parameter Parameter1;
DiagCom.Request Request1;
Boolean Boolean1 = false;
List<String> List1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu");
List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1);
Request1 = DiagCom.GetRequest(DiagService1);
Parameter1 = DiagCom.GetParameterByPath(Request1, {List1[0]});
Boolean1 = DiagDataBrowsing.IsBooleanParameter(Parameter1);

See also

IsStringParameter
IsNumericParameter
IsByteFieldParameter
IsComplexParameter