Extensions.DiagCom.GetPdu

From emotive
Jump to navigation Jump to search

Classification

Name GetPdu
Short Description Byte stream of a request or a response
Class Term
Extension OTX DiagCom extension
Group Request related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

ByteFieldTerm DiagCom.GetPdu(MessageTerm message);

Description

The GetPdu term returns the raw byte stream data represented by a Request or a Response as seen on the physical layer. The GetPdu term is derived from ByteFieldTerm. A possible use case for retrieving raw communication data could be to implement bus tracing functionality. The corresponding opposite operation to the GetPdu term is provided by the SetPdu action.

A PDU as understood by the DiagCom extension comprises the complete payload of a message including the service identifier and any other request parameters. It does not include header or checksum bytes from underlying protocol layers.

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
ByteField The raw byte stream data represented by a Request or a Response

Properties

Name Data Type Class Default Cardinality Description
Message Message Term - [1] The Message (e.g. Request or Response) which is to be returned in ByteField form.

OTL Examples

/// Local Declarations

ByteField ByteField1;
DiagCom.Request Request1;
DiagCom.ComChannel ComChannel1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ClearDiagnInfor"));
ByteField1 = DiagCom.GetPdu(Request1);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetRequest