Difference between revisions of "Extensions.DiagCom.GetParameterValueAsFloat"

From emotive
Jump to navigation Jump to search
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''GetParameterValueAsFloat'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetParameterValueAsFloat | The actual value of the parameter as a [[Float]] | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }}
+
{{ClassificationActivity | GetParameterValueAsFloat | Gets the actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Float|Float]] | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|Parameter related terms]] | [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
FloatTerm = DiagCom.GetParameterValueAsFloat(ParameterTerm);
+
FloatTerm DiagCom.GetParameterValueAsFloat(ParameterTerm parameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetParameterValueAsFloat''' term accepts a [[ParameterTerm]] and returns the actual value of the parameter as a [[Float]].
+
The '''GetParameterValueAsFloat''' term accepts a '''ParameterTerm''' and returns the actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Float|Float]].
  
−
{{TermReturnValue| [[Float]] | The actual value of the parameter as a [[Float]].)}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Float|Float]] | The actual value of the parameter.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Parameter | [[Parameter]] | [[Term]] | - | [1] | The parameter object.}}
+
{{TableRowPropertie2| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The '''Parameter''' whose value will be returned as a Float.}}
 
|}
 
|}
  
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.Request Request1;
+
/// Local Declarations
 +
 
 +
DiagCom.ComChannel ComChannel1;
 +
DiagCom.Result Result1;
 +
DiagCom.Response Response1;
 
DiagCom.Parameter Parameter1;
 
DiagCom.Parameter Parameter1;
−
Float ParameterValueAsFloat;
+
Float Float1;
−
DiagCom.ComChannel ComChannel1;
 
  
−
ComChannel1 = DiagCom.GetComChannel("LL_AccesStartInterUDS", "", false);
+
/// Flow
−
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"));
 
−
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RequeServiId"});
 
  
−
try
+
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false);
−
{
+
[#MetaData(RequestPdu), <#Data>22 02 86</#Data>]
−
  ParameterValueAsFloat = DiagCom.GetParameterValueAsFloat(Parameter1);
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentMeasuValue"), {Param_RecorDataIdent = "Voltage terminal 30"}, {}, Result1, NULL, false, false);
−
}
+
Response1 = DiagCom.GetFirstResponse(Result1, );
−
catch
+
Parameter1 = DiagCom.GetParameterByPath(Response1, {"Param_DataRecor", 0});
−
{
+
Float1 = DiagCom.GetParameterValueAsFloat(Parameter1);
−
}
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetParameterValueAsBoolean]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[GetParameterValueAsString]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
−
[[GetParameterValueAsInteger]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
−
[[GetParameterValueAsByteField]] <br/>
+
[[Extensions.DiagCom.GetRequest|GetRequest]] <br/>
−
[[GetParameterValueAsQuantity]]
+
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
 +
[[Extensions.DiagCom.GetAllResponses|GetAllResponses]] <br/>
 +
[[Extensions.DiagCom.GetParameterBySemantic|GetParameterBySemantic]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagCom.GetParameterAsList|GetParameterAsList]] <br/>
 +
[[Extensions.DiagCom.GetParameterValueAsBoolean|GetParameterValueAsBoolean]] <br/>
 +
[[Extensions.DiagCom.GetParameterValueAsString|GetParameterValueAsString]] <br/>
 +
[[Extensions.DiagCom.GetParameterValueAsInteger|GetParameterValueAsInteger]] <br/>
 +
[[Extensions.DiagCom.GetParameterValueAsByteField|GetParameterValueAsByteField]] <br/>
 +
[[Extensions.DiagCom.GetParameterValueAsQuantity|GetParameterValueAsQuantity]]

Latest revision as of 10:19, 12 September 2019

Classification

Name GetParameterValueAsFloat
Short Description Gets the actual value of the parameter as a Float
Class Term
Extension OTX DiagCom extension
Group Parameter related terms
Exceptions TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

FloatTerm DiagCom.GetParameterValueAsFloat(ParameterTerm parameter);

Description

The GetParameterValueAsFloat term accepts a ParameterTerm and returns the actual value of the parameter as a Float.

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
Float The actual value of the parameter.

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] The Parameter whose value will be returned as a Float.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
DiagCom.Result Result1;
DiagCom.Response Response1;
DiagCom.Parameter Parameter1;
Float Float1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false);
[#MetaData(RequestPdu), <#Data>22 02 86</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentMeasuValue"), {Param_RecorDataIdent = "Voltage terminal 30"}, {}, Result1, NULL, false, false);
Response1 = DiagCom.GetFirstResponse(Result1, );
Parameter1 = DiagCom.GetParameterByPath(Response1, {"Param_DataRecor", 0});
Float1 = DiagCom.GetParameterValueAsFloat(Parameter1);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetRequest
ExecuteDiagService
GetFirstResponse
GetAllResponses
GetParameterBySemantic
GetParameterByPath
GetParameterAsList
GetParameterValueAsBoolean
GetParameterValueAsString
GetParameterValueAsInteger
GetParameterValueAsByteField
GetParameterValueAsQuantity

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagCom.GetParameterValueAsFloat&oldid=9690"