Extensions.DiagDataBrowsingPlus.GetParameterDisplayUnitAsString

Classification

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

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetParameterDisplayUnitAsString(ParameterTerm parameter);

Description

GetParameterDisplayUnitAsString returns the display unit information of the diag:Parameter as a string. If the parameter is not of simple data type or does not contain any unit information an empty string is returned. The unit is only available for parameters with simple data types.

If the parameter is not of simple data type A_UINT (8-64), A_INT (8-64), FLOAT (32,64), TEXTTABLE, BITFIELD, ASCIISTRING, UNICODE2STRING or BYTEFIELD, the InvalidTypeException exception will be thrown.

The appropriate MVCI system operation is MCDParameter::getUnit

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
String	Returns the display unit information of the diag:Parameter.

Properties

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

OTL Examples

/// Local Declarations

DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
String MyString;
		
/// 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"});
MyString = DiagDataBrowsingPlus.GetParameterDisplayUnitAsString(Parameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterBySemantic