Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbTableSemantic"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbTableSemantic'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbTableSemantic | UPDATING... | Term | ...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbTableSemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbTableSemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbTableSemantic | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbTableSemantic| Gets the semantic of the [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] | [[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);
+
StringTerm = DiagDataBrowsingPlus.GetDbTableSemantic(DbTableTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbTableSemantic''' returns the value of the semantic attribute attached to the corresponding [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]]. The semantic gives additional information on the tables nature, e.g. SECURITY or IDENTIFICATION. 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 MCDDbTable::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 attached to the corresponding [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]].}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| dbTable|[[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] | [[Term]] | - | [1..1] |The element addresses the '''DbTable''' (MCDDbTable) 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;
 +
List<DiagDataBrowsingPlus.DbTable> List_DbTable;
 +
String MyString;
  
−
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_DbTable = DiagDataBrowsingPlus.GetDbSubComponentDbTables(List_DbSubComponent[0]);
 +
MyString = DiagDataBrowsingPlus.GetDbTableSemantic(List_DbTable[0]);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbTable|GetDbComChannelDbTable]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbTables|GetDbSubComponentDbTables]]

Revision as of 12:58, 19 September 2018

Classification

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

OTL Syntax

StringTerm = DiagDataBrowsingPlus.GetDbTableSemantic(DbTableTerm);

Description

GetDbTableSemantic returns the value of the semantic attribute attached to the corresponding DbTable. The semantic gives additional information on the tables nature, e.g. SECURITY or IDENTIFICATION. If no semantic can be obtained from ODX an empty string will be returned.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbTable::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 attached to the corresponding DbTable.

Properties

Name Data Type Class Default Cardinality Description
dbTable DbTable Term - [1..1] The element addresses the DbTable (MCDDbTable) which semantic shall be returned.

OTL Examples

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

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "AIRBAG");
List_DbSubComponent = DiagDataBrowsingPlus.GetDbComChannelDbSubComponents(DbComChannel);
List_DbTable = DiagDataBrowsingPlus.GetDbSubComponentDbTables(List_DbSubComponent[0]);
MyString = DiagDataBrowsingPlus.GetDbTableSemantic(List_DbTable[0]);

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbTable
GetDbSubComponentDbTables

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