Difference between revisions of "Extensions.DiagCom.GetComParameterValueAsFloat"

From emotive
Jump to navigation Jump to search
 
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
The '''GetComParameterValueAsFloat''' term comprises the '''ChannelAndParameterName''' attribute group and will return the current value of a [[Core.DataTypes.SimpleDataType.Float|float]] type communication parameter. If the communication parameter has not been previously modified by the [[Extensions.DiagCom.SetComParameter|SetComParameter]] action, the default parameter value will be returned.
+
The '''GetComParameterValueAsFloat''' term will return the current value of a [[Core.DataTypes.SimpleDataType.Float|float]] type communication parameter. If the communication parameter has not been previously modified by the [[Extensions.DiagCom.SetComParameter|SetComParameter]] action, the default parameter value will be returned.
  
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Float|Float]] | The current value of a [[Core.DataTypes.SimpleDataType.Float|Float]] communication parameter.}}
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Float|Float]] | The current value of a [[Core.DataTypes.SimpleDataType.Float|Float]] communication parameter.}}

Latest revision as of 12:23, 24 December 2019

Classification

Name GetComParameterValueAsFloat
Short Description Gets the current value of a Float communication parameter
Class Term
Extension OTX DiagCom extension
Group ComParam related terms
Exceptions UnknownTargetException
TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

FloatTerm DiagCom.GetComParameterValueAsFloat(ComChannelTerm comChannel, StringTerm comParameterName);

Description

The GetComParameterValueAsFloat term will return the current value of a float type communication parameter. If the communication parameter has not been previously modified by the SetComParameter action, the default parameter value will be returned.

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 current value of a Float communication parameter.

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [1] The ComChannelTerm specifies the ComChannel which will be queried.
ComParameterName String Term - [1] The otx:StringTerm specifies the name of a communication parameter.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
Exception Handle1;
Float Float1;

/// Flow

try
{
	ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
	[#MetaData(RequestPdu), <#Data>22 01 00</#Data>]
	DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false);
	Float1 = DiagCom.GetComParameterValueAsFloat(ComChannel1, "CP_TesterPresentTime");
}
catch (TypeMismatchException Handle1)
{			
}

See also

GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetComplexComParameter
SetComplexComParameter
GetComParameterValueAsBoolean
GetComParameterValueAsString
GetComParameterValueAsInteger
GetComParameterValueAsByteField
GetComParameterValueAsQuantity