Difference between revisions of "Extensions.DiagDataBrowsing.IsByteFieldParameter"
Jump to navigation
Jump to search
(Created page with "Category:DiagDataBrowsing == Classification == {{ClassificationActivity | IsByteFieldParameter | Checks if the parameter is of type ByteField | Term | DiagDataBrowsi...") |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:DiagDataBrowsing]] | + | {{DISPLAYTITLE:OTX '''IsByteFieldParameter'''}}[[Category:DiagDataBrowsing]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | IsByteFieldParameter | Checks if the parameter is of type ByteField | [[Term]] | [[DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[DiagDataBrowsing terms]] | - | - }} | + | {{ClassificationActivity | IsByteFieldParameter | Checks if the parameter is of type ByteField | [[Term]] | [[Extensions.DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[Extensions.DiagDataBrowsing#Terms|DiagDataBrowsing terms]] | - | - }} |
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | BooleanTerm DiagDataBrowsing.IsByteFieldParameter(ParameterTerm Parameter); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''IsByteFieldParameter''' will return TRUE if the | + | '''IsByteFieldParameter''' will return TRUE if and only if the given parameter represents a bytefield value according to its definition in the diagnostic data base. |
| − | {{TermReturnValue| [[ | + | {{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_BITFIELD, eA_BYTEFIELD.}} |
| + | |||
| + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Returns TRUE if exactly then the specified parameter is a ByteField value as defined in the diagnostic database}} | ||
== Properties == | == Properties == | ||
{| {{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.}} |
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Boolean | + | /// 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_AccesStartInterUDS", "", false); | ||
| + | DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"); | ||
| + | List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1); | ||
| + | Request1 = DiagCom.GetRequest(DiagService1); | ||
| + | Parameter1 = DiagCom.GetParameterByPath(Request1, {List1[0]}); | ||
| + | Boolean1 = DiagDataBrowsing.IsByteFieldParameter(Parameter1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[ | + | [[Extensions.DiagDataBrowsing.IsStringParameter|IsStringParameter]] <br/> |
| − | [[ | + | [[Extensions.DiagDataBrowsing.IsBooleanParameter|IsBooleanParameter]] <br/> |
| − | [[IsNumericParameter]] <br/> | + | [[Extensions.DiagDataBrowsing.IsNumericParameter|IsNumericParameter]] <br/> |
| − | [[IsComplexParameter]] | + | [[Extensions.DiagDataBrowsing.IsComplexParameter|IsComplexParameter]] |
Latest revision as of 05:56, 1 November 2018
Contents
Classification
| Name | IsByteFieldParameter |
| Short Description | Checks if the parameter is of type ByteField |
| Class | Term |
| Extension | OTX DiagDataBrowsing extension |
| Group | DiagDataBrowsing terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
BooleanTerm DiagDataBrowsing.IsByteFieldParameter(ParameterTerm Parameter);Description
IsByteFieldParameter will return TRUE if and only if the given parameter represents a 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: eA_BITFIELD, eA_BYTEFIELD.
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 ByteField 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;
Boolean Boolean1 = false;
List<String> List1;
/// Flow
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.IsByteFieldParameter(Parameter1);See also
IsStringParameter
IsBooleanParameter
IsNumericParameter
IsComplexParameter
