Difference between revisions of "Extensions.DiagCom.GetDefaultComParameterValueAsFloat"

From emotive
Jump to navigation Jump to search
 
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
The '''GetDefaultComParameterValueAsFloat''' term comprises the '''ChannelAndParameterName''' attribute group and will return the default value of a  [[Core.DataTypes.SimpleDataType.Float|float]] type communication parameter.
+
The '''GetDefaultComParameterValueAsFloat''' term will return the default value of a  [[Core.DataTypes.SimpleDataType.Float|float]] type communication parameter.
  
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Float|Float]] | The default value of a  [[Core.DataTypes.SimpleDataType.Float|Float]] communication parameter.}}
 
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Float|Float]] | The default value of a  [[Core.DataTypes.SimpleDataType.Float|Float]] communication parameter.}}

Latest revision as of 06:13, 26 December 2019

Classification

Name GetDefaultComParameterValueAsFloat
Short Description Gets the default 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.GetDefaultComParameterValueAsFloat(ComChannelTerm comChannel, StringTerm comParameterName);

Description

The GetDefaultComParameterValueAsFloat term will return the default value of a float type communication parameter.

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 default 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);
	Float1 = DiagCom.GetDefaultComParameterValueAsFloat(ComChannel1, "CP_TesterPresentTime");
}
catch (TypeMismatchException Handle1)
{
}

See also

GetComChannel
GetComplexComParameter
SetComplexComParameter
GetDefaultComParameterValueAsBoolean
GetDefaultComParameterValueAsString
GetDefaultComParameterValueAsInteger
GetDefaultComParameterValueAsByteField
GetDefaultComParameterValueAsQuantity