OpenTestSystem.Otx.Extensions.DiagComPlus.Terms.GetComChannelState Class Reference

Gets the current state of the diag:ComChannel. More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.DiagComPlus.Terms.GetComChannelState:

Public Attributes
ComChannelTerm	comChannel
	Cardinality [1] This element shall reference the handle of the communication channel whose status should be returned. 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

Gets the current state of the diag:ComChannel.

The GetComChannelState term returns the current state of the diag:ComChannel. If the state can not be determined, NOT_AVAILABLE shall be returned.

Note: The appropriate MVCI system operation is MCDLogicalLink::getState.

Syntax

ComChannelStateTerm = DiagComPlus.GetComChannelState(ComChannelTerm comChannel);

Examples

// Local Declarations
DiagComPlus.ComChannelState ComChannelState1 = @ComChannelState:COMMUNICATION;
Exception Exception1;
DiagCom.ComChannel ComChannel1;
 
// Flow
ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false);
try
{
    [#DiagMetaData , <#Data>
    <dmd:diagMetaData xmlns:dmd="http://iso.org/OTX/1.0.0/Auxiliaries/DiagMetaData">
      <dmd:comChannelName value="LL_GatewUDS" />
      <dmd:ecuVariantName value="EV_GatewLear_006" />
    </dmd:diagMetaData></#Data>]
    DiagComPlus.StartCommunication(ComChannel1);
    ComChannelState1 = DiagComPlus.GetComChannelState(ComChannel1);
    [#DiagMetaData , <#Data>
    <dmd:diagMetaData xmlns:dmd="http://iso.org/OTX/1.0.0/Auxiliaries/DiagMetaData">
        <dmd:comChannelName value="LL_GatewUDS" />
        <dmd:ecuVariantName value="EV_GatewLear_006" />
    </dmd:diagMetaData></#Data>]
    DiagComPlus.StopCommunication(ComChannel1);
}
catch (DiagCom.LossOfComException Exception1)
{
}

Member Data Documentation

comChannel

ComChannelTerm OpenTestSystem.Otx.Extensions.DiagComPlus.Terms.GetComChannelState.comChannel

Cardinality [1]
This element shall reference the handle of the communication channel whose status should be returned.

Note: In case of an MVCI base system the four statuses are available for a logical link. For other base systems it should be possible to logically map the statuses to the existing ones.