Difference between revisions of "Extensions.DiagCom.GetComParameterValueAsBoolean"
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;"> | ||
− | + | /// Local Declarations | |
+ | Boolean BooleanVariable = false; | ||
+ | /// Flow | ||
+ | BooleanVariable = DiagCom.GetComParameterValueAsBoolean(ComChannelTerm, StringTerm); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 22: | Line 25: | ||
== 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.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
Exception Handle1; | Exception Handle1; |
Revision as of 12:58, 23 October 2018
Contents
Classification
Name | GetComParameterValueAsBoolean |
Short Description | Gets the current value of a Boolean communication parameter |
Class | Term |
Extension | OTX DiagCom extension |
Group | ComParam related terms |
Exceptions | UnknownTargetException TypeMismatchException |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
/// Local Declarations
Boolean BooleanVariable = false;
/// Flow
BooleanVariable = DiagCom.GetComParameterValueAsBoolean(ComChannelTerm, StringTerm);
Description
The GetComParameterValueAsBoolean term comprises the ChannelAndParameterName attribute group and shall return the current value of a Boolean communication parameter. If the communication parameter has not been previously modified by the SetComParameter action, the default parameter value shall be returned.
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 current value of a Boolean communication parameter. |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
ComChannel | ComChannel | Term | - | [1] | The ComChannelTerm specifies the ComChannel which shall be queried. |
ComParameterName | String | Term | - | [1] | The otx:StringTerm specifies the name of a communication parameter. |
OTL Examples
/// Local Declarations
DiagCom.ComChannel ComChannel1;
Exception Handle1;
Boolean Boolean1 = false;
/// Flow
try
{
ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false);
Boolean1 = DiagCom.GetComParameterValueAsBoolean(ComChannel1, "CP_CanTransmissionTime");
}
catch (TypeMismatchException Handle1)
{
}
See also
GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetComplexComParameter
SetComplexComParameter
GetComParameterValueAsString
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity