Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbInParams"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbSubComponentDbInParams'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbSubComponentDbInParams| UPDATING.....")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbSubComponentDbInParams'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbSubComponentDbInParams'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbSubComponentDbInParams| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbSubComponentDbInParams| Gets the MCDDbRequestParameters 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);
+
MapTerm = DiagDataBrowsingPlus.GetDbSubComponentDbInParams(DbSubComponentTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbSubComponentDbInParams''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.Map|Map]]<[[Core.DataTypes.SimpleDataType.String|String]], [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]]<[[Extensions.DiagDataBrowsingPlus.DbParameters|DbParameters]]>> which contains all available MCDDbRequestParameter of the [[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]]. The map key is the related DiagService short name, see [[Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbDiagServices|GetDbSubComponentDbDiagServices]]. 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::getDbSubComponentParamConnectors[n]::getDbSubComponentInParams}}
−
{{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.Map|Map]] | Returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.Map|Map]]<[[Core.DataTypes.SimpleDataType.String|String]], [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]]<[[Extensions.DiagDataBrowsingPlus.DbParameters|DbParameters]]>> which contains all available MCDDbRequestParameter of 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 MCDDbRequestParameters 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;
 +
Map<String, List<DbParameter>> Map_DbParameter;
  
−
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>
+
Map_DbParameter = DiagDataBrowsingPlus.GetDbSubComponentDbInParams(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:41, 17 September 2018

Classification

Name GetDbSubComponentDbInParams
Short Description Gets the MCDDbRequestParameters of the DbSubComponent
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbSubComponent related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

MapTerm = DiagDataBrowsingPlus.GetDbSubComponentDbInParams(DbSubComponentTerm);

Description

GetDbSubComponentDbInParams returns a Map<String, List<DbParameters>> which contains all available MCDDbRequestParameter of the DbSubComponent. The map key is the related DiagService short name, see GetDbSubComponentDbDiagServices. 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::getDbSubComponentParamConnectors[n]::getDbSubComponentInParams

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
Map Returns a Map<String, List<DbParameters>> which contains all available MCDDbRequestParameter of the DbSubComponent.

Properties

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

OTL Examples

DiagDataBrowsingPlus.DbComChannel DbComChannel;
List<DiagDataBrowsingPlus.DbSubComponent> List_DbSubComponent;
Map<String, List<DbParameter>> Map_DbParameter;

/// Flow

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

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbSubComponents

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