Difference between revisions of "Extensions.DiagCom.GetParameterValueAsBoolean"

From emotive
Jump to navigation Jump to search
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 = DiagCom.GetParameterValueAsBoolean(ParameterTerm);
+
/// Local Declarations
 +
Boolean BooleanVariable = false;
 +
/// Flow
 +
BooleanVariable = DiagCom.GetParameterValueAsBoolean(ParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 21: Line 24:
 
== 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.Request Request1;
 
DiagCom.Request Request1;
 
DiagCom.Parameter Parameter1;
 
DiagCom.Parameter Parameter1;

Revision as of 10:50, 23 October 2018

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

/// Local Declarations
Boolean BooleanVariable = false;
/// Flow
BooleanVariable = DiagCom.GetParameterValueAsBoolean(ParameterTerm);

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.

Icons Note.png 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 shall 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