Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbSpecialDataElementSemanticInformation"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbSpecialDataElementSemanticInformation'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbSpecialDataElementS...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbSpecialDataElementSemanticInformation'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbSpecialDataElementSemanticInformation'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbSpecialDataElementSemanticInformation | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbSpecialDataElementSemanticInformation| Gets the semantic information of the [[Extensions.DiagDataBrowsingPlus.DbSpecialDataElement|DbSpecialDataElement]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbSpecialDataElement 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.GetDbSpecialDataElementSemanticInformation(DbSpecialDataElementTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbSpecialDataElementSemanticInformation''' returns the Semantic Information (SI) of the [[Extensions.DiagDataBrowsingPlus.DbSpecialDataElement|DbSpecialDataElement]].
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 MCDDbSpecialData::getSemanticInformation}}
{{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 Semantic Information (SI) of the [[Extensions.DiagDataBrowsingPlus.DbSpecialDataElement|DbSpecialDataElement]].}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| specialDataElement| [[Extensions.DiagDataBrowsingPlus.DbSpecialDataElement|DbSpecialDataElement]] | [[Term]] | - | [1..1] |The element addresses the '''DbSpecialDataElement''' (MCDDbSpecialDataElement) which semantic information 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;
+
DiagCom.Result Result;
 +
DiagCom.Response Response;
 +
DiagCom.Parameter Parameter;
 +
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;
 +
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;
 +
List<DiagDataBrowsingPlus.DbSpecialDataElement> List_DbSpecialDataElement;
 +
String MyString;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
[#MetaData(RequestPdu), <#Data>19 02 00</#Data>]
// ...
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDTCInforReporDTCByStatuMask"), {}, {}, Result, NULL, false, false);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
Response = DiagCom.GetFirstResponse(Result);
 +
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DTCAndStatuRecor", "STRUC_DTCAndStatuRecor", "Param_DTCUDS"});
 +
DbDiagTroubleCode = DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode(Parameter);
 +
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbDiagTroubleCodeSpecialDataGroups(DbDiagTroubleCode);
 +
List_DbSpecialDataElement = DiagDataBrowsingPlus.GetDbSpecialDataGroupSpecialDataElements(List_DbSpecialDataGroup[0]);
 +
MyString = DiagDataBrowsingPlus.GetDbSpecialDataElementSemanticInformation(List_DbSpecialDataElement[0]);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode|GetParameterDbDiagTroubleCode]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbDiagServiceDbSpecialDataGroups|GetDbDiagServiceDbSpecialDataGroups]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbDiagTroubleCodeSpecialDataGroups|GetDbDiagTroubleCodeSpecialDataGroups]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbSpecialDataGroupSpecialDataElements|GetDbSpecialDataGroupSpecialDataElements]]

Revision as of 13:08, 14 September 2018

Classification

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

OTL Syntax

StringTerm = DiagDataBrowsingPlus.GetDbSpecialDataElementSemanticInformation(DbSpecialDataElementTerm);

Description

GetDbSpecialDataElementSemanticInformation returns the Semantic Information (SI) of the DbSpecialDataElement.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbSpecialData::getSemanticInformation

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 Semantic Information (SI) of the DbSpecialDataElement.

Properties

Name Data Type Class Default Cardinality Description
specialDataElement DbSpecialDataElement Term - [1..1] The element addresses the DbSpecialDataElement (MCDDbSpecialDataElement) which semantic information shall be returned.

OTL Examples

DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;
List<DiagDataBrowsingPlus.DbSpecialDataElement> List_DbSpecialDataElement;
String MyString;

/// Flow

[#MetaData(RequestPdu), <#Data>19 02 00</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDTCInforReporDTCByStatuMask"), {}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DTCAndStatuRecor", "STRUC_DTCAndStatuRecor", "Param_DTCUDS"});
DbDiagTroubleCode = DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode(Parameter);
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbDiagTroubleCodeSpecialDataGroups(DbDiagTroubleCode);
List_DbSpecialDataElement = DiagDataBrowsingPlus.GetDbSpecialDataGroupSpecialDataElements(List_DbSpecialDataGroup[0]);
MyString = DiagDataBrowsingPlus.GetDbSpecialDataElementSemanticInformation(List_DbSpecialDataElement[0]);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetParameterByPath
GetParameterDbDiagTroubleCode
GetDbDiagServiceDbSpecialDataGroups
GetDbDiagTroubleCodeSpecialDataGroups
GetDbSpecialDataGroupSpecialDataElements