Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbSpecialDataGroupCaption"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbSpecialDataGroupCaption'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbSpecialDataGroupCaption| UPDATING...")
 
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbSpecialDataGroupCaption'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbSpecialDataGroupCaption'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbSpecialDataGroupCaption| UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbSpecialDataGroupCaption| Gets the caption of the [[Extensions.DiagDataBrowsingPlus.DbSpecialDataGroup|DbSpecialDataGroup]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbSpecialDataGroup 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.GetDbSpecialDataGroupCaption(DbSpecialDataGroupTerm specialDataGroup);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbSpecialDataGroupCaption''' returns the shortname of the MCDDbSpecialDataGroupCaption. If there is not caption available, an empty string is 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|The appropriate MVCI system operation is MCDDbSpecialDataGroup::getCaption}}
−
{{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 shortname of the MCDDbSpecialDataGroupCaption.}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| SpecialDataGroup| [[Extensions.DiagDataBrowsingPlus.DbSpecialDataGroup|DbSpecialDataGroup]] | [[Term]] | - | [1..1] |The element addresses the '''DbSpecialDataGroup''' (MCDDbSpecialDataGroup) which caption 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
 +
 
 +
DiagCom.Result Result;
 +
DiagCom.Response Response;
 +
DiagCom.Parameter Parameter;
 +
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;
 +
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;
 +
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);
 +
MyString = DiagDataBrowsingPlus.GetDbSpecialDataGroupCaption(List_DbSpecialDataGroup[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.GetDbResponseDbSpecialDataGroups|GetDbResponseDbSpecialDataGroups]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbRequestDbSpecialDataGroups|GetDbRequestDbSpecialDataGroups]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbDiagTroubleCodeSpecialDataGroups|GetDbDiagTroubleCodeSpecialDataGroups]]

Latest revision as of 08:48, 2 November 2018

Classification

Name GetDbSpecialDataGroupCaption
Short Description Gets the caption of the DbSpecialDataGroup
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbSpecialDataGroup related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetDbSpecialDataGroupCaption(DbSpecialDataGroupTerm specialDataGroup);

Description

GetDbSpecialDataGroupCaption returns the shortname of the MCDDbSpecialDataGroupCaption. If there is not caption available, an empty string is returned.

Icons Note.png The appropriate MVCI system operation is MCDDbSpecialDataGroup::getCaption

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 shortname of the MCDDbSpecialDataGroupCaption.

Properties

Name Data Type Class Default Cardinality Description
SpecialDataGroup DbSpecialDataGroup Term - [1..1] The element addresses the DbSpecialDataGroup (MCDDbSpecialDataGroup) which caption shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbDiagTroubleCode DbDiagTroubleCode;
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;
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);
MyString = DiagDataBrowsingPlus.GetDbSpecialDataGroupCaption(List_DbSpecialDataGroup[0]);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetParameterByPath
GetParameterDbDiagTroubleCode
GetDbDiagServiceDbSpecialDataGroups
GetDbResponseDbSpecialDataGroups
GetDbRequestDbSpecialDataGroups
GetDbDiagTroubleCodeSpecialDataGroups

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