Difference between revisions of "Extensions.DiagDataBrowsing.IsComplexParameter"
Jump to navigation
Jump to search
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''IsComplexParameter'''}}[[Category:DiagDataBrowsing]] | {{DISPLAYTITLE:OTX '''IsComplexParameter'''}}[[Category:DiagDataBrowsing]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | IsComplexParameter | Checks if the parameter is of complex type | [[Term]] | [[Extensions.DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[DiagDataBrowsing terms]] | - | - }} | + | {{ClassificationActivity | IsComplexParameter | Checks if the parameter is of complex type | [[Term]] | [[Extensions.DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[Extensions.DiagDataBrowsing#Terms|DiagDataBrowsing terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | BooleanTerm | + | BooleanTerm DiagDataBrowsing.IsComplexParameter(ParameterTerm Parameter); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''IsComplexParameter''' will return TRUE if the | + | '''IsComplexParameter''' will return TRUE if and only if the given parameter neither represents a string, Boolean, numeric nor bytefield 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: eEND_OF_PDU, eENVDATA, eENVDATADESC, eFIELD, eMULTIPLEXER, eSTRUCTURE, eTABLE_ROW.}} | ||
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if exactly then the specified parameter is a value of complex type as defined in the diagnostic database}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if exactly then the specified parameter is a value of complex type as defined in the diagnostic database}} | ||
| Line 16: | Line 18: | ||
{| {{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 28: | Line 32: | ||
List<String> List1; | List<String> List1; | ||
| − | 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); | ||
Latest revision as of 05:57, 1 November 2018
Contents
Classification
| Name | IsComplexParameter |
| Short Description | Checks if the parameter is of complex type |
| Class | Term |
| Extension | OTX DiagDataBrowsing extension |
| Group | DiagDataBrowsing terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
BooleanTerm DiagDataBrowsing.IsComplexParameter(ParameterTerm Parameter);Description
IsComplexParameter will return TRUE if and only if the given parameter neither represents a string, Boolean, numeric nor bytefield 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: eEND_OF_PDU, eENVDATA, eENVDATADESC, eFIELD, eMULTIPLEXER, eSTRUCTURE, eTABLE_ROW.
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 value of complex type 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;
Boolean Boolean1 = false;
List<String> List1;
/// 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.IsComplexParameter(Parameter1);See also
IsStringParameter
IsBooleanParameter
IsNumericParameter
IsByteFieldParameter
