Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetParameterDisplayUnitAsString"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetParameterDisplayUnitAsString'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetParameterDisplayUnitAsString| UP...")
 
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetParameterDisplayUnitAsString'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetParameterDisplayUnitAsString'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetParameterDisplayUnitAsString| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetParameterDisplayUnitAsString| Gets the display unit 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 ==
−
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.CloseComChannel(ComChannelVariable);
+
StringTerm DiagDataBrowsingPlus.GetParameterDisplayUnitAsString(ParameterTerm parameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetParameterDisplayUnitAsString''' returns the display unit information of the [[Extensions.DiagCom.Parameter|diag:Parameter]] as a [[Core.DataTypes.SimpleDataType.String|string]]. If the [[Extensions.DiagCom.Parameter|parameter]] is not of [[Core.DataTypes.SimpleDataType|simple data type]] or does not contain any unit information an empty string is returned. The unit is only available for parameters with [[Core.DataTypes.SimpleDataType|simple data types]].
−
OTX CloseComChannel activity is used for the [[Diagnosis Runtime System]] to announce that an open communication channel that all relevant resources can be released and closed.
+
 
−
{{ComChannelMemoryUsageNote}}
+
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.
−
{{Important|Please note that the use of a shared '''ComChannel''' can bring the OTX runtime system in an undefined state and that is this case is not validated at design time!}}
+
 
−
-->
+
{{Note|The appropriate MVCI system operation is MCDParameter::getUnit}}
 +
 
 +
{{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.String|String]] | Returns the display unit information of the [[Extensions.DiagCom.Parameter|diag:Parameter]].}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| Parameter|[[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1..1] |The element addresses the '''Parameter'''  (MCDParameter) which display unit shall be returned.}}
 
|}
 
|}
−
-->
 
  
 
== OTL Examples ==
 
== OTL Examples ==
−
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.ComChannel myComCannel;
+
/// Local Declarations
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
DiagCom.Result Result;
 +
DiagCom.Response Response;
 +
DiagCom.Parameter Parameter;
 +
String MyString;
 +
 +
/// Flow
  
−
// Code example using the variable myComChannel
+
[#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);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
Response = DiagCom.GetFirstResponse(Result);
 +
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DataRecor", "Param_StallCurreMeasuValue", "Case_MeasuValue", "Param_Ruhes"});
 +
MyString = DiagDataBrowsingPlus.GetParameterDisplayUnitAsString(Parameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
 +
[[Extensions.DiagCom.GetRequest|GetRequest]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagCom.GetParameterBySemantic|GetParameterBySemantic]] <br/>

Latest revision as of 08:18, 2 November 2018

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.

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

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagDataBrowsingPlus.GetParameterDisplayUnitAsString&oldid=8881"