Extensions.DiagCom.GetParameterValueAsBoolean

Classification

Name	GetParameterValueAsBoolean
Short Description	Gets the actual value of the parameter as a Boolean
Class	Term
Extension	OTX DiagCom extension
Group	Parameter related terms
Exceptions	TypeMismatchException
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

BooleanTerm DiagCom.GetParameterValueAsBoolean(ParameterTerm parameter);

Description

The GetParameterValueAsBoolean term accepts a ParameterTerm and returns the actual value of the parameter as a Boolean quantity.

Return Value

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
Boolean	The actual value of the parameter.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Parameter	Parameter	Term	-	[1]	The Parameter whose value will be returned as a Boolean.

OTL Examples

/// Local Declarations

DiagCom.Request Request1;
DiagCom.Parameter Parameter1;
Boolean Boolean1 = false;
DiagCom.ComChannel ComChannel1;
Exception Handle1;

/// Flow

try
{
	ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false);
	Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"));
	Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RequeServiId"});
	Boolean1 = DiagCom.GetParameterValueAsBoolean(Parameter1);
}
catch (Exception Handle1)
{
}

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetRequest
ExecuteDiagService
GetFirstResponse
GetAllResponses
GetParameterBySemantic
GetParameterByPath
GetParameterAsList
GetParameterValueAsString
GetParameterValueAsInteger
GetParameterValueAsFloat
GetParameterValueAsByteField
GetParameterValueAsQuantity