Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetParameterDecimalPlaces"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetParameterDecimalPlaces'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetParameterDecimalPlaces| UPDATING... |...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetParameterDecimalPlaces'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetParameterDecimalPlaces'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetParameterDecimalPlaces| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetParameterDecimalPlaces| Gets the decimal places of the [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|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);
+
IntegerTerm = DiagDataBrowsingPlus.GetParameterDecimalPlaces(ParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetParameterDecimalPlaces''' returns the number of valid decimal places of the [[Extensions.DiagCom.Parameter|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.
−
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 parameter is not a float value (MCDDataType::FLOAT32 or MCDDataType::FLOAT64), 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|NOTE — The appropriate MVCI system operation is MCDParameter::getDecimalPlaces}}
 +
 
 +
{{Note|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 parameters without using [[Extensions.DiagDataBrowsingPlus.DbParameters|DbParameters]].}}
 +
 
 +
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Integer]] | Returns the number of valid decimal places of the [[Extensions.DiagCom.Parameter|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 decimal places 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;
+
DiagCom.Parameter Parameter;
 +
DiagDataBrowsingPlus.DbParameter DbParameter;
 +
List<DiagDataBrowsingPlus.Interval> List_Interval;
 +
Integer MyInteger;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("AIRBAG", "", false), "DiagnServi_ClearDiagnInforSingle")), {"Dtc"});
−
// ...
+
MyInteger = DiagDataBrowsingPlus.GetParameterDecimalPlaces(Parameter);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</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/>

Revision as of 04:21, 20 September 2018

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);

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

DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
List<DiagDataBrowsingPlus.Interval> List_Interval;
Integer MyInteger;

/// Flow

Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("AIRBAG", "", false), "DiagnServi_ClearDiagnInforSingle")), {"Dtc"});
MyInteger = DiagDataBrowsingPlus.GetParameterDecimalPlaces(Parameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterBySemantic

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