Difference between revisions of "Extensions.DiagDataBrowsing.IsStringParameter"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''IsStringParameter'''}}[[Category:DiagDataBrowsing]] | {{DISPLAYTITLE:OTX '''IsStringParameter'''}}[[Category:DiagDataBrowsing]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | IsStringParameter | Checks if the parameter is of type String | [[Term]] | [[Extensions.DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[DiagDataBrowsing terms]] | - | - }} | + | {{ClassificationActivity | IsStringParameter | Checks if the parameter is of type String | [[Term]] | [[Extensions.DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[Extensions.DiagDataBrowsing#Terms|DiagDataBrowsing terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | '''IsStringParameter''' will return | + | '''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|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.}} | ||
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if exactly then the specified parameter is a String value as defined in the diagnostic database}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if exactly then the specified parameter is a String value as defined in the diagnostic database}} | ||
| Line 16: | Line 18: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The request or response parameter | + | {{TableRowPropertie1| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The element addresses the name of the request or response parameter to be type-tested.}} |
|} | |} | ||
Revision as of 04:55, 26 September 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
BooleanTerm = 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
DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
DiagCom.Parameter Parameter1;
DiagCom.Request Request1;
List<String> List1;
Boolean Boolean1 = false;
ComChannel1 = DiagCom.GetComChannel("LL_AccesStartInterUDS", "", 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
