Extensions.DiagDataBrowsingPlus.GetParameterDecimalPlaces

From emotive
Jump to navigation Jump to search

Classification

Name GetParameterDecimalPlaces
Short Description Gets the decimal places of the Parameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group Parameter related terms
Exceptions InvalidTypeException
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm DiagDataBrowsingPlus.GetParameterDecimalPlaces(ParameterTerm parameter);

Description

GetParameterDecimalPlaces returns the number of valid decimal places of the parameter. The number of decimal places shall be used by the Client to display only the valid decimal places of a float parameter as defined in the data base. According to ODX, the number of decimal places is defined as the number of valid digits after the decimal point and not as precision of the floating point value.

If the parameter is not a float value (MCDDataType::FLOAT32 or MCDDataType::FLOAT64), the InvalidTypeException exception will be thrown.

Icons Note.png The appropriate MVCI system operation is MCDParameter::getDecimalPlaces
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 number of valid decimal places of the parameter.

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1..1] The element addresses the Parameter (MCDParameter) which decimal places shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
Integer MyInteger;
		
/// Flow

[#MetaData(RequestPdu), <#Data>22 2A 19</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "DiagnServi_ReadDataByIdentMeasuValue"), {Param_RecorDataIdent = "stall current measurement value"}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DataRecor", "Param_StallCurreMeasuValue", "Case_MeasuValue", "Param_Ruhes"});
MyInteger = DiagDataBrowsingPlus.GetParameterDecimalPlaces(Parameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterBySemantic