Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbComChannelDbEnvDataDescs"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbComChannelDbEnvDataDescs'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbComChannelDbEnvDataDescs | UPDAT...")
 
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbComChannelDbEnvDataDescs'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbComChannelDbEnvDataDescs'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbComChannelDbEnvDataDescs | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbComChannelDbEnvDataDescs | Gets the environment data descriptions of the [[Extensions.DiagDataBrowsingPlus.DbComChannel|DbComChannel]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbEnvDataDesc related terms]] | NONE | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
−
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.CloseComChannel(ComChannelVariable);
+
ListTerm DiagDataBrowsingPlus.GetDbComChannelDbEnvDataDescs(DbComChannelTerm dbComChannel);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbComChannelDbEnvDataDescs''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of all [[Extensions.DiagDataBrowsingPlus.DbEnvDataDesc|DbEnvDataDesc]] (MCDDbEnvDataDesc) referenced by the [[Extensions.DiagDataBrowsingPlus.DbComChannel|DbComChannel]]. The list can be empty.
−
OTX CloseComChannel activity is used for the [[Diagnosis Runtime System]] to announce that an open communication channel that all relevant resources can be released and closed.
+
 
−
{{ComChannelMemoryUsageNote}}
+
{{Note|The appropriate MVCI system operation is MCDDbLogicalLink::getDbLocation::getDbEnvDataDescs}}
−
{{Important|Please note that the use of a shared '''ComChannel''' can bring the OTX runtime system in an undefined state and that is this case is not validated at design time!}}
+
 
−
-->
+
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | Returns a list of all [[Extensions.DiagDataBrowsingPlus.DbEnvDataDesc|DbEnvDataDesc]] referenced by the [[Extensions.DiagDataBrowsingPlus.DbComChannel|DbComChannel]].}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| DbComChannel | [[Extensions.DiagDataBrowsingPlus.DbComChannel|DbComChannel]] | [[Term]] | - | [1..1] |The element addresses the '''DbComChannel''' which environment data descriptions shall be returned.}}
 
|}
 
|}
−
-->
 
  
 
== OTL Examples ==
 
== OTL Examples ==
−
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DiagCom.ComChannel myComCannel;
+
/// Local Declarations
 +
 
 +
DiagDataBrowsingPlus.DbComChannel DbComChannel;
 +
List<DiagDataBrowsingPlus.DbEnvDataDesc> List_DbEnvDataDesc;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
DbComChannel = DiagDataBrowsingPlus.GetDbComChannel("", "LL_CentrElectUDS");
−
// ...
+
List_DbEnvDataDesc = DiagDataBrowsingPlus.GetDbComChannelDbEnvDataDescs(DbComChannel);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]]

Latest revision as of 09:09, 2 November 2018

Classification

Name GetDbComChannelDbEnvDataDescs
Short Description Gets the environment data descriptions of the DbComChannel
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbEnvDataDesc related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm DiagDataBrowsingPlus.GetDbComChannelDbEnvDataDescs(DbComChannelTerm dbComChannel);

Description

GetDbComChannelDbEnvDataDescs returns a list of all DbEnvDataDesc (MCDDbEnvDataDesc) referenced by the DbComChannel. The list can be empty.

Icons Note.png The appropriate MVCI system operation is MCDDbLogicalLink::getDbLocation::getDbEnvDataDescs

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
List Returns a list of all DbEnvDataDesc referenced by the DbComChannel.

Properties

Name Data Type Class Default Cardinality Description
DbComChannel DbComChannel Term - [1..1] The element addresses the DbComChannel which environment data descriptions shall be returned.

OTL Examples

/// Local Declarations

DiagDataBrowsingPlus.DbComChannel DbComChannel;
List<DiagDataBrowsingPlus.DbEnvDataDesc> List_DbEnvDataDesc;

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel("", "LL_CentrElectUDS");
List_DbEnvDataDesc = DiagDataBrowsingPlus.GetDbComChannelDbEnvDataDescs(DbComChannel);

See also

GetDbComChannel

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagDataBrowsingPlus.GetDbComChannelDbEnvDataDescs&oldid=8985"