Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbTableDiagComPrimitiveByConnectorSemantic"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbTableDiagComPrimitiveByConnectorSemantic'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbTableDiagComPrim...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbTableDiagComPrimitiveByConnectorSemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbTableDiagComPrimitiveByConnectorSemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbTableDiagComPrimitiveByConnectorSemantic | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbTableDiagComPrimitiveByConnectorSemantic| Gets the [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] of the [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbTable related terms]] | [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] | - }}
  
 
== 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);
+
DbDiagServiceTerm = DiagDataBrowsingPlus.GetDbTableDiagComPrimitiveByConnectorSemantic(DbTableTerm, StringTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbTableDiagComPrimitiveByConnectorSemantic''' returns the [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] which is referenced from the current table by means of a TABLE-DIAG-COM-CONNECTOR of the given semantic. Note that the semantic is unique for all TABLE-DIAG-COM-CONNECTORs referenced by a TABLE in ODX.
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}}
+
If the current table has no TABLE-DIAG-COM-CONNECTOR with the given semantic, the [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] exception will be thrown.
{{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!}}
+
 
-->
+
{{Note|NOTE — The appropriate MVCI system operation is MCDDbTable::getDbDiagComPrimitiveByConnectorSemantic}}
 +
 
 +
{{TermReturnValue| [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] | Returns the [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] which is referenced from the current table by means of a TABLE-DIAG-COM-CONNECTOR of the given semantic.}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie1| dbTable|[[Extensions.DiagDataBrowsingPlus.dbTable|dbTable]] | [[Term]] | - | [1..1] |The element addresses the '''DbTable''' (MCDDbTable) which [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] shall be returned.}}
 +
{{TableRowPropertie2| semantic| [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1..1] |he element addresses the unique semantic attribute.}}
 
|}
 
|}
-->
 
  
 
== 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.DbTable> List_DbTable;
 +
DiagDataBrowsingPlus.DbDiagService DbDiagService;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "AIRBAG");
// ...
+
List_DbTable = DiagDataBrowsingPlus.GetDbComChannelDbTables(DbComChannel);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
DbDiagService = DiagDataBrowsingPlus.GetDbTableDiagComPrimitiveByConnectorSemantic(List_DbTable[0]);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbTables|GetDbComChannelDbTables]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbSubComponents|GetDbComChannelDbSubComponents]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbSubComponentDbTables|GetDbSubComponentDbTables]]

Revision as of 05:38, 19 September 2018

Classification

Name GetDbTableDiagComPrimitiveByConnectorSemantic
Short Description Gets the DbDiagService of the DbTable
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbTable related terms
Exceptions InvalidTypeException
Checker Rules -
Standard Compliant Yes

OTL Syntax

DbDiagServiceTerm = DiagDataBrowsingPlus.GetDbTableDiagComPrimitiveByConnectorSemantic(DbTableTerm, StringTerm);

Description

GetDbTableDiagComPrimitiveByConnectorSemantic returns the DbDiagService which is referenced from the current table by means of a TABLE-DIAG-COM-CONNECTOR of the given semantic. Note that the semantic is unique for all TABLE-DIAG-COM-CONNECTORs referenced by a TABLE in ODX.

If the current table has no TABLE-DIAG-COM-CONNECTOR with the given semantic, the InvalidTypeException exception will be thrown.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbTable::getDbDiagComPrimitiveByConnectorSemantic

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
DbDiagService Returns the DbDiagService which is referenced from the current table by means of a TABLE-DIAG-COM-CONNECTOR of the given semantic.

Properties

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

OTL Examples

DiagDataBrowsingPlus.DbComChannel DbComChannel;
List<DiagDataBrowsingPlus.DbTable> List_DbTable;
DiagDataBrowsingPlus.DbDiagService DbDiagService;

/// Flow

DbComChannel = DiagDataBrowsingPlus.GetDbComChannel(NULL, "AIRBAG");
List_DbTable = DiagDataBrowsingPlus.GetDbComChannelDbTables(DbComChannel);
DbDiagService = DiagDataBrowsingPlus.GetDbTableDiagComPrimitiveByConnectorSemantic(List_DbTable[0]);

See also

GetDbComChannel
GetComChannelDbComChannel
GetDbComChannelDbTables
GetDbComChannelDbSubComponents
GetDbSubComponentDbTables