Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbEnvDataDescs"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbSubComponentDbEnvDataDescs'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbSubComponentDbEnvDataDescs| UP...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbSubComponentDbEnvDataDescs'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbSubComponentDbEnvDataDescs'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbSubComponentDbEnvDataDescs| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbSubComponentDbEnvDataDescs| Gets the environment data
 +
descriptions of the [[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbSubComponent 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.GetDbSubComponentDbEnvDataDescs(DbSubComponentTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbSubComponentDbEnvDataDescs''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbEnvDataDesc|DbEnvDataDesc]] for the [[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]] which is available in ODX. If no elements are available in database, then an empty list will be delivered.
−
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|NOTE — The appropriate MVCI system operation is MCDDbSubComponent::getDbEnvDataConnectors[n]::getDbEnvDataDesc}}
−
{{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 [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbEnvDataDesc|DbEnvDataDesc]] for the [[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]].}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| subComponent| [[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]] | [[Term]] | - | [1..1] |The element addresses the '''DbSubComponent''' 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;
+
DiagDataBrowsingPlus.DbComChannel DbComChannel;
 +
List<DiagDataBrowsingPlus.DbSubComponent> List_DbSubComponent;
 +
List<DbEnvDataDesc> List_DbEnvDataDesc;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "BCM_HINTEN");
−
// ...
+
List_DbSubComponent = DiagDataBrowsingPlus.GetDbComChannelDbSubComponents(DbComChannel);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
List_DbEnvDataDesc = DiagDataBrowsingPlus.GetDbSubComponentDbEnvDataDescs(List_DbSubComponent[0]);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbSubComponents|GetDbComChannelDbSubComponents]]

Revision as of 11:06, 17 September 2018

Classification

Name GetDbSubComponentDbEnvDataDescs
Short Description Gets the environment data

descriptions of the DbSubComponent

Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbSubComponent related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm = DiagDataBrowsingPlus.GetDbSubComponentDbEnvDataDescs(DbSubComponentTerm);

Description

GetDbSubComponentDbEnvDataDescs returns a list of DbEnvDataDesc for the DbSubComponent which is available in ODX. If no elements are available in database, then an empty list will be delivered.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbSubComponent::getDbEnvDataConnectors[n]::getDbEnvDataDesc

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 DbEnvDataDesc for the DbSubComponent.

Properties

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

OTL Examples

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

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "BCM_HINTEN");
List_DbSubComponent = DiagDataBrowsingPlus.GetDbComChannelDbSubComponents(DbComChannel);
List_DbEnvDataDesc = DiagDataBrowsingPlus.GetDbSubComponentDbEnvDataDescs(List_DbSubComponent[0]);

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbSubComponents

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