Extensions.DiagCom.GetComParameterValueAsQuantity

Classification

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

OTL Syntax

QuantityTerm DiagCom.GetComParameterValueAsQuantity(ComChannelTerm comChannel, StringTerm comParameterName);

Description

The GetComParameterValueAsQuantity term will return the current value of a quantity 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.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
Quantity	The current value of a Quantity 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;
Quantities.Quantity Quantity1;

/// 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);
Quantity1 = DiagCom.GetComParameterValueAsQuantity(ComChannel1, "CP_RC21CompletionTimeout");

See also

GetComChannel
CreateDiagServiceByName
ExecuteDiagService
GetComplexComParameter
SetComplexComParameter
GetComParameterValueAsBoolean
GetComParameterValueAsString
GetComParameterValueAsInteger
GetComParameterValueAsFloat
GetComParameterValueAsByteField