Difference between revisions of "Extensions.DiagDataBrowsing.IsStringParameter"
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 = DiagDataBrowsing.IsStringParameter(ParameterTerm); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 18: | Line 21: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The element addresses the name of the request or response parameter to be type-tested.}} |
|} | |} | ||
== 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; | ||
DiagCom.DiagService DiagService1; | DiagCom.DiagService DiagService1; | ||
| Line 30: | Line 35: | ||
Boolean Boolean1 = false; | Boolean Boolean1 = false; | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | /// Flow |
| + | |||
| + | ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false); | ||
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"); | DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"); | ||
List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1); | List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1); | ||
Revision as of 03:23, 24 October 2018
Contents
Classification
| Name | IsStringParameter |
| Short Description | Checks if the parameter is of type String |
| Class | Term |
| Extension | OTX DiagDataBrowsing extension |
| Group | DiagDataBrowsing terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
/// Local Declarations
Boolean BooleanVariable = false;
/// Flow
BooleanVariable = DiagDataBrowsing.IsStringParameter(ParameterTerm);Description
IsStringParameter will return true if and only if the given parameter represents a string value according to its definition in the diagnostic data base.
NOTE — In the case of a MVCI/ODX based system, it returns True whether the value of this parameter is of one of the following MCDDataType: eA_ASCIISTRING, eA_UNICODE2STRING, eKEY, eTEXTTABLE.
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 | Returns TRUE if exactly then the specified parameter is a String value as defined in the diagnostic database |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Parameter | Parameter | Term | - | [1] | The element addresses the name of the request or response parameter to be type-tested. |
OTL Examples
/// Local Declarations
DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
DiagCom.Parameter Parameter1;
DiagCom.Request Request1;
List<String> List1;
Boolean Boolean1 = false;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu");
List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1);
Request1 = DiagCom.GetRequest(DiagService1);
Parameter1 = DiagCom.GetParameterByPath(Request1, {List1[0]});
Boolean1 = DiagDataBrowsing.IsStringParameter(Parameter1);See also
IsNumericParameter
IsBooleanParameter
IsByteFieldParameter
IsComplexParameter
