Difference between revisions of "Extensions.DiagCom.GetParameterValueAsBoolean"
Jump to navigation
Jump to search
m (Hb moved page GetParameterValueAsBoolean to Extensions.DiagCom.GetParameterValueAsBoolean: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:DiagCom]] | + | {{DISPLAYTITLE:OTX '''GetParameterValueAsBoolean'''}}[[Category:DiagCom]] |
== Classification == | == Classification == | ||
| − | {{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 [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The '''GetParameterValueAsBoolean''' term accepts a [[ParameterTerm]] and returns the actual value of the parameter as a [[Boolean]] quantity. | + | The '''GetParameterValueAsBoolean''' term accepts a [[ParameterTerm]] and returns the actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] quantity. |
| − | {{TermReturnValue| [[Boolean]] | The actual value of the parameter as a [[Boolean]].)}} | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | The actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Boolean|Boolean]].)}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Parameter | [[Parameter]] | [[Term]] | - | [1] | The parameter object.}} | + | {{TableRowPropertie1| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The parameter object.}} |
|} | |} | ||
| Line 39: | Line 39: | ||
== See also == | == See also == | ||
| − | [[GetParameterValueAsString]] <br/> | + | [[Extensions.DiagCom.GetParameterValueAsString|GetParameterValueAsString]] <br/> |
| − | [[GetParameterValueAsInteger]] <br/> | + | [[Extensions.DiagCom.GetParameterValueAsInteger|GetParameterValueAsInteger]] <br/> |
| − | [[GetParameterValueAsFloat]] <br/> | + | [[Extensions.DiagCom.GetParameterValueAsFloat|GetParameterValueAsFloat]] <br/> |
| − | [[GetParameterValueAsByteField]] <br/> | + | [[Extensions.DiagCom.GetParameterValueAsByteField|GetParameterValueAsByteField]] <br/> |
| − | [[GetParameterValueAsQuantity]] | + | [[Extensions.DiagCom.GetParameterValueAsQuantity|GetParameterValueAsQuantity]] |
Revision as of 02:56, 15 February 2016
Contents
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.
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
