Difference between revisions of "Extensions.DiagCom.GetParameterValueAsBoolean"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''GetParameterValueAsBoolean'''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX '''GetParameterValueAsBoolean'''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetParameterValueAsBoolean | The actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[Core. | + | {{ClassificationActivity | GetParameterValueAsBoolean | The actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|Parameter related terms]] | [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The '''GetParameterValueAsBoolean''' term accepts a | + | The '''GetParameterValueAsBoolean''' term accepts a '''ParameterTerm''' and returns the actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] quantity. |
| − | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | The actual value of the parameter | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | The actual value of the parameter.)}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The | + | {{TableRowPropertie1| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The '''Parameter''' whose value shall be returned as a Boolean.}} |
|} | |} | ||
| Line 25: | Line 25: | ||
Boolean Boolean1 = false; | Boolean Boolean1 = false; | ||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
| + | Exception Handle1; | ||
| + | |||
| + | /// Flow | ||
| − | |||
| − | |||
| − | |||
try | 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 | + | catch (Exception Handle1) |
{ | { | ||
} | } | ||
| Line 39: | Line 42: | ||
== See also == | == See also == | ||
| + | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> | ||
| + | [[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/> | ||
| + | [[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/> | ||
| + | [[Extensions.DiagCom.GetRequest|GetRequest]] <br/> | ||
| + | [[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/> | ||
| + | [[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/> | ||
| + | [[Extensions.DiagCom.GetAllResponses|GetAllResponses]] <br/> | ||
| + | [[Extensions.DiagCom.GetParameterBySemantic|GetParameterBySemantic]] <br/> | ||
| + | [[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/> | ||
| + | [[Extensions.DiagCom.GetParameterAsList|GetParameterAsList]] <br/> | ||
[[Extensions.DiagCom.GetParameterValueAsString|GetParameterValueAsString]] <br/> | [[Extensions.DiagCom.GetParameterValueAsString|GetParameterValueAsString]] <br/> | ||
[[Extensions.DiagCom.GetParameterValueAsInteger|GetParameterValueAsInteger]] <br/> | [[Extensions.DiagCom.GetParameterValueAsInteger|GetParameterValueAsInteger]] <br/> | ||
Revision as of 04:21, 15 October 2018
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.) |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Parameter | Parameter | Term | - | [1] | The Parameter whose value shall be returned as a Boolean. |
OTL Examples
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
