Extensions.DiagDataBrowsingPlus.GetParameterRadix

From emotive
Jump to navigation Jump to search

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.

Icons Note.png The appropriate MVCI system operation is Operation MCDParameter::getRadix
Icons Note.png 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.

Icons Note.png 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