Extensions.DiagCom.GetComChannel

Classification

Name	GetComChannel
Short Description	Represents a connection to the control unit at runtime
Class	Term
Extension	OTX DiagCom extension
Group	ComChanel related terms
Exceptions	UnknownTargetException LossOfComException
Checker Rules	-
Standard Compliant	Yes

Pseudo-Code Syntax

GetComChannel(String identifier, String ecuVariantName, Boolean performVariantSelection);

Description

GetComChannel is a term to create a new communication channel via the runtime system diagnosis . The communication channel represents a connection to only one control unit (Logical Link).

To create a connection to the control unit, the following rules apply:

• The connection is created when this term is called.
• If a link has already been created, it is used and it is carried out, no further action.
• Even without explicitly creating the connection, the connection will be established automatically when it is needed the first time.

It is possible to manually control the lifecycle of a ComChannel object by closing a ComChannel handle using the CloseComChannel action. The OTX runtime environment will clean up all opened ComChannel handles at the end of a diagnostic session.

An ECU variant selection can be performed, see below.

Return Value

The Term returns the value, see table below.

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

Data Type	Description
ComChannel	Returns a handle to the ComChannel for a given ECU

Properties

Name	Data Type	Class	Default	Cardinality	Description
Identifier	String	Term	-	[1]	String that the Communication Channel identified (Logical Link)
EcuVariantName	String	Term	""	[0..1]	Optionally you can select "manual" a special version here.
PerformVariantSelection	Boolean	Term	false	[0..1]	Select whether a Variant Identification is to be performed or not.

ECU variant selection

An ECU variant selection can be performed after opening the channel and returns a handle to the selected ECU-Variant. The variant identification functionality also exists as a separate action called IdentifyAndSelectVariant.

EcuVariantName	PerformVariantSelection
Empty	False	No ECU variant selection is performed
Empty	True	An ECU variant selection is performed for the BaseVariant descriped in Identifier
NotEmpty	True	An ECU variant selection is performed. The channel is created to point at the desired ECUVariant and variant selection is performed on the link afterwards.

Examples

ComChannel myComCannel = GetComChannel("LL_AirbaUDS", "", false);

See also

GetComChannelIdentifierFromResponse
GetComChannelEcuVariantName
IsVariant
ExecuteDiagService