Difference between revisions of "Extensions.DiagCom.GetComParameterValueAsBoolean"

From emotive
Jump to navigation Jump to search
(Created page with "Category:DiagCom == Classification == {{ClassificationActivity | GetComParameterValueAsBoolean | The current value of a Boolean communication parameter | Term | ...")
 
Line 3: Line 3:
 
{{ClassificationActivity | GetComParameterValueAsBoolean | The current value of a [[Boolean]] communication parameter | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[ComParam related terms]] | [[UnknownTargetException]] <br/> [[TypeMismatchException]] | - }}
 
{{ClassificationActivity | GetComParameterValueAsBoolean | The current value of a [[Boolean]] communication parameter | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[ComParam related terms]] | [[UnknownTargetException]] <br/> [[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 GetComParameterValueAsBoolean(ComChannel comChannel, String comParameterName);
+
BooleanTerm = DiagCom.GetComParameterValueAsBoolean(ComChannelTerm, StringTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 20: Line 20:
 
|}
 
|}
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Boolean result = GetComParameterValueAsBoolean(comChannel, "parameterName");
+
DiagCom.ComChannel myComCannel;
 +
DiagCom.DiagService DiagService1;
 +
Boolean Boolean1 = false;
 +
 
 +
myComCannel = DiagCom.GetComChannel("LL_AirbaUDS", null, false);
 +
DiagService1 = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentBasicSettiStatu");
 +
Boolean1 = DiagCom.GetComParameterValueAsBoolean(myComCannel, "CP_CanTransmissionTime");
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 06:51, 6 February 2015

Classification

Name GetComParameterValueAsBoolean
Short Description 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

BooleanTerm = DiagCom.GetComParameterValueAsBoolean(ComChannelTerm, StringTerm);

Description

The GetComParameterValueAsBoolean term return the current value of a Boolean communication parameter.

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 current value of a Boolean communication parameter.

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [1] Communication channel.
ComParameterName String Term - [1] Name of communication channel.

OTL Examples

DiagCom.ComChannel myComCannel;
DiagCom.DiagService DiagService1;
Boolean Boolean1 = false;

myComCannel = DiagCom.GetComChannel("LL_AirbaUDS", null, false);
DiagService1 = DiagCom.CreateDiagServiceByName(myComCannel, "DiagnServi_ReadDataByIdentBasicSettiStatu");
Boolean1 = DiagCom.GetComParameterValueAsBoolean(myComCannel, "CP_CanTransmissionTime");

See also

GetComParameterValueAsString
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity