Difference between revisions of "Extensions.DiagCom.GetParameterValueAsBoolean"

From emotive
Jump to navigation Jump to search
Line 3: Line 3:
 
{{ClassificationActivity | GetParameterValueAsBoolean | The actual value of the parameter as a [[Boolean]] | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }}
 
{{ClassificationActivity | GetParameterValueAsBoolean | The actual value of the parameter as a [[Boolean]] | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Boolean GetParameterValueAsBoolean(Parameter parameter);
+
BooleanTerm = DiagCom.GetParameterValueAsBoolean(ParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 19: Line 19:
 
|}
 
|}
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Boolean value = GetParameterValueAsBoolean(parameter);
+
DiagCom.Request Request1;
 +
DiagCom.Parameter Parameter1;
 +
Boolean Boolean1 = false;
 +
DiagCom.ComChannel ComChannel1;
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("LL_Brake1UDS", "EV_Brake1UDSContiMK100IPB_008", false);
 +
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"));
 +
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RequeServiId"});
 +
try
 +
{
 +
  Boolean1 = DiagCom.GetParameterValueAsBoolean(Parameter1);
 +
}
 +
catch
 +
{
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 03:23, 6 February 2015

Classification

Name GetParameterValueAsBoolean
Short Description 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);

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 as a Boolean.)

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] The parameter object.

OTL Examples

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

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

See also

GetParameterValueAsString
GetParameterValueAsInteger
GetParameterValueAsFloat
GetParameterValueAsByteField
GetParameterValueAsQuantity