Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameterSpecialDataGroups"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbParameterSpecialDataGroups'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbParameterSpecialDataGroups | U...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbParameterSpecialDataGroups'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbParameterSpecialDataGroups'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbParameterSpecialDataGroups | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbParameterSpecialDataGroups| Gets the special data groups of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbParameter 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);
+
ListTerm = DiagDataBrowsingPlus.GetDbParameterSpecialDataGroups(DbParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbParameterSpecialDataGroups''' returns the special data groups defined for the corresponding [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] in the project's data bases as a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]]. An empty [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] will be delivered if no SDGs available in the ODX data.
−
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 MCDDbParameter::getDbSDGs}}
−
{{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.ComplexDataType.ContainerDataType.List|List]] | Returns the special data groups defined for the corresponding [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]].}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| dbParameter | [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | - | [1..1] |The element addresses the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] (MCDDbParameter) which SDGs 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.DbParameter DbParameter;
 +
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
[#MetaData(RequestPdu), <#Data>22 2A 19</#Data>]
−
// ...
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "DiagnServi_ReadDataByIdentMeasuValue"), {Param_RecorDataIdent = "stall current measurement value"}, {}, Result, NULL, false, false);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
Response = DiagCom.GetFirstResponse(Result);
 +
Parameter = DiagCom.GetParameterByPath(Response, {"Param_RecorDataIdent"});
 +
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
 +
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbParameterSpecialDataGroups(DbParameter);
 
</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.GetRequest|GetRequest]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetParameterDbParameter|GetParameterDbParameter]]

Revision as of 11:16, 13 September 2018

Classification

Name GetDbParameterSpecialDataGroups
Short Description Gets the special data groups of the DbParameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm = DiagDataBrowsingPlus.GetDbParameterSpecialDataGroups(DbParameterTerm);

Description

GetDbParameterSpecialDataGroups returns the special data groups defined for the corresponding DbParameter in the project's data bases as a list. An empty list will be delivered if no SDGs available in the ODX data.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbParameter::getDbSDGs

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
List Returns the special data groups defined for the corresponding DbParameter.

Properties

Name Data Type Class Default Cardinality Description
dbParameter DbParameter Term - [1..1] The element addresses the DbParameter (MCDDbParameter) which SDGs shall be returned.

OTL Examples

DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
List<DiagDataBrowsingPlus.DbSpecialDataGroup> List_DbSpecialDataGroup;

/// Flow

[#MetaData(RequestPdu), <#Data>22 2A 19</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false), "DiagnServi_ReadDataByIdentMeasuValue"), {Param_RecorDataIdent = "stall current measurement value"}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_RecorDataIdent"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
List_DbSpecialDataGroup = DiagDataBrowsingPlus.GetDbParameterSpecialDataGroups(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter

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