Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbEnvDataDescCommonDbEnvDatas"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbEnvDataDescCommonDbEnvDatas'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbEnvDataDescCommonDbEnvDatas |...")
 
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbEnvDataDescCommonDbEnvDatas'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbEnvDataDescCommonDbEnvDatas'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbEnvDataDescCommonDbEnvDatas | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbEnvDataDescCommonDbEnvDatas | Gets the common environment data of the [[Extensions.DiagDataBrowsingPlus.DbEnvDataDesc|DbEnvDataDesc]] | [[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.GetDbEnvDataDescCommonDbEnvDatas(DbEnvDataDescTerm envDataDesc);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbEnvDataDescCommonDbEnvDatas''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] (MCDDbResponseParameters) which has ALLVALUE flag. 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|The appropriate MVCI system operation is MCDDbEnvDataDesc::getCommonDbEnvDatas}}
−
{{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.DbParameter|DbParameter]] which has ALLVALUE flag.}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| EnvDataDesc | [[Extensions.DiagDataBrowsingPlus.DbEnvDataDesc|DbEnvDataDesc]] | [[Term]] | - | [1..1] |The element addresses the '''DbEnvDataDesc''' which common environment data 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;
 +
List<DiagDataBrowsingPlus.DbParameter> List_DbParameter;
  
−
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>
+
List_DbParameter = DiagDataBrowsingPlus.GetDbEnvDataDescCommonDbEnvDatas(List_DbEnvDataDesc[0]);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbEnvDataDescs|GetDbComChannelDbEnvDataDescs]]

Latest revision as of 09:09, 2 November 2018

Classification

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

OTL Syntax

ListTerm DiagDataBrowsingPlus.GetDbEnvDataDescCommonDbEnvDatas(DbEnvDataDescTerm envDataDesc);

Description

GetDbEnvDataDescCommonDbEnvDatas returns a list of DbParameter (MCDDbResponseParameters) which has ALLVALUE flag. If no elements are available in database, then an empty list will be delivered.

Icons Note.png The appropriate MVCI system operation is MCDDbEnvDataDesc::getCommonDbEnvDatas

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 DbParameter which has ALLVALUE flag.

Properties

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

OTL Examples

/// Local Declarations

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

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel("", "LL_CentrElectUDS");
List_DbEnvDataDesc = DiagDataBrowsingPlus.GetDbComChannelDbEnvDataDescs(DbComChannel);
List_DbParameter = DiagDataBrowsingPlus.GetDbEnvDataDescCommonDbEnvDatas(List_DbEnvDataDesc[0]);

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbEnvDataDescs

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