Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbDiagServiceSemantic"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbDiagServiceSemantic'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbDiagServiceSemantic | UPDATING... | [...")
 
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbDiagServiceSemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbDiagServiceSemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbDiagServiceSemantic | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbDiagServiceSemantic | Gets the value of the semantic attribute for that [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] out of the ODX file | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbDiagService 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.GetDbDiagServiceSemantic(DbDiagServiceTerm dbDiagService);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbDiagServiceSemantic''' returns the value of the semantic attribute for that [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] out of the ODX file as a [[Core.DataTypes.SimpleDataType.String|string]]. The semantic desribes the diagnosis class the service belongs to. e.g. IO_Control, Read, Write or VariantIdentification.
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|The appropriate MVCI system operation is MCDDbDiagComPrimitive::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.DbDiagService|DbDiagService]] out of the ODX file.}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| DbDiagService | [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] | [[Term]] | - | [1..1] | The element addresses the '''DbDiagService''' whose semantic attribute 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;
+
/// Local Declarations
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
DiagCom.ComChannel ComChannel;
 +
DiagCom.DiagService DiagService;
 +
DiagDataBrowsingPlus.DbDiagService DbDiagService;
 +
String MyString;
 +
 +
/// Flow
  
// Code example using the variable myComChannel
+
ComChannel = DiagCom.GetComChannel("LL_GatewUDS", NULL, false);
// ...
+
DiagService = DiagCom.CreateDiagServiceByName(ComChannel, "DiagnServi_ReadDataByIdentActuaTestStatu");
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
DbDiagService = DiagDataBrowsingPlus.GetDiagServiceDbDiagService(DiagService);
 +
MyString = DiagDataBrowsingPlus.GetDbDiagServiceSemantic(DbDiagService);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
+
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDiagServiceDbDiagService|GetDiagServiceDbDiagService]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbDiagServices|GetDbComChannelDbDiagServices]]

Latest revision as of 09:13, 2 November 2018

Classification

Name GetDbDiagServiceSemantic
Short Description Gets the value of the semantic attribute for that DbDiagService out of the ODX file
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbDiagService related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetDbDiagServiceSemantic(DbDiagServiceTerm dbDiagService);

Description

GetDbDiagServiceSemantic returns the value of the semantic attribute for that DbDiagService out of the ODX file as a string. The semantic desribes the diagnosis class the service belongs to. e.g. IO_Control, Read, Write or VariantIdentification.

Icons Note.png The appropriate MVCI system operation is MCDDbDiagComPrimitive::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 DbDiagService out of the ODX file.

Properties

Name Data Type Class Default Cardinality Description
DbDiagService DbDiagService Term - [1..1] The element addresses the DbDiagService whose semantic attribute shall be returned.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel;
DiagCom.DiagService DiagService;
DiagDataBrowsingPlus.DbDiagService DbDiagService;
String MyString;
		
/// Flow

ComChannel = DiagCom.GetComChannel("LL_GatewUDS", NULL, false);
DiagService = DiagCom.CreateDiagServiceByName(ComChannel, "DiagnServi_ReadDataByIdentActuaTestStatu");
DbDiagService = DiagDataBrowsingPlus.GetDiagServiceDbDiagService(DiagService);
MyString = DiagDataBrowsingPlus.GetDbDiagServiceSemantic(DbDiagService);


See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetDiagServiceDbDiagService
GetComChannelDbComChannel
GetDbComChannel
GetDbComChannelDbDiagServices