Difference between revisions of "Extensions.DiagCom.GetParameterValueAsFloat"

From emotive
Jump to navigation Jump to search
Line 3: Line 3:
 
{{ClassificationActivity | GetParameterValueAsFloat | The actual value of the parameter as a [[Float]] | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }}
 
{{ClassificationActivity | GetParameterValueAsFloat | The actual value of the parameter as a [[Float]] | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Float GetParameterValueAsFloat(Parameter parameter);
+
FloatTerm = DiagCom.GetParameterValueAsFloat(ParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 21: Line 21:
 
== Examples ==
 
== Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Float value = GetParameterValueAsFloat(parameter);
+
DiagCom.Request Request1;
 +
DiagCom.Parameter Parameter1;
 +
Float ParameterValueAsFloat;
 +
DiagCom.ComChannel ComChannel1;
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("LL_AccesStartInterUDS", "", false);
 +
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"));
 +
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RequeServiId"});
 +
 
 +
try
 +
{
 +
  ParameterValueAsFloat = DiagCom.GetParameterValueAsFloat(Parameter1);
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 03:42, 6 February 2015

Classification

Name GetParameterValueAsFloat
Short Description 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);

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 as a Float.)

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] The parameter object.

Examples

DiagCom.Request Request1;
DiagCom.Parameter Parameter1;
Float ParameterValueAsFloat;
DiagCom.ComChannel ComChannel1;

ComChannel1 = DiagCom.GetComChannel("LL_AccesStartInterUDS", "", false);
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"));
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RequeServiId"});

try
{
   ParameterValueAsFloat = DiagCom.GetParameterValueAsFloat(Parameter1);
}

See also

GetParameterValueAsBoolean
GetParameterValueAsString
GetParameterValueAsInteger
GetParameterValueAsByteField
GetParameterValueAsQuantity