Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbSubComponentSemantic"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbSubComponentSemantic'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbSubComponentSemantic| UPDATING... |...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbSubComponentSemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbSubComponentSemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbSubComponentSemantic| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbSubComponentSemantic| Gets the semantic 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);
+
StringTerm = DiagDataBrowsingPlus.GetDbSubComponentSemantic(DbSubComponentTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbSubComponentSemantic''' returns the value of the semantic attribute for that [[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]] out of the ODX file as a [[Core.DataTypes.SimpleDataType.String|string]]. If no semantic can be obtained from ODX an empty string will be returned.
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::getSemantic}}
{{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.SimpleDataType.String|String]] | Returns the value of the semantic attribute for that [[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 semantic 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;
 +
String MyString;
  
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>
+
MyString = DiagDataBrowsingPlus.GetDbSubComponentSemantic(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:28, 17 September 2018

Classification

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

OTL Syntax

StringTerm = DiagDataBrowsingPlus.GetDbSubComponentSemantic(DbSubComponentTerm);

Description

GetDbSubComponentSemantic returns the value of the semantic attribute for that DbSubComponent out of the ODX file as a string. If no semantic can be obtained from ODX an empty string will be returned.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbSubComponent::getSemantic

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
String Returns the value of the semantic attribute for that DbSubComponent.

Properties

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

OTL Examples

DiagDataBrowsingPlus.DbComChannel DbComChannel;
List<DiagDataBrowsingPlus.DbSubComponent> List_DbSubComponent;
String MyString;

/// Flow

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

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbSubComponents