Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbTableParameters"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbSubComponentDbTableParameters'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbSubComponentDbTableParamete...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbSubComponentDbTableParameters'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbSubComponentDbTableParameters'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbSubComponentDbTableParameters| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbSubComponentDbTableParameters| Gets the table parameters of the [[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbTable 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.GetDbSubComponentDbTableParameters(DbSubComponentTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbSubComponentDbTableParameters''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of all [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] (MCDDbTableParameter) 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::getDbTableRowConnectors[n]::getDbTableRow}}
{{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.DbParameter|DbParameter]] (MCDDbTableParameter) 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 table parameters 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<DiagDataBrowsingPlus.DbParameter> List_DbParameter;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "AIRBAG");
// ...
+
List_DbSubComponent = DiagDataBrowsingPlus.GetDbComChannelDbSubComponents(DbComChannel);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
List_DbParameter = DiagDataBrowsingPlus.GetDbSubComponentDbTableParameters(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 13:29, 17 September 2018

Classification

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

OTL Syntax

ListTerm = DiagDataBrowsingPlus.GetDbSubComponentDbTableParameters(DbSubComponentTerm);

Description

GetDbSubComponentDbTableParameters returns a list of all DbParameter (MCDDbTableParameter) 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::getDbTableRowConnectors[n]::getDbTableRow

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 DbParameter (MCDDbTableParameter) for the DbSubComponent.

Properties

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

OTL Examples

DiagDataBrowsingPlus.DbComChannel DbComChannel;
List<DiagDataBrowsingPlus.DbSubComponent> List_DbSubComponent;
List<DiagDataBrowsingPlus.DbParameter> List_DbParameter;

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "AIRBAG");
List_DbSubComponent = DiagDataBrowsingPlus.GetDbComChannelDbSubComponents(DbComChannel);
List_DbParameter = DiagDataBrowsingPlus.GetDbSubComponentDbTableParameters(List_DbSubComponent[0]);

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbSubComponents