Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameterDisplayUnitAsString"
Jump to navigation
Jump to search
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''GetDbParameterDisplayUnitAsString'''}}[[Category:DiagDataBrowsingPlus]] | {{DISPLAYTITLE:OTX '''GetDbParameterDisplayUnitAsString'''}}[[Category:DiagDataBrowsingPlus]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetDbParameterDisplayUnitAsString| Gets the display unit of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbParameter related terms]] | [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] | - }} | + | {{ClassificationActivity | GetDbParameterDisplayUnitAsString| Gets the display unit of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbParameter 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;"> | ||
| − | StringTerm | + | StringTerm DiagDataBrowsingPlus.GetDbParameterDisplayUnitAsString(DbParameterTerm dbParameter); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''GetDbParameterDisplayUnitAsString''' returns the display unit information of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] as a string. If the parameter is not of [[Core.DataTypes.SimpleDataType|simple Data Type]] or does not contain any unit information an empty [[Core.DataTypes.SimpleDataType.String|string]] is returned. The unit is only available for [[Extensions.DiagCom.Parameter|parameters]] with [[Core.DataTypes.SimpleDataType|simple Data Type]]. | + | '''GetDbParameterDisplayUnitAsString''' returns the display unit information of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] as a [[Core.DataTypes.SimpleDataType.String|string]]. If the parameter is not of [[Core.DataTypes.SimpleDataType|simple Data Type]] or does not contain any unit information an empty [[Core.DataTypes.SimpleDataType.String|string]] is returned. The unit is only available for [[Extensions.DiagCom.Parameter|parameters]] with [[Core.DataTypes.SimpleDataType|simple Data Type]]. |
If the [[Extensions.DiagCom.Parameter|parameter]] is not of [[Core.DataTypes.SimpleDataType|simple Data Type]] A_UINT (8-64), A_INT (8-64), FLOAT (32,64), TEXTTABLE, BITFIELD, ASCIISTRING, UNICODE2STRING or BYTEFIELD, the [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] exception will be thrown. | If the [[Extensions.DiagCom.Parameter|parameter]] is not of [[Core.DataTypes.SimpleDataType|simple Data Type]] A_UINT (8-64), A_INT (8-64), FLOAT (32,64), TEXTTABLE, BITFIELD, ASCIISTRING, UNICODE2STRING or BYTEFIELD, the [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] exception will be thrown. | ||
| − | {{Note| | + | {{Note|The appropriate MVCI system operation is MCDDbParameter::getUnit}} |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the display unit information of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]].}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the display unit information of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]].}} | ||
| Line 20: | Line 20: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| | + | {{TableRowPropertie2| DbParameter | [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | - | [1..1] |The element addresses the '''DbParameter''' (MCDDbParameter) which display unit 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.Result Result; | DiagCom.Result Result; | ||
DiagCom.Response Response; | DiagCom.Response Response; | ||
Latest revision as of 08:58, 2 November 2018
Contents
Classification
| Name | GetDbParameterDisplayUnitAsString |
| Short Description | Gets the display unit of the DbParameter |
| Class | Term |
| Extension | OTX DiagDataBrowsingPlus extension |
| Group | DbParameter related terms |
| Exceptions | InvalidTypeException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
StringTerm DiagDataBrowsingPlus.GetDbParameterDisplayUnitAsString(DbParameterTerm dbParameter);Description
GetDbParameterDisplayUnitAsString returns the display unit information of the DbParameter 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 Type.
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 MCDDbParameter::getUnit
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 DbParameter. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| DbParameter | DbParameter | Term | - | [1..1] | The element addresses the DbParameter (MCDDbParameter) which display unit shall be returned. |
OTL Examples
/// Local Declarations
DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
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"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
MyString = DiagDataBrowsingPlus.GetDbParameterDisplayUnitAsString(DbParameter);See also
GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter
