Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameterODXBytePos"

From emotive
Jump to navigation Jump to search
Line 5: Line 5:
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
IntegerTerm= DiagDataBrowsingPlus.GetDbParameterODXBytePos(DbParameterTerm);
+
/// Local Declarations
 +
Integer IntegerVariable;
 +
/// Flow
 +
IntegerVariable = DiagDataBrowsingPlus.GetDbParameterODXBytePos(DbParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 25: Line 28:
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
/// Local Declarations
 +
 
DiagCom.Request Request;
 
DiagCom.Request Request;
 
DiagCom.Parameter Parameter;
 
DiagCom.Parameter Parameter;

Revision as of 07:13, 24 October 2018

Classification

Name GetDbParameterODXBytePos
Short Description Gets the ODX byte position of the DbParameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions InvalidTypeException
Checker Rules -
Standard Compliant Yes

OTL Syntax

/// Local Declarations
Integer IntegerVariable;
/// Flow
IntegerVariable = DiagDataBrowsingPlus.GetDbParameterODXBytePos(DbParameterTerm);

Description

GetDbParameterODXBytePos returns the Byte position, which is available in ODX. The counting starts with 0.

If the byte position is not available, the InvalidTypeException exception will be thrown.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbParameter::getODXBytePos

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 Returns the ODX byte position of the DbParameter.

Properties

Name Data Type Class Default Cardinality Description
dbParameter DbParameter Term - [1..1] The element addresses the DbParameter (MCDDbParameter) which ODX byte position shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Request Request;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
Integer MyInteger;

/// Flow

Request = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "SinglJob_CompoListWrite"));
Parameter = DiagCom.GetParameterByPath(Request, {"IPA_CompoListInput", "Param_CompoListInput"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
MyInteger = DiagDataBrowsingPlus.GetDbParameterODXBytePos(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter