Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel"

From emotive
Jump to navigation Jump to search
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:OTX '''GetComChannelDbComChannel'''}}[[DiagDataBrowsingPlus]]
+
{{DISPLAYTITLE:OTX '''GetComChannelDbComChannel'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetComChannelDbComChannel | Gets MCDDbLogicalLink of a MCDLogicalLink| [[Term]] | [[Extensions.DiagDataBrowsingPlus|DiagDataBrowsingPlus]] | [[Extensions.DiagDataBrowsingPlus|DbComChannel related terms]] | NONE | - }}
+
{{ClassificationActivity | GetComChannelDbComChannel | Gets MCDDbLogicalLink of a MCDLogicalLink| [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus Extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbComChannel related terms]] | NONE | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DiagDataBrowsingPlus.GetComChannelDbComChannel(ComChannelTerm);
+
DbComChannelTerm DiagDataBrowsingPlus.GetComChannelDbComChannel(ComChannelTerm comChannel);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
'''GetComChannelDbComChannel''' returns the the data base part (MCDDbLogicalLink) of a diag:ComChannel (MCDLogicalLink).
+
'''GetComChannelDbComChannel''' returns the data base part (MCDDbLogicalLink) of a [[Extensions.DiagCom.ComChannel|diag:ComChannel]] (MCDLogicalLink).
  
{{Note|NOTE — The appropriate MVCI system operation is MCDLogicalLink::getDbObject}}
+
{{Note|The appropriate MVCI system operation is MCDLogicalLink::getDbObject}}
  
{{TermReturnValue| [[Extensions.DiagCom.ComChannel|ComChannel]] | Returns a handle to the [[Extensions.DiagCom.ComChannel|ComChannel]] for a given ECU }}
+
{{TermReturnValue| [[Extensions.DiagDataBrowsingPlus.DbComChannel|DbComChannel]] | Returns the data base part (MCDDbLogicalLink) of a diag:[[Extensions.DiagCom.ComChannel|ComChannel]]}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Identifier | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | String that the Communication Channel identified (Logical Link)}}
+
{{TableRowPropertie2| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1..1] | This element represents the '''diag:ComChannel''' which data base part shall be returned.}}
{{TableRowPropertie2| EcuVariantName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | "" | [0..1] | Optionally you can select "manual" a special version here.}}
 
{{TableRowPropertie1| PerformVariantSelection | [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Term]] | false | [0..1] | Select whether a [[Variant Identification]] is to be performed or not.}}
 
 
|}
 
|}
  
==ECU variant selection==
+
== OTL Examples ==
An [[EcuVariantSelection|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 [[Extensions.DiagCom.IdentifyAndSelectVariant|IdentifyAndSelectVariant]].
+
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
/// Local Declarations
 +
 
 +
DiagDataBrowsingPlus.DbComChannel DbComChannel;
  
{| {{TableHeader}}
+
/// Flow
|- {{TableHeaderRow}}
 
| '''EcuVariantName''' || '''PerformVariantSelection''' ||
 
|- {{TableRow1}}
 
| Empty || False || No ECU variant selection is performed
 
|- {{TableRow2}}
 
| Empty || True || An ECU variant selection is performed for the [[BaseVariant]] descriped in '''Identifier'''
 
|- {{TableRow1}}
 
| 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.
 
|}
 
  
== OTL Examples ==
+
DbComChannel = DiagDataBrowsingPlus.GetComChannelDbComChannel(DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", "", false));
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
DiagCom.ComChannel myComCannel;
 
myComCannel = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", null, false);
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
[[Extensions.DiagCom.GetComChannelIdentifierFromResponse|GetComChannelIdentifierFromResponse]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
[[Extensions.DiagCom.GetComChannelEcuVariantName|GetComChannelEcuVariantName]] <br/>
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
[[Extensions.DiagCom.IsVariant|IsVariant]] <br/>
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelProtocolType|GetDbComChannelProtocolType]]
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]]
 

Latest revision as of 05:49, 25 September 2019

Classification

Name GetComChannelDbComChannel
Short Description Gets MCDDbLogicalLink of a MCDLogicalLink
Class Term
Extension OTX DiagDataBrowsingPlus Extension
Group DbComChannel related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

DbComChannelTerm DiagDataBrowsingPlus.GetComChannelDbComChannel(ComChannelTerm comChannel);

Description

GetComChannelDbComChannel returns the data base part (MCDDbLogicalLink) of a diag:ComChannel (MCDLogicalLink).

Icons Note.png The appropriate MVCI system operation is MCDLogicalLink::getDbObject

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
DbComChannel Returns the data base part (MCDDbLogicalLink) of a diag:ComChannel

Properties

Name Data Type Class Default Cardinality Description
ComChannel ComChannel Term - [1..1] This element represents the diag:ComChannel which data base part shall be returned.

OTL Examples

/// Local Declarations

DiagDataBrowsingPlus.DbComChannel DbComChannel;

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetComChannelDbComChannel(DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", "", false));

See also

GetComChannel
GetDbComChannel
GetDbComChannelProtocolType