Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetParameterRadix"
Jump to navigation
Jump to search
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''GetParameterRadix'''}}[[Category:DiagDataBrowsingPlus]] | {{DISPLAYTITLE:OTX '''GetParameterRadix'''}}[[Category:DiagDataBrowsingPlus]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetParameterRadix| Gets the radix of the [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|Parameter related terms]] | [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] | - }} | + | {{ClassificationActivity | GetParameterRadix| Gets the radix of the [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|Parameter related terms]] | [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | IntegerTerm | + | IntegerTerm DiagDataBrowsingPlus.GetParameterRadix(ParameterTerm parameter); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 13: | Line 13: | ||
If the [[Extensions.DiagCom.Parameter|parameter]] is not a A_UINT or A_INT value, the [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] exception will be thrown. | If the [[Extensions.DiagCom.Parameter|parameter]] is not a A_UINT or A_INT value, the [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] exception will be thrown. | ||
| − | {{Note| | + | {{Note|The appropriate MVCI system operation is Operation MCDParameter::getRadix}} |
| − | {{Note| | + | {{Note|This term is introduced to complete the existing terms in the [[Extensions.DiagDataBrowsing|DiagDataBrowsing extension]] (ISO 13209 Part-3 [3]) that uses ParameterTerms. This completion primarily enables a generically interpretation of responses by using runtime [[Extensions.DiagCom.Parameter|parameters]] without using [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameters]].}} |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | Returns the display radix of the [[Extensions.DiagCom.Parameter|parameter]].}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | Returns the display radix of the [[Extensions.DiagCom.Parameter|parameter]].}} | ||
| Line 22: | Line 22: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| | + | {{TableRowPropertie2| Parameter|[[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1..1] |The element addresses the '''Parameter''' (MCDParameter) which radix shall be returned.}} |
|} | |} | ||
== 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.Parameter Parameter; | DiagCom.Parameter Parameter; | ||
Integer MyInteger; | Integer MyInteger; | ||
| Line 34: | Line 34: | ||
/// Flow | /// Flow | ||
| − | + | Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_AllUDSSyste", "", false), "SinglJob_SubsyCodinWrite")), {"IPA_WorksNumbe"}); | |
| − | DiagCom. | ||
| − | |||
| − | |||
MyInteger = DiagDataBrowsingPlus.GetParameterRadix(Parameter); | MyInteger = DiagDataBrowsingPlus.GetParameterRadix(Parameter); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 08:20, 2 November 2018
Contents
Classification
| Name | GetParameterRadix |
| Short Description | Gets the radix of the Parameter |
| Class | Term |
| Extension | OTX DiagDataBrowsingPlus extension |
| Group | Parameter related terms |
| Exceptions | InvalidTypeException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
IntegerTerm DiagDataBrowsingPlus.GetParameterRadix(ParameterTerm parameter);Description
GetParameterRadix returns the display radix of the parameter. The display radix shall be used by the Client to display a numeric parameter value in the format as defined in the data base (2 - ODX value BIN, 10 - ODX value DEC, 16 - ODX value HEX).
If the parameter is not a A_UINT or A_INT value, the InvalidTypeException exception will be thrown.
The appropriate MVCI system operation is Operation MCDParameter::getRadix
This term is introduced to complete the existing terms in the DiagDataBrowsing extension (ISO 13209 Part-3 [3]) that uses ParameterTerms. This completion primarily enables a generically interpretation of responses by using runtime parameters without using DbParameters.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Integer | Returns the display radix of the parameter. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Parameter | Parameter | Term | - | [1..1] | The element addresses the Parameter (MCDParameter) which radix shall be returned. |
OTL Examples
/// Local Declarations
DiagCom.Parameter Parameter;
Integer MyInteger;
/// Flow
Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_AllUDSSyste", "", false), "SinglJob_SubsyCodinWrite")), {"IPA_WorksNumbe"});
MyInteger = DiagDataBrowsingPlus.GetParameterRadix(Parameter);See also
GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterBySemantic
