Extensions.DiagCom.GetComParameterValueAsInteger

From emotive
Jump to navigation Jump to search

Classification

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

OTL Syntax

IntegerTerm DiagCom.GetComParameterValueAsInteger(ComChannelTerm comChannel, StringTerm comParameterName);

Description

The GetComParameterValueAsInteger term will return the current value of an integer 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
Integer The current value of a Integer 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;
Integer Integer1;

/// Flow

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);
Integer1 = DiagCom.GetComParameterValueAsInteger(ComChannel1, "CP_RC21CompletionTimeout");

See also

GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetComplexComParameter
SetComplexComParameter
GetComParameterValueAsBoolean
GetComParameterValueAsString
GetComParameterValueAsFloat
GetComParameterValueAsByteField
GetComParameterValueAsQuantity