Creates a communication channel More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.ComInterface.Terms.CreateComChannelFromComInterface:

Public Attributes
ComInterfaceTerm	comInterface
	Cardinality [1] This element identifies the communication interface. More...

StringTerm	ecuVariantName
	Cardinality [0..1] This optional element allows an OTX sequence to explicitly specify a particular ECU variant that the ComChannel shall be associated with. More...

StringTerm	identifier
	Cardinality [1] This element represents a string identifying the communication channel, which shall be created. More...

StringTerm	ressource
	Cardinality [0..1] The InterfaceResource as String that shall be used for physical communication. More...

Public Attributes inherited from OpenTestSystem.Otx.Core.Terms.Term
MetaData	metaData
	Cardinality [0..1] The `MetaData` type allows tools to store additional, mainly tool-specific data. More...

Detailed Description

Creates a communication channel

The CreateComChannelFromComInterface term creates a communication channel to an ECU on the specified communication interface. The term is needed, because the comIf:GetComChannelFromInterface term does not guarantee, that the communication is not started.For exchangeability the usage of this term is recommended instead of comIf:GetComChannelFromInterface, if the user wants to set communication parameters before starting communication.

IMPORTANT — The channel is created at the time this term is executed.

IMPORTANT — If the ComChannel already exists, the state of the diag:ComChannel shall not be changed by this term.

IMPORTANT — In case an ODX/MVCI system is used, a StartCommunication on the logical link is not executed.In this case the logical link state is ONLINE.

The term CreateComChannelFromInterface shall always return a handle to the same ComChannel for a given ECU. It is possible to manually control the lifecycle of a ComChannel object by closing a ComChannel handle using the diag:CloseComChannel action. This is up to the author of a diagnostic sequence, an OTX runtime system is expected to clean up open ComChannel handles at the end of a diagnostic session.

Note: The appropriate MVCI system operation is MCDProject::createLogicalLinkByNameAndInterface or MCDProject::createLogicalLinkByVariantAndInterface.; The detailed runtime behaviour is described in DiagManager Runtime Behavior.

Syntax: ComChannelTerm = ComInterface.CreateComChannelFromComInterface(ComInterfaceTerm comInterface, StringTerm identifier, StringTerm ecuVariantName = NULL, StringTerm ressource = NULL);

OpenTestSystem.Otx.Extensions.ComInterface.Terms.CreateComChannelFromComInterface.ecuVariantName
StringTerm ecuVariantName
Cardinality [0..1] This optional element allows an OTX sequence to explicitly specify a particular EC...
Definition: ComInterface.cs:1737

OpenTestSystem.Otx.Extensions.ComInterface.Terms.CreateComChannelFromComInterface.ressource
StringTerm ressource
Cardinality [0..1] The InterfaceResource as String that shall be used for physical communication.
Definition: ComInterface.cs:1760

OpenTestSystem.Otx.Extensions.ComInterface.Terms.CreateComChannelFromComInterface.comInterface
ComInterfaceTerm comInterface
Cardinality [1] This element identifies the communication interface.
Definition: ComInterface.cs:1707

OpenTestSystem.Otx.Extensions.ComInterface.Terms.CreateComChannelFromComInterface.identifier
StringTerm identifier
Cardinality [1] This element represents a string identifying the communication channel,...
Definition: ComInterface.cs:1719

Member Data Documentation

◆ comInterface

ComInterfaceTerm OpenTestSystem.Otx.Extensions.ComInterface.Terms.CreateComChannelFromComInterface.comInterface

Cardinality [1]
This element identifies the communication interface.

◆ ecuVariantName

StringTerm OpenTestSystem.Otx.Extensions.ComInterface.Terms.CreateComChannelFromComInterface.ecuVariantName

Cardinality [0..1]
This optional element allows an OTX sequence to explicitly specify a particular ECU variant that the ComChannel shall be associated with.

It is provided in addition to the identifier attribute based on the assumption that the ComChannel identifier specifies a connection to a base variant of an ECU.

The <ecuVariantName> element can be used to directly create a ComChannel to a specific ECU variant without needing to perform the ECU variant identification step.

Note: In case an MVCI/ODX system is used, the <ecuVariantName> element specifies the SHORTNAME of the MCDDbEcuVariant to be associated with the logical link.

◆ identifier

StringTerm OpenTestSystem.Otx.Extensions.ComInterface.Terms.CreateComChannelFromComInterface.identifier

Cardinality [1]
This element represents a string identifying the communication channel, which shall be created.

Note: In case a MVCI/ODX system is used, the identifier specifies the SHORT-NAME of the MCDLogicalLink to be used for communication.

◆ ressource

StringTerm OpenTestSystem.Otx.Extensions.ComInterface.Terms.CreateComChannelFromComInterface.ressource

Cardinality [0..1]
The InterfaceResource as String that shall be used for physical communication.

Note: The related MVCI system method is MCDProject::createLogicalLinkByNameAndInterfaceResource() if the resource parameter is defined.

MCDProject::createLogicalLinkByVariantAndInterfaceResource() shall be called if the <ecuVariantName> parameter and the Resource parameter are defined.

Default: the standard resource selected by runtime system.